RoomsImpl | @azure/communication-rooms

Class containing Rooms operations.

Hierarchy

RoomsImpl

Implements

Rooms

Index

Constructors

constructor

Methods

Constructors

constructor

new RoomsImpl(client: RoomsApiClient): RoomsImpl

- Defined in generated/src/operations/rooms.ts:38
Initialize a new instance of the class Rooms class.

Parameters
- client: RoomsApiClient
  
  Reference to the service client
Returns RoomsImpl

Methods

addParticipants

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

Implementation of Rooms.addParticipants
- Defined in generated/src/operations/rooms.ts:129
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>

Implementation of Rooms.createRoom
- Defined in generated/src/operations/rooms.ts:53
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>

Implementation of Rooms.deleteRoom
- Defined in generated/src/operations/rooms.ts:98
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>

Implementation of Rooms.getParticipants
- Defined in generated/src/operations/rooms.ts:113
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>

Implementation of Rooms.getRoom
- Defined in generated/src/operations/rooms.ts:68
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>

Implementation of Rooms.removeParticipants
- Defined in generated/src/operations/rooms.ts:163
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>

Implementation of Rooms.updateParticipants
- Defined in generated/src/operations/rooms.ts:146
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>

Implementation of Rooms.updateRoom
- Defined in generated/src/operations/rooms.ts:83
Update a room with given changes.

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

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: RoomsApiClient

Returns RoomsImpl

Methods

addParticipants

Parameters

roomId: string

addParticipantsRequest: AddParticipantsRequest

Optional options: RoomsAddParticipantsOptionalParams

Returns Promise<RoomsAddParticipantsResponse>

createRoom

Parameters

createRoomRequest: CreateRoomRequest

Optional options: RoomsCreateRoomOptionalParams

Returns Promise<RoomsCreateRoomResponse>

deleteRoom

Parameters

roomId: string

Optional options: RoomsDeleteRoomOptionalParams

Returns Promise<void>

getParticipants

Parameters

roomId: string

Optional options: RoomsGetParticipantsOptionalParams

Returns Promise<RoomsGetParticipantsResponse>

getRoom

Parameters

roomId: string

Optional options: RoomsGetRoomOptionalParams

Returns Promise<RoomsGetRoomResponse>

removeParticipants

Parameters

roomId: string

removeParticipantsRequest: RemoveParticipantsRequest

Optional options: RoomsRemoveParticipantsOptionalParams

Returns Promise<RoomsRemoveParticipantsResponse>

updateParticipants

Parameters

roomId: string

updateParticipantsRequest: UpdateParticipantsRequest

Optional options: RoomsUpdateParticipantsOptionalParams

Returns Promise<RoomsUpdateParticipantsResponse>

updateRoom

Parameters

roomId: string

Optional options: RoomsUpdateRoomOptionalParams

Returns Promise<RoomsUpdateRoomResponse>