Interface Rooms

Package version

Interface representing a Rooms.

Hierarchy

Rooms

Implemented by

RoomsImpl

Index

Methods

Methods

addParticipants

addParticipants(roomId: string, addParticipantsRequest: AddParticipantsRequest, options?: RoomsAddParticipantsOptionalParams): Promise<RoomsAddParticipantsResponse>

- Defined in generated/src/operationsInterfaces/rooms.ts:84
Adds participants to a room. If participants already exist, no change occurs.

Parameters
- roomId: string
  
  Room id to add participants.
- addParticipantsRequest: AddParticipantsRequest
  
  Participants to be added to the room.
- Optional options: RoomsAddParticipantsOptionalParams
  
  The options parameters.
Returns Promise<RoomsAddParticipantsResponse>

createRoom

createRoom(createRoomRequest: CreateRoomRequest, options?: RoomsCreateRoomOptionalParams): Promise<RoomsCreateRoomResponse>

- Defined in generated/src/operationsInterfaces/rooms.ts:38
Creates a new room.

Parameters
- createRoomRequest: CreateRoomRequest
  
  The create room request body.
- Optional options: RoomsCreateRoomOptionalParams
  
  The options parameters.
Returns Promise<RoomsCreateRoomResponse>

deleteRoom

deleteRoom(roomId: string, options?: RoomsDeleteRoomOptionalParams): Promise<void>

- Defined in generated/src/operationsInterfaces/rooms.ts:65
Delete a room.

Parameters
- roomId: string
  
  The id of the room to be deleted
- Optional options: RoomsDeleteRoomOptionalParams
  
  The options parameters.
Returns Promise<void>

getParticipants

getParticipants(roomId: string, options?: RoomsGetParticipantsOptionalParams): Promise<RoomsGetParticipantsResponse>

- Defined in generated/src/operationsInterfaces/rooms.ts:74
Get participants in a room.

Parameters
- roomId: string
  
  The id of the room to get participants from
- Optional options: RoomsGetParticipantsOptionalParams
  
  The options parameters.
Returns Promise<RoomsGetParticipantsResponse>

getRoom

getRoom(roomId: string, options?: RoomsGetRoomOptionalParams): Promise<RoomsGetRoomResponse>

- Defined in generated/src/operationsInterfaces/rooms.ts:47
Retrieves an existing room by id.

Parameters
- roomId: string
  
  The id of the room requested
- Optional options: RoomsGetRoomOptionalParams
  
  The options parameters.
Returns Promise<RoomsGetRoomResponse>

removeParticipants

removeParticipants(roomId: string, removeParticipantsRequest: RemoveParticipantsRequest, options?: RoomsRemoveParticipantsOptionalParams): Promise<RoomsRemoveParticipantsResponse>

- Defined in generated/src/operationsInterfaces/rooms.ts:106
Remove participants from a room.

Parameters
- roomId: string
  
  Room id to remove the participants from.
- removeParticipantsRequest: RemoveParticipantsRequest
  
  Participants in a room to be removed.
- Optional options: RoomsRemoveParticipantsOptionalParams
  
  The options parameters.
Returns Promise<RoomsRemoveParticipantsResponse>

updateParticipants

updateParticipants(roomId: string, updateParticipantsRequest: UpdateParticipantsRequest, options?: RoomsUpdateParticipantsOptionalParams): Promise<RoomsUpdateParticipantsResponse>

- Defined in generated/src/operationsInterfaces/rooms.ts:95
Update participants in a room.

Parameters
- roomId: string
  
  The room id.
- updateParticipantsRequest: UpdateParticipantsRequest
  
  Participants in a room to be updated.
- Optional options: RoomsUpdateParticipantsOptionalParams
  
  The options parameters.
Returns Promise<RoomsUpdateParticipantsResponse>

updateRoom

updateRoom(roomId: string, options?: RoomsUpdateRoomOptionalParams): Promise<RoomsUpdateRoomResponse>

- Defined in generated/src/operationsInterfaces/rooms.ts:56
Update a room with given changes.

Parameters
- roomId: string
  
  The id of the room requested
- Optional options: RoomsUpdateRoomOptionalParams
  
  The options parameters.
Returns Promise<RoomsUpdateRoomResponse>

Generated using TypeDoc