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

MeetingManager

Extends:

src/eventemitter.js~EventEmitter → MeetingManager

ContactManager instance is obtained by calling the Session#getMeetingManager method of Session and must not be directly instantiated. Once the MeetingManager instance is obtained MeetingManager#init method must be called to initialize it.

Events

  • create is emitted every time a new meeting is created.
    • Meeting meeting The meeting that has just been created.
  • delete is emitted when some meeting is deleted.
    • Meeting meeting The meeting that has just been deleted.

Example:

Get meeting list
meetingManager.init().then(function() {
  meetingManager.getMeetings().forEach(function(meeting) {
    console.log(meeting.name);
  });
});

Member Summary

Public Members
public set

message(value: String)

Set the message to send in a SMS

Method Summary

Public Methods
public

createMeeting(name: string, participants: Object[], validSince: number, sendSmsViaWac: boolean): Promise<Meeting>

Creates a meeting

public

getMeetings(): Array<Meetings>

Retrieves a list with the available meetings

public

Initializes the meeting manager

public

Uninitializes the meeting manager

public

updateMeeting(id: String, name: String, participants: Array, validSince: Object, sendSmsViaWac: boolean): *

Update a meeting

Public Members

public set message(value: String) source

Set the message to send in a SMS

Public Methods

public createMeeting(name: string, participants: Object[], validSince: number, sendSmsViaWac: boolean): Promise<Meeting> source

Creates a meeting

Params:

NameTypeAttributeDescription
name string

The name of the meeting.

participants Object[]

The participants of the new meeting session.

validSince number

The timestamp of the moment when the meeting starts.

sendSmsViaWac boolean
  • optional
  • default: false

If true, an invitation for the meeting will be sent in an SMS by the server.

Return:

Promise<Meeting>

The just created meeting

public getMeetings(): Array<Meetings> source

Retrieves a list with the available meetings

Return:

Array<Meetings>

public init(query: Object): Promise<ContactManager, Error> source

Initializes the meeting manager

Params:

NameTypeAttributeDescription
query Object

Object used for filtering the meetings

Return:

Promise<ContactManager, Error>

A promise that returns when fulfilled the contact manager instance

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

Uninitializes the meeting manager

Return:

Promise<undefined, Error>

A promise that is fulfilled when unitialization finishes

public updateMeeting(id: String, name: String, participants: Array, validSince: Object, sendSmsViaWac: boolean): * source

Update a meeting

Params:

NameTypeAttributeDescription
id String

Meeting id

name String

Name of the meeting updated

participants Array

Array with the participants of the meeting updated

validSince Object

Updated date formatted string

sendSmsViaWac boolean

Flag used to decided

Return:

*