Class ConferenceInvite

This class allows access to the details of incoming Conference invitation. This class must not be directly instantiated. Instead, instances of this class are obtained by calling the getInvite

Hierarchy

ConferenceInvite

Index

Properties

context from fromDetails id mediaTypes

Methods

getCallerInfo getContext getFrom getId getMediaTypes

Properties

`Private` context

context: object

`Private` from

from: string

`Private` fromDetails

fromDetails: InviteFromDetails

`Private` id

id: string

`Private` mediaTypes

mediaTypes: MediaTypes

Methods

getCallerInfo

getCallerInfo(): InviteFromDetails
Provides the resolved information of the caller. It returns contactName, displayName and username. If it doesn't exist, it can return the empty field.

Returns InviteFromDetails
- Defined in src/conferences/ConferenceInvite.ts:71

getContext

getContext(): object
Obtains the context for this conference invite. The context is created by the user placing the invite and it will usually contain extra information about the caller

Returns object
- Defined in src/conferences/ConferenceInvite.ts:63

getFrom

getFrom(): string
Obtains the "gateway" of the caller. This can be a user's gateway or pstn number.

Returns string
- Defined in src/conferences/ConferenceInvite.ts:46

getId

getId(): string
Obtains the ID of the incoming invitation

Returns string
- Defined in src/conferences/ConferenceInvite.ts:39

getMediaTypes

getMediaTypes(): MediaTypes
Obtains the mediaTypes for this conference invite. This allow us to guess if we are invited with audio & video, or only with audio and video

Returns MediaTypes
- Defined in src/conferences/ConferenceInvite.ts:54

Generated using TypeDoc