Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-rooms

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AddParticipantsOptions

AddParticipantsOptions: OperationOptions

Options to add participants to a room.

DeleteRoomOptions

DeleteRoomOptions: OperationOptions

Options to delete a room.

GetParticipantsOptions

GetParticipantsOptions: OperationOptions

Options to get the participants of a room.

GetRoomOptions

GetRoomOptions: OperationOptions

Options to get a room.

RemoveParticipantsOptions

RemoveParticipantsOptions: OperationOptions

Options to remove participants from a room.

Role

Role: "Presenter" | "Attendee" | "Consumer"

Defines values for RoleType.

RoleType

RoleType: "Presenter" | "Attendee" | "Consumer"

Defines values for RoleType.

RoomJoinPolicy

RoomJoinPolicy: "InviteOnly" | "CommunicationServiceUsers"

Defines values for RoomJoinPolicy.

RoomsAddParticipantsResponse

RoomsAddParticipantsResponse: ParticipantsCollection

Contains response data for the addParticipants operation.

RoomsCreateRoomResponse

RoomsCreateRoomResponse: RoomModel

Contains response data for the createRoom operation.

RoomsGetParticipantsResponse

RoomsGetParticipantsResponse: ParticipantsCollection

Contains response data for the getParticipants operation.

RoomsGetRoomResponse

RoomsGetRoomResponse: RoomModel

Contains response data for the getRoom operation.

RoomsRemoveParticipantsResponse

RoomsRemoveParticipantsResponse: ParticipantsCollection

Contains response data for the removeParticipants operation.

RoomsUpdateParticipantsResponse

RoomsUpdateParticipantsResponse: ParticipantsCollection

Contains response data for the updateParticipants operation.

RoomsUpdateRoomResponse

RoomsUpdateRoomResponse: RoomModel

Contains response data for the updateRoom operation.

UpdateParticipantsOptions

UpdateParticipantsOptions: OperationOptions

Options to update the participants of a room.

Variables

Const logger

logger: any = createClientLogger("communication-rooms")

The @azure/logger configuration for this package.

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Functions

Const mapCommunicationIdentifierToRoomParticipantRestModel

  • mapCommunicationIdentifierToRoomParticipantRestModel(communicationIdentifier: CommunicationUserIdentifier): RoomParticipant

  • Mapping CommunicationUserIdentifier to room participant REST model.

    Parameters

    • communicationIdentifier: CommunicationUserIdentifier

    Returns RoomParticipant

throwException

  • throwException(errorMessage: string): never

Object literals

Const AddParticipantsRequest

AddParticipantsRequest: object

type

type: object

className

className: string = "AddParticipantsRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

participants

participants: object

required

required: boolean = true

serializedName

serializedName: string = "participants"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RoomParticipant"

name

name: string = "Composite"

Const CommunicationError

CommunicationError: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

innerError

innerError: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const CommunicationErrorResponse

CommunicationErrorResponse: object

type

type: object

className

className: string = "CommunicationErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

Const CommunicationIdentifierModel

CommunicationIdentifierModel: object

type

type: object

className

className: string = "CommunicationIdentifierModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

communicationUser

communicationUser: object

serializedName

serializedName: string = "communicationUser"

type

type: object

className

className: string = "CommunicationUserIdentifierModel"

name

name: string = "Composite"

rawId

rawId: object

serializedName

serializedName: string = "rawId"

type

type: object

name

name: string = "String"

Const CommunicationUserIdentifierModel

CommunicationUserIdentifierModel: object

type

type: object

className

className: string = "CommunicationUserIdentifierModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const CreateRoomRequest

CreateRoomRequest: object

type

type: object

className

className: string = "CreateRoomRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

participants

participants: object

serializedName

serializedName: string = "participants"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RoomParticipant"

name

name: string = "Composite"

roomJoinPolicy

roomJoinPolicy: object

serializedName

serializedName: string = "roomJoinPolicy"

type

type: object

allowedValues

allowedValues: Object = ["InviteOnly", "CommunicationServiceUsers"]

name

name: string = "Enum"

validFrom

validFrom: object

serializedName

serializedName: string = "validFrom"

type

type: object

name

name: string = "DateTime"

validUntil

validUntil: object

serializedName

serializedName: string = "validUntil"

type

type: object

name

name: string = "DateTime"

Const ParticipantsCollection

ParticipantsCollection: object

type

type: object

className

className: string = "ParticipantsCollection"

name

name: string = "Composite"

modelProperties

modelProperties: object

participants

participants: object

required

required: boolean = true

serializedName

serializedName: string = "participants"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RoomParticipant"

name

name: string = "Composite"

Const RemoveParticipantsRequest

RemoveParticipantsRequest: object

type

type: object

className

className: string = "RemoveParticipantsRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

participants

participants: object

required

required: boolean = true

serializedName

serializedName: string = "participants"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RoomParticipant"

name

name: string = "Composite"

Const RoomModel

RoomModel: object

type

type: object

className

className: string = "RoomModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

participants

participants: object

required

required: boolean = true

serializedName

serializedName: string = "participants"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RoomParticipant"

name

name: string = "Composite"

roomJoinPolicy

roomJoinPolicy: object

required

required: boolean = true

serializedName

serializedName: string = "roomJoinPolicy"

type

type: object

allowedValues

allowedValues: Object = ["InviteOnly", "CommunicationServiceUsers"]

name

name: string = "Enum"

validFrom

validFrom: object

required

required: boolean = true

serializedName

serializedName: string = "validFrom"

type

type: object

name

name: string = "DateTime"

validUntil

validUntil: object

required

required: boolean = true

serializedName

serializedName: string = "validUntil"

type

type: object

name

name: string = "DateTime"

Const RoomParticipant

RoomParticipant: object

type

type: object

className

className: string = "RoomParticipant"

name

name: string = "Composite"

modelProperties

modelProperties: object

communicationIdentifier

communicationIdentifier: object

serializedName

serializedName: string = "communicationIdentifier"

type

type: object

className

className: string = "CommunicationIdentifierModel"

name

name: string = "Composite"

role

role: object

serializedName

serializedName: string = "role"

type

type: object

allowedValues

allowedValues: Object = ["Presenter", "Attendee", "Consumer"]

name

name: string = "Enum"

Const RoomsAddParticipantsExceptionHeaders

RoomsAddParticipantsExceptionHeaders: object

type

type: object

className

className: string = "RoomsAddParticipantsExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const RoomsCreateRoomExceptionHeaders

RoomsCreateRoomExceptionHeaders: object

type

type: object

className

className: string = "RoomsCreateRoomExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const RoomsDeleteRoomExceptionHeaders

RoomsDeleteRoomExceptionHeaders: object

type

type: object

className

className: string = "RoomsDeleteRoomExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const RoomsGetParticipantsExceptionHeaders

RoomsGetParticipantsExceptionHeaders: object

type

type: object

className

className: string = "RoomsGetParticipantsExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const RoomsGetRoomExceptionHeaders

RoomsGetRoomExceptionHeaders: object

type

type: object

className

className: string = "RoomsGetRoomExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const RoomsRemoveParticipantsExceptionHeaders

RoomsRemoveParticipantsExceptionHeaders: object

type

type: object

className

className: string = "RoomsRemoveParticipantsExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const RoomsUpdateParticipantsExceptionHeaders

RoomsUpdateParticipantsExceptionHeaders: object

type

type: object

className

className: string = "RoomsUpdateParticipantsExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const RoomsUpdateRoomExceptionHeaders

RoomsUpdateRoomExceptionHeaders: object

type

type: object

className

className: string = "RoomsUpdateRoomExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const UpdateParticipantsRequest

UpdateParticipantsRequest: object

type

type: object

className

className: string = "UpdateParticipantsRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

participants

participants: object

required

required: boolean = true

serializedName

serializedName: string = "participants"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RoomParticipant"

name

name: string = "Composite"

Const UpdateRoomRequest

UpdateRoomRequest: object

type

type: object

className

className: string = "UpdateRoomRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

participants

participants: object

serializedName

serializedName: string = "participants"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RoomParticipant"

name

name: string = "Composite"

roomJoinPolicy

roomJoinPolicy: object

serializedName

serializedName: string = "roomJoinPolicy"

type

type: object

allowedValues

allowedValues: Object = ["InviteOnly", "CommunicationServiceUsers"]

name

name: string = "Enum"

validFrom

validFrom: object

serializedName

serializedName: string = "validFrom"

type

type: object

name

name: string = "DateTime"

validUntil

validUntil: object

serializedName

serializedName: string = "validUntil"

type

type: object

name

name: string = "DateTime"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const addParticipantsOperationSpec

addParticipantsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/rooms/{roomId}/participants:add"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.addParticipantsRequest

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.roomId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ParticipantsCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.RoomsAddParticipantsExceptionHeaders

Const addParticipantsRequest

addParticipantsRequest: object

mapper

mapper: any = AddParticipantsRequestMapper

parameterPath

parameterPath: string = "addParticipantsRequest"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2022-02-01"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const contentType

contentType: object

parameterPath

parameterPath: Object = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const createRoomOperationSpec

createRoomOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType,Parameters.accept,Parameters.repeatabilityRequestID,Parameters.repeatabilityFirstSent]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/rooms"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.createRoomRequest

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

201

201: object

bodyMapper

bodyMapper: any = Mappers.RoomModel

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.RoomsCreateRoomExceptionHeaders

Const createRoomRequest

createRoomRequest: object

mapper

mapper: any = CreateRoomRequestMapper

parameterPath

parameterPath: string = "createRoomRequest"

Const deleteRoomOperationSpec

deleteRoomOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/rooms/{roomId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.roomId]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.RoomsDeleteRoomExceptionHeaders

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const getParticipantsOperationSpec

getParticipantsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/rooms/{roomId}/participants"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.roomId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ParticipantsCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.RoomsGetParticipantsExceptionHeaders

Const getRoomOperationSpec

getRoomOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/rooms/{roomId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.roomId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RoomModel

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.RoomsGetRoomExceptionHeaders

Const patchRoomRequest

patchRoomRequest: object

mapper

mapper: any = UpdateRoomRequestMapper

parameterPath

parameterPath: Object = ["options", "patchRoomRequest"]

Const removeParticipantsOperationSpec

removeParticipantsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/rooms/{roomId}/participants:remove"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.removeParticipantsRequest

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.roomId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ParticipantsCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.RoomsRemoveParticipantsExceptionHeaders

Const removeParticipantsRequest

removeParticipantsRequest: object

mapper

mapper: any = RemoveParticipantsRequestMapper

parameterPath

parameterPath: string = "removeParticipantsRequest"

Const repeatabilityFirstSent

repeatabilityFirstSent: object

parameterPath

parameterPath: Object = ["options", "repeatabilityFirstSent"]

mapper

mapper: object

serializedName

serializedName: string = "Repeatability-First-Sent"

type

type: object

name

name: string = "DateTime"

Const repeatabilityRequestID

repeatabilityRequestID: object

parameterPath

parameterPath: Object = ["options", "repeatabilityRequestID"]

mapper

mapper: object

serializedName

serializedName: string = "Repeatability-Request-ID"

type

type: object

name

name: string = "Uuid"

Const roomId

roomId: object

parameterPath

parameterPath: string = "roomId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "roomId"

type

type: object

name

name: string = "String"

Const updateParticipantsOperationSpec

updateParticipantsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/rooms/{roomId}/participants:update"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.updateParticipantsRequest

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.roomId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ParticipantsCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.RoomsUpdateParticipantsExceptionHeaders

Const updateParticipantsRequest

updateParticipantsRequest: object

mapper

mapper: any = UpdateParticipantsRequestMapper

parameterPath

parameterPath: string = "updateParticipantsRequest"

Const updateRoomOperationSpec

updateRoomOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/rooms/{roomId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.patchRoomRequest

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.roomId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RoomModel

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.RoomsUpdateRoomExceptionHeaders

Generated using TypeDoc