Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-chat

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AddChatParticipantsResponse

AddChatParticipantsResponse: WithResponse<AddChatParticipantsResult>

Represents the response from adding chat participants

AddParticipantsOptions

AddParticipantsOptions: OperationOptions

Options to add a chat participant.

ChatCreateChatThreadResponse

ChatCreateChatThreadResponse: CreateChatThreadResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CreateChatThreadResult } }

Contains response data for the createChatThread operation.

ChatGetChatThreadResponse

ChatGetChatThreadResponse: ChatThread & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatThread } }

Contains response data for the getChatThread operation.

ChatListChatThreadsNextResponse

ChatListChatThreadsNextResponse: ChatThreadsInfoCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatThreadsInfoCollection } }

Contains response data for the listChatThreadsNext operation.

ChatListChatThreadsResponse

ChatListChatThreadsResponse: ChatThreadsInfoCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatThreadsInfoCollection } }

Contains response data for the listChatThreads operation.

ChatMessageType

ChatMessageType: string

Defines values for ChatMessageType.
KnownChatMessageType can be used interchangeably with ChatMessageType, this enum contains the known values that the service supports.

Know values supported by the service

text
html
topicUpdated
participantAdded
participantRemoved

ChatThreadAddChatParticipantsResponse

ChatThreadAddChatParticipantsResponse: AddChatParticipantsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AddChatParticipantsResult } }

Contains response data for the addChatParticipants operation.

ChatThreadGetChatMessageResponse

ChatThreadGetChatMessageResponse: ChatMessage & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatMessage } }

Contains response data for the getChatMessage operation.

ChatThreadListChatMessagesNextResponse

ChatThreadListChatMessagesNextResponse: ChatMessagesCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatMessagesCollection } }

Contains response data for the listChatMessagesNext operation.

ChatThreadListChatMessagesResponse

ChatThreadListChatMessagesResponse: ChatMessagesCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatMessagesCollection } }

Contains response data for the listChatMessages operation.

ChatThreadListChatParticipantsNextResponse

ChatThreadListChatParticipantsNextResponse: ChatParticipantsCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatParticipantsCollection } }

Contains response data for the listChatParticipantsNext operation.

ChatThreadListChatParticipantsResponse

ChatThreadListChatParticipantsResponse: ChatParticipantsCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatParticipantsCollection } }

Contains response data for the listChatParticipants operation.

ChatThreadListChatReadReceiptsNextResponse

ChatThreadListChatReadReceiptsNextResponse: ChatMessageReadReceiptsCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatMessageReadReceiptsCollection } }

Contains response data for the listChatReadReceiptsNext operation.

ChatThreadListChatReadReceiptsResponse

ChatThreadListChatReadReceiptsResponse: ChatMessageReadReceiptsCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatMessageReadReceiptsCollection } }

Contains response data for the listChatReadReceipts operation.

ChatThreadSendChatMessageResponse

ChatThreadSendChatMessageResponse: SendChatMessageResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SendChatMessageResult } }

Contains response data for the sendChatMessage operation.

CreateChatThreadOptions

CreateChatThreadOptions: RestCreateChatThreadOptions

Options to create a chat thread.

CreateChatThreadResponse

CreateChatThreadResponse: WithResponse<CreateChatThreadResult>

Represents the response from creating a chat thread

DeleteChatThreadOptions

DeleteChatThreadOptions: OperationOptions

Options to delete a chat thread.

DeleteMessageOptions

DeleteMessageOptions: OperationOptions

Options to delete a chat message.

GetChatMessageResponse

GetChatMessageResponse: WithResponse<ChatMessage>

Represents the response from getting a chat message

GetChatThreadOptions

GetChatThreadOptions: OperationOptions

Options to get a chat thread.

GetChatThreadResponse

GetChatThreadResponse: WithResponse<ChatThread>

Represents the response from getting a chat thread

GetMessageOptions

GetMessageOptions: OperationOptions

Options to get a chat message.

ListChatThreadsOptions

ListChatThreadsOptions: RestListChatThreadsOptions

Options to get chat threads.

ListMessagesOptions

ListMessagesOptions: RestListMessagesOptions

Options to list chat messages.

ListParticipantsOptions

ListParticipantsOptions: RestListParticipantsOptions

Options to list chat participants.

ListReadReceiptsOptions

ListReadReceiptsOptions: RestListReadReceiptsOptions

Options to list read receipts.

OperationTracingOptions

OperationTracingOptions: OperationOptions["tracingOptions"]

RemoveParticipantOptions

RemoveParticipantOptions: OperationOptions

Options to remove a chat participant.

SendChatMessageResponse

SendChatMessageResponse: WithResponse<SendChatMessageResult>

Represents the response from sending a chat message

SendReadReceiptOptions

SendReadReceiptOptions: OperationOptions

Options to send read receipt.

SendTypingNotificationOptions

SendTypingNotificationOptions: OperationOptions

Options to send typing notifications.

WithResponse

WithResponse<T>: T & { _response: HttpResponse }

Represents an object with a non-enumerable _response property which provides

Type parameters

  • T

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.0.0-beta.3"

Const logger

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

Const minimumTypingIntervalInMilliSeconds

minimumTypingIntervalInMilliSeconds: number = 8000

Const packageName

packageName: "azure-communication-chat" = "azure-communication-chat"

Const packageVersion

packageVersion: "1.0.0-beta.3" = "1.0.0-beta.3"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Functions

Const attachHttpResponse

  • attachHttpResponse<T>(model: T, httpResponse: HttpResponse & { bodyAsText: string; parsedBody: any }): WithResponse<T>

  • Attach http response to a model

    Type parameters

    • T

    Parameters

    • model: T
    • httpResponse: HttpResponse & { bodyAsText: string; parsedBody: any }

    Returns WithResponse<T>

Const createCommunicationTokenCredentialPolicy

  • createCommunicationTokenCredentialPolicy(credential: CommunicationTokenCredential): RequestPolicyFactory

  • Creates a new CommunicationTokenCredentialPolicy factory.

    Parameters

    • credential: CommunicationTokenCredential

      The CommunicationTokenCredential implementation that can supply the user credential.

    Returns RequestPolicyFactory

Const getSignalingClient

  • getSignalingClient(_credential: CommunicationTokenCredential, _logger: AzureLogger): SignalingClient | undefined
  • getSignalingClient(credential: CommunicationTokenCredential, logger: AzureLogger): SignalingClient | undefined

Const mapToAddChatParticipantsRequestRestModel

Const mapToChatContentSdkModel

Const mapToChatMessageSdkModel

  • mapToChatMessageSdkModel(chatMessage: ChatMessage): ChatMessage

Const mapToChatMessagesSdkModelArray

Const mapToChatParticipantRestModel

  • mapToChatParticipantRestModel(chatParticipant: ChatParticipant): ChatParticipant

Const mapToChatParticipantSdkModel

  • mapToChatParticipantSdkModel(chatParticipant: ChatParticipant): ChatParticipant

Const mapToChatThreadSdkModel

  • mapToChatThreadSdkModel(chatThread: ChatThread): ChatThread

Const mapToReadReceiptSdkModel

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"

senderDisplayName

senderDisplayName: object

serializedName

serializedName: string = "senderDisplayName"

type

type: object

name

name: string = "String"

senderId

senderId: object

serializedName

serializedName: string = "senderId"

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

initiator

initiator: object

serializedName

serializedName: string = "initiator"

type

type: object

name

name: string = "String"

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"

senderId

senderId: object

required

required: boolean = true

serializedName

serializedName: string = "senderId"

type

type: object

name

name: string = "String"

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

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

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 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 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 = "2020-11-01-preview3"

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 chatParticipantId

chatParticipantId: object

parameterPath

parameterPath: string = "chatParticipantId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "chatParticipantId"

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

204

204: {}

Type declaration

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

204

204: {}

Type declaration

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 removeChatParticipantOperationSpec

removeChatParticipantOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/chat/threads/{chatThreadId}/participants/{chatParticipantId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.chatThreadId, Parameters.chatParticipantId]

responses

responses: object

204

204: {}

Type declaration

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

200

200: {}

Type declaration

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

200

200: {}

Type declaration

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

204

204: {}

Type declaration

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

204

204: {}

Type declaration

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"

Generated using TypeDoc