Class CallTransferAPI

Hierarchy (view full)

ServerAPI
- CallTransferAPI

Index

Constructors

Properties

Methods

acceptCallTransfer answer answerWaitingResponse cancel cancelAttendedTransfer cleanPendingWithId createAttendedCallTransfer executeAttendedTransfer request unattendedCallTransfer waitAnserWithId waitAnswerWithInviteId

Constructors

constructor

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

Properties

`Protected` client

client: SignalingClient

Methods

acceptCallTransfer

acceptCallTransfer(id, callTransferID): Promise<unknown>
Accept performing the call transfer
Parameters
- id: string
- callTransferID: string
  call transfer identifier
Returns Promise<unknown>
resolved with server response on success.
- Defined in src/wac-proxy/stacks/Janus/signaling/CallTransferAPI.ts:51

answer

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

answerWaitingResponse

answerWaitingResponse(type, id, payload): 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, id, payload): Promise<Record<string, any>>
Cancel a previous request.
Parameters
- type: string
  response type, i.e: 'invitation',...
- id: string
  request id
- payload: Body
Returns Promise<Record<string, any>>
Throws
if server returns an error
Inherited from ServerAPI.cancel
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:33

cancelAttendedTransfer

cancelAttendedTransfer(id, target, roomId): Promise<AttendedTransferResponseData>
Cancel performing the attended call transfer
Parameters
- id: string
- target: string
  who must be inserted in conference.
- roomId: string
  room identifier where invited user should join.
Returns Promise<AttendedTransferResponseData>
resolved with server response on success.
- Defined in src/wac-proxy/stacks/Janus/signaling/CallTransferAPI.ts:95

cleanPendingWithId

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

createAttendedCallTransfer

createAttendedCallTransfer(id, target, roomId, transferee): Promise<AttendedTransferResponseData>
Try to perform an attended call transfer
Parameters
- id: string
- target: string
  who must be inserted in conference.
- roomId: string
  room identifier where invited user should join.
- transferee: string
  user who will stay in the transferred conference
Returns Promise<AttendedTransferResponseData>
resolved with server response on success.
- Defined in src/wac-proxy/stacks/Janus/signaling/CallTransferAPI.ts:64

executeAttendedTransfer

executeAttendedTransfer(id, target, roomId): Promise<AttendedTransferResponseData>
Accept performing the attended call transfer
Parameters
- id: string
- target: string
  who must be inserted in conference.
- roomId: string
  room identifier where invited user should join.
Returns Promise<AttendedTransferResponseData>
resolved with server response on success.
- Defined in src/wac-proxy/stacks/Janus/signaling/CallTransferAPI.ts:80

request

request(type, id, body, retry?): Promise<Record<string, any>>
Send a request to server with given data.
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>>
resolved with server response.

Throws
if server returns an error
Inherited from ServerAPI.request
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:18

unattendedCallTransfer

unattendedCallTransfer(id, username, roomId, mediatypes): Promise<unknown>
Try to perform an unattended call transfer
Parameters
- id: string
- username: string
  who must be inserted in conference
- roomId: string
  room identifier where invited user should join.
- mediatypes: MediaTypes
  MediaTypes included in the conference.
Returns Promise<unknown>
resolved with server response on success.
- Defined in src/wac-proxy/stacks/Janus/signaling/CallTransferAPI.ts:38

waitAnserWithId

waitAnserWithId(id): 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): 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 CallTransferAPI

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CallTransferAPI

Properties

Protected client

Methods

acceptCallTransfer

Parameters

Returns Promise<unknown>

answer

Parameters

Returns Promise<Record<string, any>>

Throws

answerWaitingResponse

Parameters

Returns Promise<Record<string, any>>

cancel

Parameters

Returns Promise<Record<string, any>>

Throws

cancelAttendedTransfer

Parameters

Returns Promise<AttendedTransferResponseData>

cleanPendingWithId

Parameters

Returns void

createAttendedCallTransfer

Parameters

Returns Promise<AttendedTransferResponseData>

executeAttendedTransfer

Parameters

Returns Promise<AttendedTransferResponseData>

request

Parameters

Returns Promise<Record<string, any>>

Throws

unattendedCallTransfer

Parameters

Returns Promise<unknown>

waitAnserWithId

Parameters

Returns Promise<Record<string, any>>

waitAnswerWithInviteId

Parameters

Returns Promise<Record<string, any>>

Settings

Member Visibility

Theme

On This Page

`Protected` client