Class LocalInvitation

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

No Inherit Doc

Hierarchy

EventEmitter<LocalInvitationEvents>
- LocalInvitation

Index

Constructors

constructor

new LocalInvitation(): LocalInvitation
Returns LocalInvitation

Inherited from EventEmitter< RtmEvents.LocalInvitationEvents >.constructor

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` state

state: LocalInvitationState

State of the outgoing call invitation.

See: LocalInvitationState.

`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
- Defined in node_modules/agora-rtm-sdk/index.d.ts:987

listenerCount

listenerCount<P, T>(this: T, event: P): number
Type Parameters
- P extends keyof LocalInvitationEvents
- T
Parameters
- this: T
- event: P
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/agora-rtm-sdk/index.d.ts:200

listeners

listeners<P, T>(this: T, event: P): Function[]
Type Parameters
- P extends keyof LocalInvitationEvents
- T
Parameters
- this: T
- event: P
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/agora-rtm-sdk/index.d.ts:198

off

off<P, T>(this: T, event: P, listener: ((...args: any[]) => any)): LocalInvitation
Type Parameters
- P extends keyof LocalInvitationEvents
- T
Parameters
- this: T
- event: P
- listener: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns LocalInvitation
Inherited from EventEmitter.off
- Defined in node_modules/agora-rtm-sdk/index.d.ts:191

on

on<EventName>(eventName: EventName, listener: ((...args: ListenerType<LocalInvitationEvents[EventName]>) => any)): LocalInvitation
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 extends keyof LocalInvitationEvents
Parameters
- eventName: EventName
  
  The name of the channel event. See the property names in the RtmChannelEvents for the list of events.
- listener: ((...args: ListenerType<LocalInvitationEvents[EventName]>) => any)
  
  The callback function of the channel event.
  - - (...args: ListenerType<LocalInvitationEvents[EventName]>): any
    - Parameters
      
      Rest ...args: ListenerType<LocalInvitationEvents[EventName]>
      
      Returns any
Returns LocalInvitation
Overrides EventEmitter.on
- Defined in node_modules/agora-rtm-sdk/index.d.ts:998

once

once<P, T>(this: T, event: P, listener: ((...args: ListenerType<LocalInvitationEvents[P]>) => void)): LocalInvitation
Type Parameters
- P extends keyof LocalInvitationEvents
- T
Parameters
- this: T
- event: P
- listener: ((...args: ListenerType<LocalInvitationEvents[P]>) => void)
  - - (...args: ListenerType<LocalInvitationEvents[P]>): void
    - Parameters
      
      Rest ...args: ListenerType<LocalInvitationEvents[P]>
      
      Returns void
Returns LocalInvitation
Inherited from EventEmitter.once
- Defined in node_modules/agora-rtm-sdk/index.d.ts:185

rawListeners

rawListeners<P, T>(this: T, event: P): Function[]
Type Parameters
- P extends keyof LocalInvitationEvents
- T
Parameters
- this: T
- event: P
Returns Function[]
Inherited from EventEmitter.rawListeners
- Defined in node_modules/agora-rtm-sdk/index.d.ts:199

removeAllListeners

removeAllListeners<P, T>(this: T, event?: P): LocalInvitation
Type Parameters
- P extends keyof LocalInvitationEvents
- T
Parameters
- this: T
- Optional event: P
Returns LocalInvitation
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/agora-rtm-sdk/index.d.ts:197

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
- Defined in node_modules/agora-rtm-sdk/index.d.ts:979

Class LocalInvitation

No Inherit Doc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns LocalInvitation

Properties

Readonly calleeId

channelId

Note

content

Note

Readonly response

Readonly state

Static defaultMaxListeners

Methods

cancel

Returns void

listenerCount

Type Parameters

P extends keyof LocalInvitationEvents

T

Parameters

this: T

event: P

Returns number

listeners

Type Parameters

P extends keyof LocalInvitationEvents

T

Parameters

this: T

event: P

Returns Function[]

off

Type Parameters

P extends keyof LocalInvitationEvents

T

Parameters

this: T

event: P

listener: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns LocalInvitation

on

Type Parameters

EventName extends keyof LocalInvitationEvents

Parameters

eventName: EventName

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

Parameters

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

Returns any

Returns LocalInvitation

once

Type Parameters

P extends keyof LocalInvitationEvents

T

Parameters

this: T

event: P

listener: ((...args: ListenerType<LocalInvitationEvents[P]>) => void)

Parameters

Rest ...args: ListenerType<LocalInvitationEvents[P]>

Returns void

Returns LocalInvitation

rawListeners

Type Parameters

P extends keyof LocalInvitationEvents

T

Parameters

this: T

event: P

Returns Function[]

`Readonly` calleeId

`Readonly` response

`Readonly` state

`Static` defaultMaxListeners

`Rest` ...args: any[]

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

`Rest` ...args: ListenerType<LocalInvitationEvents[P]>

`Optional` event: P