Home Reference Source

import {Group} from '@quobis/sippojs'

public class | source

Group

This class allows access to the details of each group

Method Summary

Public Methods
public	getId(): string The unique id that identifies the group
public	getName(): string Get the name of a group
public	getParticipants(): ImmutableSet<string> Get a list of id of users that belong to the group
public	getPhonebook(): ImmutableSet<Object> Returns the phonebook associated to this group
public	minusParticipants(participants: ...string): Group Creates a new Group object removing the provided participants
public	plusParticipants(participants: ...string): Group Creates a new Group object adding the provided participants
public	with(args: Object): Group Creates a new Group object with the provided parameter changed

Public Methods

public getId(): string source

The unique id that identifies the group

Return:

public getName(): string source

Get the name of a group

Return:

public getParticipants(): ImmutableSet<string> source

Get a list of id of users that belong to the group

Return:

ImmutableSet<string>

public getPhonebook(): ImmutableSet<Object> source

Returns the phonebook associated to this group

Return:

ImmutableSet<Object>

Return Properties:

Name	Type	Attribute	Description
name	string
address	string

public minusParticipants(participants: ...string): Group source

Creates a new Group object removing the provided participants

Params:

Name	Type	Attribute	Description
participants	...string

Return:

public plusParticipants(participants: ...string): Group source

Creates a new Group object adding the provided participants

Params:

Name	Type	Attribute	Description
participants	...string

Return:

public with(args: Object): Group source

Creates a new Group object with the provided parameter changed

Params:

Name	Type	Attribute	Description
args	Object
args.name	string	optional
args.participants	Iterable<string>	optional

Return: