Home Reference Source 
import {GroupContact} from '@quobis/sippojs'
public class | source

GroupContact

Extends:

src/eventemitter.js~EventEmitter → GroupContact

Represents a group contact. This class must not be directly instantiated. Instead, instances of this class are obtained by calling the ContactManager#createGroupContact or ContactManager#getContacts methods of {ContactManager}

Events

  • update is emitted every time the contact is updated.
  • delete is emitted when the contact is deleted.

Member Summary

Public Members
public get
public set

Whether the contact is favorite
public get

Contact unique identifier
public get

Name associated with this contact
public set

Display name associated with this contact
public get

Source name of the contact's source
public set

Update the participants
public get

Source name of the contact's source

Method Summary

Public Methods
public

Removes the contact
public

toJSON(): {"id": *, "name": *, "source": *, "favorite": *, "participants": *}

Returns a JS object with the JSON serialization representation of this object

Public Members

public get favorite: * source

public set favorite: boolean source

Whether the contact is favorite

public get id: string source

Contact unique identifier

public get name: string source

Name associated with this contact

public set name: string source

Display name associated with this contact

public get participants: string source

Source name of the contact's source

public set participants: boolean source

Update the participants

public get source: string source

Source name of the contact's source

Public Methods

public remove(): Promise<undefined, Error> source

Removes the contact

Return:

Promise<undefined, Error>

public toJSON(): {"id": *, "name": *, "source": *, "favorite": *, "participants": *} source

Returns a JS object with the JSON serialization representation of this object

Return:

{"id": *, "name": *, "source": *, "favorite": *, "participants": *}