Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocalInvitation

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

Hierarchy

Index

Properties

Methods

Properties

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.

response

response: string

The callee's response to the call invitation.

readonly

state

state: LocalInvitationState

State of the outgoing call invitation.

See: LocalInvitationState.

readonly

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

on

  • on<EventName>(eventName: EventName, listener: function): this

  • Adds the listener function to the channel for the event named eventName. See the EventEmitter API documentation for other event methods on the RtmChannel instance.

    Type parameters

    • EventName: keyof LocalInvitationEvents

    Parameters

    • eventName: EventName

      The name of the channel event. See the property names in the RtmChannelEvents for the list of events.

    • listener: function

      The callback function of the channel event.

        • (...args: ListenerType<LocalInvitationEvents[EventName]>): any

        • Parameters

          • Rest ...args: ListenerType<LocalInvitationEvents[EventName]>

          Returns any

    Returns this

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