Type aliases
AddParticipantsOptions
AddParticipantsOptions: OperationOptions
ChatCreateChatThreadResponse
ChatGetChatThreadResponse
Chat
GetChatThreadResponse: ChatThread & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatThread } }
ChatListChatThreadsNextResponse
ChatListChatThreadsResponse
ChatMessageType
ChatMessageType: string
ChatThreadAddChatParticipantsResponse
ChatThreadGetChatMessageResponse
Chat
ThreadGetChatMessageResponse: ChatMessage & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatMessage } }
ChatThreadListChatMessagesNextResponse
ChatThreadListChatMessagesResponse
ChatThreadListChatParticipantsNextResponse
ChatThreadListChatParticipantsResponse
ChatThreadListChatReadReceiptsNextResponse
ChatThreadListChatReadReceiptsResponse
ChatThreadSendChatMessageResponse
CommunicationCloudEnvironmentModel
CommunicationCloudEnvironmentModel: string
CreateChatThreadOptions
CreateChatThreadOptions: RestCreateChatThreadOptions
DeleteChatThreadOptions
DeleteChatThreadOptions: OperationOptions
DeleteMessageOptions
DeleteMessageOptions: OperationOptions
GetChatThreadOptions
GetChatThreadOptions: OperationOptions
GetMessageOptions
GetMessageOptions: OperationOptions
ListChatThreadsOptions
ListChatThreadsOptions: RestListChatThreadsOptions
ListMessagesOptions
ListMessagesOptions: RestListMessagesOptions
ListParticipantsOptions
ListParticipantsOptions: RestListParticipantsOptions
ListReadReceiptsOptions
ListReadReceiptsOptions: RestListReadReceiptsOptions
RemoveParticipantOptions
RemoveParticipantOptions: OperationOptions
SendReadReceiptOptions
SendReadReceiptOptions: OperationOptions
SendTypingNotificationOptions
SendTypingNotificationOptions: OperationOptions
Object literals
Const AddChatParticipantsErrors
AddChatParticipantsErrors: object
type
type: object
className
className: string = "AddChatParticipantsErrors"
name
name: string = "Composite"
modelProperties
modelProperties: object
invalidParticipants
invalidParticipants: object
required
required: boolean = true
serializedName
serializedName: string = "invalidParticipants"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "CommunicationError"
name
name: string = "Composite"
Const AddChatParticipantsRequest
AddChatParticipantsRequest: object
type
type: object
className
className: string = "AddChatParticipantsRequest"
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 = "ChatParticipant"
name
name: string = "Composite"
Const AddChatParticipantsResult
AddChatParticipantsResult: object
type
type: object
className
className: string = "AddChatParticipantsResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
errors
errors: object
serializedName
serializedName: string = "errors"
type
type: object
className
className: string = "AddChatParticipantsErrors"
name
name: string = "Composite"
Const ChatMessage
ChatMessage: object
type
type: object
className
className: string = "ChatMessage"
name
name: string = "Composite"
modelProperties
modelProperties: object
content
content: object
serializedName
serializedName: string = "content"
type
type: object
className
className: string = "ChatMessageContent"
name
name: string = "Composite"
createdOn
createdOn: object
required
required: boolean = true
serializedName
serializedName: string = "createdOn"
type
type: object
name
name: string = "DateTime"
deletedOn
deletedOn: object
serializedName
serializedName: string = "deletedOn"
type
type: object
name
name: string = "DateTime"
editedOn
editedOn: object
serializedName
serializedName: string = "editedOn"
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"
senderCommunicationIdentifier
senderCommunicationIdentifier: object
serializedName
serializedName: string = "senderCommunicationIdentifier"
type
type: object
className
className: string = "CommunicationIdentifierModel"
name
name: string = "Composite"
senderDisplayName
senderDisplayName: object
serializedName
serializedName: string = "senderDisplayName"
type
type: object
name
name: string = "String"
sequenceId
sequenceId: object
required
required: boolean = true
serializedName
serializedName: string = "sequenceId"
type
type: object
name
name: string = "String"
type
type: object
required
required: boolean = true
serializedName
serializedName: string = "type"
type
type: object
name
name: string = "String"
version
version: object
required
required: boolean = true
serializedName
serializedName: string = "version"
type
type: object
name
name: string = "String"
Const ChatMessageContent
ChatMessageContent: object
type
type: object
className
className: string = "ChatMessageContent"
name
name: string = "Composite"
modelProperties
modelProperties: object
initiatorCommunicationIdentifier
initiatorCommunicationIdentifier: object
serializedName
serializedName: string = "initiatorCommunicationIdentifier"
type
type: object
className
className: string = "CommunicationIdentifierModel"
name
name: string = "Composite"
message
message: object
serializedName
serializedName: string = "message"
type
type: object
name
name: string = "String"
participants
participants: object
serializedName
serializedName: string = "participants"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ChatParticipant"
name
name: string = "Composite"
topic
topic: object
serializedName
serializedName: string = "topic"
type
type: object
name
name: string = "String"
Const ChatMessageReadReceipt
ChatMessageReadReceipt: object
type
type: object
className
className: string = "ChatMessageReadReceipt"
name
name: string = "Composite"
modelProperties
modelProperties: object
chatMessageId
chatMessageId: object
required
required: boolean = true
serializedName
serializedName: string = "chatMessageId"
type
type: object
name
name: string = "String"
readOn
readOn: object
required
required: boolean = true
serializedName
serializedName: string = "readOn"
type
type: object
name
name: string = "DateTime"
senderCommunicationIdentifier
senderCommunicationIdentifier: object
serializedName
serializedName: string = "senderCommunicationIdentifier"
type
type: object
className
className: string = "CommunicationIdentifierModel"
name
name: string = "Composite"
Const ChatMessageReadReceiptsCollection
ChatMessageReadReceiptsCollection: object
type
type: object
className
className: string = "ChatMessageReadReceiptsCollection"
name
name: string = "Composite"
modelProperties
modelProperties: object
nextLink
nextLink: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
value
value: object
required
required: boolean = true
serializedName
serializedName: string = "value"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ChatMessageReadReceipt"
name
name: string = "Composite"
Const ChatMessagesCollection
ChatMessagesCollection: object
type
type: object
className
className: string = "ChatMessagesCollection"
name
name: string = "Composite"
modelProperties
modelProperties: object
nextLink
nextLink: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
value
value: object
required
required: boolean = true
serializedName
serializedName: string = "value"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ChatMessage"
name
name: string = "Composite"
Const ChatParticipant
ChatParticipant: object
type
type: object
className
className: string = "ChatParticipant"
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"
displayName
displayName: object
serializedName
serializedName: string = "displayName"
type
type: object
name
name: string = "String"
shareHistoryTime
shareHistoryTime: object
serializedName
serializedName: string = "shareHistoryTime"
type
type: object
name
name: string = "DateTime"
Const ChatParticipantsCollection
ChatParticipantsCollection: object
type
type: object
className
className: string = "ChatParticipantsCollection"
name
name: string = "Composite"
modelProperties
modelProperties: object
nextLink
nextLink: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
value
value: object
required
required: boolean = true
serializedName
serializedName: string = "value"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ChatParticipant"
name
name: string = "Composite"
Const ChatThreadInfo
ChatThreadInfo: object
type
type: object
className
className: string = "ChatThreadInfo"
name
name: string = "Composite"
modelProperties
modelProperties: object
deletedOn
deletedOn: object
serializedName
serializedName: string = "deletedOn"
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"
lastMessageReceivedOn
lastMessageReceivedOn: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "lastMessageReceivedOn"
type
type: object
name
name: string = "DateTime"
topic
topic: object
required
required: boolean = true
serializedName
serializedName: string = "topic"
type
type: object
name
name: string = "String"
Const ChatThreadsInfoCollection
ChatThreadsInfoCollection: object
type
type: object
className
className: string = "ChatThreadsInfoCollection"
name
name: string = "Composite"
modelProperties
modelProperties: object
nextLink
nextLink: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
value
value: object
required
required: boolean = true
serializedName
serializedName: string = "value"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ChatThreadInfo"
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"
microsoftTeamsUser
microsoftTeamsUser: object
serializedName
serializedName: string = "microsoftTeamsUser"
type
type: object
className
className: string = "MicrosoftTeamsUserIdentifierModel"
name
name: string = "Composite"
phoneNumber
phoneNumber: object
serializedName
serializedName: string = "phoneNumber"
type
type: object
className
className: string = "PhoneNumberIdentifierModel"
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 CreateChatThreadErrors
CreateChatThreadErrors: object
type
type: object
className
className: string = "CreateChatThreadErrors"
name
name: string = "Composite"
modelProperties
modelProperties: object
invalidParticipants
invalidParticipants: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "invalidParticipants"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "CommunicationError"
name
name: string = "Composite"
Const CreateChatThreadRequest
CreateChatThreadRequest: object
type
type: object
className
className: string = "CreateChatThreadRequest"
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 = "ChatParticipant"
name
name: string = "Composite"
topic
topic: object
required
required: boolean = true
serializedName
serializedName: string = "topic"
type
type: object
name
name: string = "String"
Const CreateChatThreadResult
CreateChatThreadResult: object
type
type: object
className
className: string = "CreateChatThreadResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
chatThread
chatThread: object
serializedName
serializedName: string = "chatThread"
type
type: object
className
className: string = "ChatThread"
name
name: string = "Composite"
errors
errors: object
serializedName
serializedName: string = "errors"
type
type: object
className
className: string = "CreateChatThreadErrors"
name
name: string = "Composite"
Const MicrosoftTeamsUserIdentifierModel
MicrosoftTeamsUserIdentifierModel: object
type
type: object
className
className: string = "MicrosoftTeamsUserIdentifierModel"
name
name: string = "Composite"
modelProperties
modelProperties: object
cloud
cloud: object
serializedName
serializedName: string = "cloud"
type
type: object
name
name: string = "String"
isAnonymous
isAnonymous: object
serializedName
serializedName: string = "isAnonymous"
type
type: object
name
name: string = "Boolean"
userId
userId: object
required
required: boolean = true
serializedName
serializedName: string = "userId"
type
type: object
name
name: string = "String"
Const PhoneNumberIdentifierModel
PhoneNumberIdentifierModel: object
type
type: object
className
className: string = "PhoneNumberIdentifierModel"
name
name: string = "Composite"
modelProperties
modelProperties: object
value
value: object
required
required: boolean = true
serializedName
serializedName: string = "value"
type
type: object
name
name: string = "String"
Const SendChatMessageRequest
SendChatMessageRequest: object
type
type: object
className
className: string = "SendChatMessageRequest"
name
name: string = "Composite"
modelProperties
modelProperties: object
content
content: object
required
required: boolean = true
serializedName
serializedName: string = "content"
type
type: object
name
name: string = "String"
senderDisplayName
senderDisplayName: object
serializedName
serializedName: string = "senderDisplayName"
type
type: object
name
name: string = "String"
type
type: object
serializedName
serializedName: string = "type"
type
type: object
name
name: string = "String"
Const SendChatMessageResult
SendChatMessageResult: object
type
type: object
className
className: string = "SendChatMessageResult"
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 SendReadReceiptRequest
SendReadReceiptRequest: object
type
type: object
className
className: string = "SendReadReceiptRequest"
name
name: string = "Composite"
modelProperties
modelProperties: object
chatMessageId
chatMessageId: object
required
required: boolean = true
serializedName
serializedName: string = "chatMessageId"
type
type: object
name
name: string = "String"
Const UpdateChatMessageRequest
UpdateChatMessageRequest: object
type
type: object
className
className: string = "UpdateChatMessageRequest"
name
name: string = "Composite"
modelProperties
modelProperties: object
content
content: object
serializedName
serializedName: string = "content"
type
type: object
name
name: string = "String"
Const UpdateChatThreadRequest
UpdateChatThreadRequest: object
type
type: object
className
className: string = "UpdateChatThreadRequest"
name
name: string = "Composite"
modelProperties
modelProperties: object
topic
topic: object
serializedName
serializedName: string = "topic"
type
type: object
name
name: string = "String"
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 addChatParticipantsOperationSpec
addChatParticipantsOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType]
httpMethod
httpMethod: string = "POST"
mediaType
mediaType: string = "json"
path
path: string = "/chat/threads/{chatThreadId}/participants/:add"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.addChatParticipantsRequest
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
201
201: object
bodyMapper
bodyMapper: any = Mappers.AddChatParticipantsResult
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const addChatParticipantsRequest
addChatParticipantsRequest: object
mapper
mapper: any = AddChatParticipantsRequestMapper
parameterPath
parameterPath: string = "addChatParticipantsRequest"
Const apiVersion
apiVersion: object
parameterPath
parameterPath: string = "apiVersion"
mapper
mapper: object
defaultValue
defaultValue: string = "2021-01-27-preview4"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "api-version"
type
type: object
name
name: string = "String"
Const chatMessageId
chatMessageId: object
parameterPath
parameterPath: string = "chatMessageId"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "chatMessageId"
type
type: object
name
name: string = "String"
Const chatThreadId
chatThreadId: object
parameterPath
parameterPath: string = "chatThreadId"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "chatThreadId"
type
type: object
name
name: string = "String"
Const contentType
contentType: object
parameterPath
parameterPath: string[] = ["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 contentType1
contentType1: object
parameterPath
parameterPath: string[] = ["options", "contentType"]
mapper
mapper: object
defaultValue
defaultValue: string = "application/merge-patch+json"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "Content-Type"
type
type: object
name
name: string = "String"
Const createChatThreadOperationSpec
createChatThreadOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType, Parameters.repeatabilityRequestId]
httpMethod
httpMethod: string = "POST"
mediaType
mediaType: string = "json"
path
path: string = "/chat/threads"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.createChatThreadRequest
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
201
201: object
bodyMapper
bodyMapper: any = Mappers.CreateChatThreadResult
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const createChatThreadRequest
createChatThreadRequest: object
mapper
mapper: any = CreateChatThreadRequestMapper
parameterPath
parameterPath: string = "createChatThreadRequest"
Const deleteChatMessageOperationSpec
deleteChatMessageOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "DELETE"
path
path: string = "/chat/threads/{chatThreadId}/messages/{chatMessageId}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId, Parameters.chatMessageId]
responses
responses: object
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const deleteChatThreadOperationSpec
deleteChatThreadOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "DELETE"
path
path: string = "/chat/threads/{chatThreadId}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
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 getChatMessageOperationSpec
getChatMessageOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/chat/threads/{chatThreadId}/messages/{chatMessageId}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId, Parameters.chatMessageId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatMessage
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const getChatThreadOperationSpec
getChatThreadOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/chat/threads/{chatThreadId}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatThread
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const listChatMessagesNextOperationSpec
listChatMessagesNextOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "{nextLink}"
queryParameters
queryParameters: any[] = [Parameters.maxPageSize, Parameters.apiVersion, Parameters.startTime]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId, Parameters.nextLink]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatMessagesCollection
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const listChatMessagesOperationSpec
listChatMessagesOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/chat/threads/{chatThreadId}/messages"
queryParameters
queryParameters: any[] = [Parameters.maxPageSize, Parameters.apiVersion, Parameters.startTime]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatMessagesCollection
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const listChatParticipantsNextOperationSpec
listChatParticipantsNextOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "{nextLink}"
queryParameters
queryParameters: any[] = [Parameters.maxPageSize, Parameters.skip, Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId, Parameters.nextLink]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatParticipantsCollection
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const listChatParticipantsOperationSpec
listChatParticipantsOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/chat/threads/{chatThreadId}/participants"
queryParameters
queryParameters: any[] = [Parameters.maxPageSize, Parameters.skip, Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatParticipantsCollection
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const listChatReadReceiptsNextOperationSpec
listChatReadReceiptsNextOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "{nextLink}"
queryParameters
queryParameters: any[] = [Parameters.maxPageSize, Parameters.skip, Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId, Parameters.nextLink]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatMessageReadReceiptsCollection
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const listChatReadReceiptsOperationSpec
listChatReadReceiptsOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/chat/threads/{chatThreadId}/readReceipts"
queryParameters
queryParameters: any[] = [Parameters.maxPageSize, Parameters.skip, Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatMessageReadReceiptsCollection
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const listChatThreadsNextOperationSpec
listChatThreadsNextOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "{nextLink}"
queryParameters
queryParameters: any[] = [Parameters.maxPageSize, Parameters.apiVersion, Parameters.startTime]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatThreadsInfoCollection
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const listChatThreadsOperationSpec
listChatThreadsOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/chat/threads"
queryParameters
queryParameters: any[] = [Parameters.maxPageSize, Parameters.apiVersion, Parameters.startTime]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.ChatThreadsInfoCollection
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const maxPageSize
maxPageSize: object
parameterPath
parameterPath: string[] = ["options", "maxPageSize"]
mapper
mapper: object
serializedName
serializedName: string = "maxPageSize"
type
type: object
name
name: string = "Number"
Const nextLink
nextLink: object
parameterPath
parameterPath: string = "nextLink"
skipEncoding
skipEncoding: boolean = true
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
Const participantCommunicationIdentifier
participantCommunicationIdentifier: object
mapper
mapper: any = CommunicationIdentifierModelMapper
parameterPath
parameterPath: string = "participantCommunicationIdentifier"
Const removeChatParticipantOperationSpec
removeChatParticipantOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType]
httpMethod
httpMethod: string = "POST"
mediaType
mediaType: string = "json"
path
path: string = "/chat/threads/{chatThreadId}/participants/:remove"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.participantCommunicationIdentifier
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const repeatabilityRequestId
repeatabilityRequestId: object
parameterPath
parameterPath: string[] = ["options", "repeatabilityRequestId"]
mapper
mapper: object
serializedName
serializedName: string = "repeatability-Request-Id"
type
type: object
name
name: string = "String"
Const sendChatMessageOperationSpec
sendChatMessageOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType]
httpMethod
httpMethod: string = "POST"
mediaType
mediaType: string = "json"
path
path: string = "/chat/threads/{chatThreadId}/messages"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.sendChatMessageRequest
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
201
201: object
bodyMapper
bodyMapper: any = Mappers.SendChatMessageResult
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const sendChatMessageRequest
sendChatMessageRequest: object
mapper
mapper: any = SendChatMessageRequestMapper
parameterPath
parameterPath: string = "sendChatMessageRequest"
Const sendChatReadReceiptOperationSpec
sendChatReadReceiptOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType]
httpMethod
httpMethod: string = "POST"
mediaType
mediaType: string = "json"
path
path: string = "/chat/threads/{chatThreadId}/readReceipts"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.sendReadReceiptRequest
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const sendReadReceiptRequest
sendReadReceiptRequest: object
mapper
mapper: any = SendReadReceiptRequestMapper
parameterPath
parameterPath: string = "sendReadReceiptRequest"
Const sendTypingNotificationOperationSpec
sendTypingNotificationOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "POST"
path
path: string = "/chat/threads/{chatThreadId}/typing"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const skip
skip: object
parameterPath
parameterPath: string[] = ["options", "skip"]
mapper
mapper: object
serializedName
serializedName: string = "skip"
type
type: object
name
name: string = "Number"
Const startTime
startTime: object
parameterPath
parameterPath: string[] = ["options", "startTime"]
mapper
mapper: object
serializedName
serializedName: string = "startTime"
type
type: object
name
name: string = "DateTime"
Const updateChatMessageOperationSpec
updateChatMessageOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType1]
httpMethod
httpMethod: string = "PATCH"
mediaType
mediaType: string = "json"
path
path: string = "/chat/threads/{chatThreadId}/messages/{chatMessageId}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.updateChatMessageRequest
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId, Parameters.chatMessageId]
responses
responses: object
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const updateChatMessageRequest
updateChatMessageRequest: object
mapper
mapper: any = UpdateChatMessageRequestMapper
parameterPath
parameterPath: string = "updateChatMessageRequest"
Const updateChatThreadOperationSpec
updateChatThreadOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType1]
httpMethod
httpMethod: string = "PATCH"
mediaType
mediaType: string = "json"
path
path: string = "/chat/threads/{chatThreadId}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.updateChatThreadRequest
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId]
responses
responses: object
401
401: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
403
403: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
429
429: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
503
503: object
bodyMapper
bodyMapper: any = Mappers.CommunicationErrorResponse
isError
isError: boolean = true
Const updateChatThreadRequest
updateChatThreadRequest: object
mapper
mapper: any = UpdateChatThreadRequestMapper
parameterPath
parameterPath: string = "updateChatThreadRequest"
Options to add a chat participant.