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

GroupManager

This class allows manager the groups. To obtain an instance of the class @link {Session#getGroupManager} method must be used.

Events

  • groups - Emitted every time a group list changes.

Member Summary

Public Members
public

emitter: EventEmitter

Method Summary

Public Methods
public

async createGroup(name: string, participants: string[]): Promise<Group>

Creates a new group

public

async deleteGroup(group: Group): Promise

Deletes a group

public

Allows access to the list of groups

public

getPhonebook(group: *): Array

this method was deprecated.

Obtain phonebooks asociated with a group.

public

async saveGroup(group: Group): Promise

this method is experimental.

Saves a group (Still no WAC support)

Public Members

public emitter: EventEmitter source

Public Methods

public async createGroup(name: string, participants: string[]): Promise<Group> source

Creates a new group

Params:

NameTypeAttributeDescription
name string

The name of the new group

participants string[]

List of the addresses of the initial participants

Return:

Promise<Group>

public async deleteGroup(group: Group): Promise source

Deletes a group

Params:

NameTypeAttributeDescription
group Group

The group to be deleted

Return:

Promise

public getGroups(): ImmutableList<Group> source

Allows access to the list of groups

Return:

ImmutableList<Group>

public getPhonebook(group: *): Array source

this method was deprecated.

Obtain phonebooks asociated with a group. Phonebooks are a list of contacts many groups can susbscribe to.

Params:

NameTypeAttributeDescription
group *

Return:

Array

containing the phonebooks asociated to the group

Return Properties:

NameTypeAttributeDescription
subscribers string[]

ids of the group subscribers

name string

phonebookName

id string

phonebookId

contacts Object[]

list of ponebook contacts

contacts.name string

contact name

contacts.address string

contact address

public async saveGroup(group: Group): Promise source

this method is experimental.

Saves a group (Still no WAC support)

Params:

NameTypeAttributeDescription
group Group

The group to be persisted

Return:

Promise