Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-chat

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AddMembersOptions

AddMembersOptions: OperationOptions

Options to add a chat thread member.

ChatApiClientCreateChatThreadResponse

ChatApiClientCreateChatThreadResponse: MultiStatusResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: MultiStatusResponse } }

Contains response data for the createChatThread operation.

ChatApiClientGetChatMessageResponse

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

Contains response data for the getChatMessage operation.

ChatApiClientGetChatThreadResponse

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

Contains response data for the getChatThread operation.

ChatApiClientListChatMessagesNextResponse

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

Contains response data for the listChatMessagesNext operation.

ChatApiClientListChatMessagesResponse

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

Contains response data for the listChatMessages operation.

ChatApiClientListChatReadReceiptsNextResponse

ChatApiClientListChatReadReceiptsNextResponse: ReadReceiptsCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ReadReceiptsCollection } }

Contains response data for the listChatReadReceiptsNext operation.

ChatApiClientListChatReadReceiptsResponse

ChatApiClientListChatReadReceiptsResponse: ReadReceiptsCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ReadReceiptsCollection } }

Contains response data for the listChatReadReceipts operation.

ChatApiClientListChatThreadMembersNextResponse

ChatApiClientListChatThreadMembersNextResponse: ChatThreadMembersCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatThreadMembersCollection } }

Contains response data for the listChatThreadMembersNext operation.

ChatApiClientListChatThreadMembersResponse

ChatApiClientListChatThreadMembersResponse: ChatThreadMembersCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ChatThreadMembersCollection } }

Contains response data for the listChatThreadMembers operation.

ChatApiClientListChatThreadsNextResponse

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

Contains response data for the listChatThreadsNext operation.

ChatApiClientListChatThreadsResponse

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

Contains response data for the listChatThreads operation.

ChatApiClientSendChatMessageResponse

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

Contains response data for the sendChatMessage operation.

ChatMessagePriority

ChatMessagePriority: "Normal" | "High"

Defines values for ChatMessagePriority.

CreateChatThreadOptions

CreateChatThreadOptions: OperationOptions

Options to create 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.

ListMembersOptions

ListMembersOptions: OperationOptions

Options to list chat thread members.

ListMessagesOptions

ListMessagesOptions: RestListMessagesOptions

Options to list chat messages.

ListReadReceiptsOptions

ListReadReceiptsOptions: OperationOptions

Options to list read receipts.

OperationTracingOptions

OperationTracingOptions: OperationOptions["tracingOptions"]

RemoveMemberOptions

RemoveMemberOptions: OperationOptions

Options to remove a chat thread member.

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 = apiVersion.mapper.defaultValue

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.1" = "1.0.0-beta.1"

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 createCommunicationUserCredentialPolicy

  • createCommunicationUserCredentialPolicy(credential: CommunicationUserCredential): RequestPolicyFactory

  • Creates a new CommunicationUserCredentialPolicy factory.

    Parameters

    • credential: CommunicationUserCredential

      The CommunicationUserCredential implementation that can supply the user credential.

    Returns RequestPolicyFactory

Const getSignalingClient

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

Const mapToAddChatThreadMembersRequestRestModel

Const mapToChatMessageSdkModel

  • mapToChatMessageSdkModel(chatMessage: ChatMessage): ChatMessage

Const mapToChatMessagesSdkModelArray

Const mapToChatThreadMemberRestModel

  • mapToChatThreadMemberRestModel(chatThreadMember: ChatThreadMember): ChatThreadMember

Const mapToChatThreadMemberSdkModel

  • mapToChatThreadMemberSdkModel(chatThreadMember: ChatThreadMember): ChatThreadMember

Const mapToChatThreadMembersSdkModelArray

Const mapToChatThreadSdkModel

  • mapToChatThreadSdkModel(chatThread: ChatThread): ChatThread

Const mapToReadReceiptSdkModel

  • mapToReadReceiptSdkModel(readReceipt: ReadReceipt): ReadReceipt

Const mapToReadReceiptsSdkModelArray

Object literals

Const AddChatThreadMembersRequest

AddChatThreadMembersRequest: object

type

type: object

className

className: string = "AddChatThreadMembersRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

members

members: object

required

required: boolean = true

serializedName

serializedName: string = "members"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ChatThreadMember"

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

name

name: string = "String"

createdOn

createdOn: object

readOnly

readOnly: 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

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: string = "String"

senderDisplayName

senderDisplayName: object

serializedName

serializedName: string = "senderDisplayName"

type

type: object

name

name: string = "String"

senderId

senderId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "senderId"

type

type: object

name

name: string = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

version

version: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "version"

type

type: object

name

name: string = "String"

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

readOnly

readOnly: 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 ChatThread

ChatThread: object

type

type: object

className

className: string = "ChatThread"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdBy

createdBy: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "createdBy"

type

type: object

name

name: string = "String"

createdOn

createdOn: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "createdOn"

type

type: object

name

name: string = "DateTime"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

members

members: object

serializedName

serializedName: string = "members"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ChatThreadMember"

name

name: string = "Composite"

topic

topic: object

serializedName

serializedName: string = "topic"

type

type: object

name

name: string = "String"

Const ChatThreadInfo

ChatThreadInfo: object

type

type: object

className

className: string = "ChatThreadInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

isDeleted

isDeleted: object

serializedName

serializedName: string = "isDeleted"

type

type: object

name

name: string = "Boolean"

lastMessageReceivedOn

lastMessageReceivedOn: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "lastMessageReceivedOn"

type

type: object

name

name: string = "DateTime"

topic

topic: object

serializedName

serializedName: string = "topic"

type

type: object

name

name: string = "String"

Const ChatThreadMember

ChatThreadMember: object

type

type: object

className

className: string = "ChatThreadMember"

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 ChatThreadMembersCollection

ChatThreadMembersCollection: object

type

type: object

className

className: string = "ChatThreadMembersCollection"

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

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ChatThreadMember"

name

name: string = "Composite"

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

readOnly

readOnly: 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 CreateChatThreadRequest

CreateChatThreadRequest: object

type

type: object

className

className: string = "CreateChatThreadRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

members

members: object

required

required: boolean = true

serializedName

serializedName: string = "members"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ChatThreadMember"

name

name: string = "Composite"

topic

topic: object

required

required: boolean = true

serializedName

serializedName: string = "topic"

type

type: object

name

name: string = "String"

Const ErrorModel

ErrorModel: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

innerErrors

innerErrors: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "innerErrors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: 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 IndividualStatusResponse

IndividualStatusResponse: object

type

type: object

className

className: string = "IndividualStatusResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

statusCode

statusCode: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "statusCode"

type

type: object

name

name: string = "Number"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const MultiStatusResponse

MultiStatusResponse: object

type

type: object

className

className: string = "MultiStatusResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

multipleStatus

multipleStatus: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "multipleStatus"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "IndividualStatusResponse"

name

name: string = "Composite"

Const ReadReceipt

ReadReceipt: object

type

type: object

className

className: string = "ReadReceipt"

name

name: string = "Composite"

modelProperties

modelProperties: object

chatMessageId

chatMessageId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "chatMessageId"

type

type: object

name

name: string = "String"

readOn

readOn: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "readOn"

type

type: object

name

name: string = "DateTime"

senderId

senderId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "senderId"

type

type: object

name

name: string = "String"

Const ReadReceiptsCollection

ReadReceiptsCollection: object

type

type: object

className

className: string = "ReadReceiptsCollection"

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

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ReadReceipt"

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"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: string = "String"

senderDisplayName

senderDisplayName: object

serializedName

serializedName: string = "senderDisplayName"

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

readOnly

readOnly: 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"

priority

priority: object

serializedName

serializedName: string = "priority"

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 addChatThreadMembersOperationSpec

addChatThreadMembersOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/chat/threads/{chatThreadId}/members"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body3

serializer

serializer: any

urlParameters

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

responses

responses: object

207

207: {}

Type declaration

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2020-09-21-preview2"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const body

body: object

mapper

mapper: any = SendReadReceiptRequestMapper

parameterPath

parameterPath: string = "body"

Const body1

body1: object

mapper

mapper: any = SendChatMessageRequestMapper

parameterPath

parameterPath: string = "body"

Const body2

body2: object

mapper

mapper: any = UpdateChatMessageRequestMapper

parameterPath

parameterPath: string = "body"

Const body3

body3: object

mapper

mapper: any = AddChatThreadMembersRequestMapper

parameterPath

parameterPath: string = "body"

Const body4

body4: object

mapper

mapper: any = CreateChatThreadRequestMapper

parameterPath

parameterPath: string = "body"

Const body5

body5: object

mapper

mapper: any = UpdateChatThreadRequestMapper

parameterPath

parameterPath: string = "body"

Const chatMemberId

chatMemberId: object

parameterPath

parameterPath: string = "chatMemberId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "chatMemberId"

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 createChatThreadOperationSpec

createChatThreadOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/chat/threads"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body4

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

207

207: object

bodyMapper

bodyMapper: any = Mappers.MultiStatusResponse

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const deleteChatMessageOperationSpec

deleteChatMessageOperationSpec: object

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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const deleteChatThreadOperationSpec

deleteChatThreadOperationSpec: object

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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

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

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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getChatThreadOperationSpec

getChatThreadOperationSpec: object

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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const listChatMessagesNextOperationSpec

listChatMessagesNextOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxPageSize, 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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const listChatMessagesOperationSpec

listChatMessagesOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "/chat/threads/{chatThreadId}/messages"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxPageSize, 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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const listChatReadReceiptsNextOperationSpec

listChatReadReceiptsNextOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ReadReceiptsCollection

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const listChatReadReceiptsOperationSpec

listChatReadReceiptsOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "/chat/threads/{chatThreadId}/readreceipts"

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.ReadReceiptsCollection

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const listChatThreadMembersNextOperationSpec

listChatThreadMembersNextOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ChatThreadMembersCollection

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const listChatThreadMembersOperationSpec

listChatThreadMembersOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "/chat/threads/{chatThreadId}/members"

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.ChatThreadMembersCollection

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const listChatThreadsNextOperationSpec

listChatThreadsNextOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxPageSize, 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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const listChatThreadsOperationSpec

listChatThreadsOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "/chat/threads"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxPageSize, 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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

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 removeChatThreadMemberOperationSpec

removeChatThreadMemberOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/chat/threads/{chatThreadId}/members/{chatMemberId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

204

204: {}

Type declaration

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const sendChatMessageOperationSpec

sendChatMessageOperationSpec: object

headerParameters

headerParameters: any[] = [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.body1

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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const sendChatReadReceiptOperationSpec

sendChatReadReceiptOperationSpec: object

headerParameters

headerParameters: any[] = [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.body

serializer

serializer: any

urlParameters

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

responses

responses: object

201

201: {}

Type declaration

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const sendTypingNotificationOperationSpec

sendTypingNotificationOperationSpec: object

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.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

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.contentType]

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.body2

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: {}

Type declaration

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const updateChatThreadOperationSpec

updateChatThreadOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

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

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body5

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: {}

Type declaration

401

401: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

403

403: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

429

429: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

503

503: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Generated using TypeDoc