@auvious/rtc / ISession
Interface: ISession
Object received by [[newSession]] on incoming or outgoing calls
Table of contents
Properties
Methods
Properties
direction
• Readonly direction: string
Will be "incoming" or "outgoing"
eventHandlers
• eventHandlers: ISessionEventHandlers
id
• id: string
the call ID
remoteEndpoint
• Readonly remoteEndpoint: IEndpoint<{ [key: string]: any; }>
Methods
answer
▸ answer(options?): void
Parameters
| Name | Type |
|---|---|
options? | IAnswerOptions |
Returns
void
hold
▸ hold(): Promise<void>
Returns
Promise<void>
isEstablished
▸ isEstablished(): boolean
Returns
boolean
isInProgress
▸ isInProgress(): boolean
Returns
boolean
isOnHold
▸ isOnHold(): IHoldInfo
Returns
on
▸ on(eventId, handler): any
Parameters
| Name | Type |
|---|---|
eventId | string |
handler | (event?: any) => void |
Returns
any
terminate
▸ terminate(reason?): void
Multiple uses depending on call status - hangup, reject, cancel
Parameters
| Name | Type |
|---|---|
reason? | string |
Returns
void
unhold
▸ unhold(): Promise<void>
Returns
Promise<void>