Options
All
  • Public
  • Public/Protected
  • All
Menu

The call invitation object created by the SDK and called by the callee.

noinheritdoc

Hierarchy

Index

Constructors

constructor

  • Returns RemoteInvitation

Properties

Readonly callerId

callerId: string

uid of the caller.

readonly

Readonly channelId

channelId: string

Allows the callee to get the channel ID.

readonly

Readonly content

content: string

The call invitation content set by the caller.

readonly
note

The maximum length is 8 KB.

response

response: string

Response to the incoming call invitation.

note

The maximum length is 8 KB.

Readonly state

States of the incoming call invitation. See: RemoteInvitationState .

readonly

Static defaultMaxListeners

defaultMaxListeners: number

Methods

accept

  • accept(): void
  • Allows the callee to accept an incoming call invitation. This method has no asynchronous callbacks. To listen for RemoteInvitationState changes, register the event handler in RemoteInvitationEvents via the on method.

    Returns void

listenerCount

  • listenerCount<P, T>(event: P): number
  • Type parameters

    Parameters

    • event: P

    Returns number

listeners

  • listeners<P, T>(event: P): Function[]
  • Type parameters

    Parameters

    • event: P

    Returns Function[]

off

  • Type parameters

    Parameters

    • event: P
    • listener: (...args: any[]) => any
        • (...args: any[]): any
        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns RemoteInvitation

on

once

rawListeners

  • rawListeners<P, T>(event: P): Function[]
  • Type parameters

    Parameters

    • event: P

    Returns Function[]

refuse

  • refuse(): void
  • Allows the callee to decline an incoming call invitation. This method has no asynchronous callbacks. To listen for RemoteInvitationState changes, register the event handler in RemoteInvitationEvents via the on method.

    Returns void

removeAllListeners

  • Type parameters

    Parameters

    • Optional event: P

    Returns RemoteInvitation

Generated using TypeDoc