Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoomsClient

Package version

The Rooms service client.

Hierarchy

  • RoomsClient

Index

Constructors

Methods

Constructors

constructor

  • Initializes a new instance of the RoomsClient class.

    Parameters

    • connectionString: string

      Connection string to connect to an Azure Communication Service resource.

    • Optional options: RoomsClientOptions

      Optional. Options to configure the HTTP pipeline.

    Returns RoomsClient

  • Initializes a new instance of the RoomsClient using an Azure KeyCredential

    Parameters

    • endpoint: string

      The url of the Communication Services resource

    • credential: KeyCredential

      An object that is used to authenticate requests to the service. Use the Azure KeyCredential or @azure/identity to create a credential.

    • Optional options: RoomsClientOptions

      Optional. Options to configure the HTTP pipeline.

    Returns RoomsClient

  • Initializes a new instance of the RoomsClient using a TokenCredential

    Parameters

    • endpoint: string

      The url of the Communication Services resource

    • credential: TokenCredential

      An object that is used to authenticate requests to the service. Use the Azure KeyCredential or @azure/identity to create a credential.

    • Optional options: RoomsClientOptions

      Optional. Options to configure the HTTP pipeline.

    Returns RoomsClient

Methods

addParticipants

  • addParticipants(roomId: string, participants: RoomParticipant[], options?: AddParticipantsOptions): Promise<void>

  • Adds Participants to a room asynchronously

    Parameters

    • roomId: string

      ID of the room.

    • participants: RoomParticipant[]
    • Default value options: AddParticipantsOptions = {}

      Operational options.

    Returns Promise<void>

    a list of all the participants in the room.

createRoom

  • Creates a new room asynchronously.

    Parameters

    Returns Promise<Room>

    a RoomModel object with the values of the created room.

deleteRoom

  • Deletes a room by id asynchronously.

    Parameters

    • roomId: string

      ID of the room.

    • Default value options: DeleteRoomOptions = {}

      Operational options.

    Returns Promise<void>

getParticipants

  • Gets the participants of a room asynchronously.

    Parameters

    Returns Promise<RoomParticipant[]>

    a list of all the participants in the room.

getRoom

  • Gets a room by id asynchronously.

    Parameters

    • roomId: string

      ID of the room.

    • Default value options: GetRoomOptions = {}

      Operational options.

    Returns Promise<Room>

    a RoomModel object with the values of the created room.

removeParticipants

  • removeParticipants(roomId: string, participants: CommunicationUserIdentifier[], options?: RemoveParticipantsOptions): Promise<void>

  • Removes Participants from a Room asynchronously.

    Parameters

    • roomId: string

      ID of the room.

    • participants: CommunicationUserIdentifier[]
    • Default value options: RemoveParticipantsOptions = {}

      Operational options.

    Returns Promise<void>

    a list of all the participants in the room.

updateParticipants

  • Updates the Participants in a Room asynchronously.

    Parameters

    • roomId: string

      ID of the room.

    • participants: RoomParticipant[]
    • Default value options: UpdateParticipantsOptions = {}

      Operational options.

    Returns Promise<void>

    a list of all the participants in the room.

updateRoom

  • Updates a room asynchronously.

    Parameters

    • roomId: string

      ID of the room.

    • Default value options: UpdateRoomOptions = {}

      Operational options.

    Returns Promise<Room>

    a RoomModel object with the values of the created room.

Generated using TypeDoc