Class InvitesAPI

Hierarchy

ServerAPI
- InvitesAPI

Index

Constructors

Properties

Methods

accept answer answerWaitingResponse cancel cancelInvitation cleanPendingWithId decline getCurrentInvitations invite request waitAnserWithId waitAnswerWithInviteId

Constructors

constructor

new InvitesAPI(client: SignalingClient): InvitesAPI
Parameters
- client: SignalingClient
Returns InvitesAPI
Inherited from ServerAPI.constructor
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:6

Properties

`Protected` client

client: SignalingClient

Methods

accept

accept(id: string, from: string): Promise<unknown>
Accept a received invitation to join a room.

Throws
when server returns an error.

Returns
resolved with server response on success.
Parameters
- id: string
  
  invitation request ID.
- from: string
  
  user name who send the invitation.
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/InvitesAPI.ts:63

answer

answer(type: string, id: string, payload: Body): Promise<Record<string, any>>
Send an answer to server with given data.

Throws
if server returns an error
Parameters
- type: string
  
  response type, i.e: 'invitation',...
- id: string
  
  request id
- payload: Body
  
  response data.
Returns Promise<Record<string, any>>
Inherited from ServerAPI.answer
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:48

answerWaitingResponse

answerWaitingResponse(type: string, id: string, payload: Record<string, any>): Promise<Record<string, any>>
Parameters
- type: string
- id: string
- payload: Record<string, any>
Returns Promise<Record<string, any>>
Inherited from ServerAPI.answerWaitingResponse
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:57

cancel

cancel(type: string, id: string, payload: Body): Promise<Record<string, any>>
Cancel a previous request.

Throws
if server returns an error
Parameters
- type: string
  
  response type, i.e: 'invitation',...
- id: string
  
  request id
- payload: Body
Returns Promise<Record<string, any>>
Inherited from ServerAPI.cancel
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:33

cancelInvitation

cancelInvitation(id: string, from: string, error??: number): void
Cancel a previous request.

Throws
when server returns an error.
Parameters
- id: string
  
  received invitation request Id.
- from: string
  
  user name that requested the invitation
- Optional error: number = 487
  
  rejection code to send
Returns void
- Defined in src/wac-proxy/stacks/Janus/signaling/InvitesAPI.ts:49

cleanPendingWithId

cleanPendingWithId(id: string): void
Parameters
- id: string
Returns void
Inherited from ServerAPI.cleanPendingWithId
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:74

decline

decline(id: string, from: string, error??: number): Promise<unknown>
Decline a received/sent invitation to join a room.

Throws
when server returns an error.

Returns
resoponse with server response on success.
Parameters
- id: string
  
  invitation request ID.
- from: string
  
  user name who send the invitation.
- Optional error: number = 603
  
  rejection code to send
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/InvitesAPI.ts:75

getCurrentInvitations

getCurrentInvitations(id: string, from: string): Promise<CurrentInvitationsDto>
Retrieve current invitations.

Throws
when server returns an error.
Parameters
- id: string
  
  request Id.
- from: string
  
  user name that requests the invitations
Returns Promise<CurrentInvitationsDto>
- Defined in src/wac-proxy/stacks/Janus/signaling/InvitesAPI.ts:88

invite

invite(id: string, from: string, username: string, roomId: string, mediatypes: MediaTypes, requestId?: string, context?: {}): Promise<InviteResponse>
Send an invitation to one room to the user with given username.

Throws
when server returns an error.

Returns
resolved with server response on success.
Parameters
- id: string
  
  invitation request ID.
- from: string
  
  the user name that requested the invitation.
- username: string
  
  user name to request invitation.
- roomId: string
  
  room identifier where invited user should join.
- mediatypes: MediaTypes
  
  default mediatypes that invited peer should use.
- Optional requestId: string
  
  the ID of the request that generated this invitation.
- context: {} = {}
  
  context information for agent assignment purposes
Returns Promise<InviteResponse>
- Defined in src/wac-proxy/stacks/Janus/signaling/InvitesAPI.ts:21

request

request(type: string, id: string, body: Body, retry?: number): Promise<Record<string, any>>
Send a request to server with given data.

Throws
if server returns an error

Returns
resolved with server response.
Parameters
- type: string
  
  request type, i.e: 'createRoom', 'invitation',...
- id: string
  
  request id
- body: Body
  
  requested body.
- Optional retry: number
  
  if specified and an id is provided, when an answer is not received for this requested id, message will be send again periodically.
Returns Promise<Record<string, any>>
Inherited from ServerAPI.request
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:18

waitAnserWithId

waitAnserWithId(id: string): Promise<Record<string, any>>
Parameters
- id: string
Returns Promise<Record<string, any>>
Inherited from ServerAPI.waitAnserWithId
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:66

waitAnswerWithInviteId

waitAnswerWithInviteId(id: string): Promise<Record<string, any>>
Parameters
- id: string
Returns Promise<Record<string, any>>
Inherited from ServerAPI.waitAnswerWithInviteId
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:70

Class InvitesAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: SignalingClient

Returns InvitesAPI

Properties

Protected client

Methods

accept

Throws

Returns

Parameters

id: string

from: string

Returns Promise<unknown>

answer

Throws

Parameters

type: string

id: string

payload: Body

Returns Promise<Record<string, any>>

answerWaitingResponse

Parameters

type: string

id: string

payload: Record<string, any>

Returns Promise<Record<string, any>>

cancel

Throws

Parameters

type: string

id: string

payload: Body

Returns Promise<Record<string, any>>

cancelInvitation

Throws

Parameters

id: string

from: string

Optional error: number = 487

Returns void

cleanPendingWithId

Parameters

id: string

Returns void

decline

Throws

Returns

Parameters

id: string

from: string

Optional error: number = 603

Returns Promise<unknown>

getCurrentInvitations

Throws

Parameters

id: string

from: string

Returns Promise<CurrentInvitationsDto>

invite

Throws

Returns

Parameters

id: string

from: string

username: string

roomId: string

mediatypes: MediaTypes

Optional requestId: string

context: {} = {}

Returns Promise<InviteResponse>

request

Throws

`Protected` client

`Optional` error: number = 487

`Optional` error: number = 603

`Optional` requestId: string

`Optional` retry: number