import {Invitation} from '@quobis/sippojs'

public class | source

Invitation

This class allows access to the details of each outgoing invitation in a Conference

Method Summary

Public Methods
public	getMediaTypes(): MediaTypes Obtains the mediaTypes for this invitation.
public	getResponseCode(): number Returns The response code of the invitation.
public	getTimestamp(): number Returns the timestamp when this invitation object was created.
public	getTo(): string Obtains the "gateway username" of the invited user.
public	getToUser(): Object Obtains the User object representing the WAC user of the invited user If we are not inviting a wac user, this will be empty.
public	hasStreams(): boolean Returns true when the conference room has a stream associated to the invited user.
public	isActive(): boolean Utility method that returns true when the invitation does not has a response code and it it not cancelled.
public	isAutoAccepted(): boolean Returns true when the invitation is marked as "auto accepted".
public	isCanceled(): boolean Returns true when the user has cancelled this invitation.

Public Methods

public getMediaTypes(): MediaTypes source

Obtains the mediaTypes for this invitation. This allow us to guess if we are inviting the user with audio & video, or only with audio and video

Return:

MediaTypes

public getResponseCode(): number source

Returns The response code of the invitation. This will be a 200 (OK) when the invited user accepts the invitation.

Return:

number

public getTimestamp(): number source

Returns the timestamp when this invitation object was created. This is useful to keep the client showing the invitations with errors for a period of time.

Return:

number

public getTo(): string source

Obtains the "gateway username" of the invited user.

Return:

string

public getToUser(): Object source

Obtains the User object representing the WAC user of the invited user If we are not inviting a wac user, this will be empty.

Return:

Object

public hasStreams(): boolean source

Returns true when the conference room has a stream associated to the invited user.

Return:

boolean

public isActive(): boolean source

Utility method that returns true when the invitation does not has a response code and it it not cancelled.

Return:

boolean

public isAutoAccepted(): boolean source

Returns true when the invitation is marked as "auto accepted". The "auto accepted" invitations are sent after accepting an invitation request and they are going to be accepted automatically by the invited user.

Return:

boolean

public isCanceled(): boolean source

Returns true when the user has cancelled this invitation.

Return:

boolean