Options
All
  • Public
  • Public/Protected
  • All
Menu

The call invitation object created by calling the createLocalInvitation method, and called only by the caller.

noinheritdoc

Hierarchy

Index

Constructors

constructor

  • Returns LocalInvitation

Properties

Readonly calleeId

calleeId: string

uid of the callee.

channelId

channelId: string

The channel ID set by the caller.

note

To intercommunicate with the legacy Agora Signaling SDK, you MUST set the channel ID. However, even if the callee successfully accepts the call invitation, the Agora RTM SDK does not join the channel of the specified channel ID.

content

content: string

Call invitation content set by the caller.

note

The maximum length is 8 KB.

Readonly response

response: string

The callee's response to the call invitation.

readonly

Readonly state

State of the outgoing call invitation.

readonly

Static defaultMaxListeners

defaultMaxListeners: number

Methods

cancel

  • cancel(): void
  • Allows the caller to cancel a sent call invitation. This method has no asynchronous callbacks. To listen for LocalInvitationState changes, register the event handler in LocalInvitationEvents 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 LocalInvitation

on

once

rawListeners

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

    Parameters

    • event: P

    Returns Function[]

removeAllListeners

  • Type parameters

    Parameters

    • Optional event: P

    Returns LocalInvitation

send

  • send(): void
  • Send a call invitation to a specified remote user (callee). This method has no asynchronous callbacks. To listen for LocalInvitationState changes, register the event handler in LocalInvitationEvents via the on method.

    Returns void

Generated using TypeDoc