ChatThreadClient class
채팅 작업을 수행할 클라이언트
속성
| thread |
ChatThreadClient의 스레드 ID |
메서드
생성자 세부 정보
ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)
new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions)매개 변수
- endpoint
-
string
- threadId
-
string
- credential
- CommunicationTokenCredential
- options
- ChatThreadClientOptions
속성 세부 정보
threadId
ChatThreadClient의 스레드 ID
threadId: string속성 값
string
메서드 세부 정보
addParticipants(AddParticipantsRequest, OperationOptions)
threadId로 식별되는 스레드에 속하는 채팅 참가자의 세부 정보를 추가합니다.
function addParticipants(request: AddParticipantsRequest, options?: OperationOptions): Promise<AddChatParticipantsResult>매개 변수
- request
- AddParticipantsRequest
스레드 명단에 추가할 스레드 참가자의 세부 정보
- options
- OperationOptions
작업 옵션입니다.
반환
Promise<AddChatParticipantsResult>
deleteMessage(string, OperationOptions)
threadId 및 messageId로 식별되는 메시지를 삭제합니다.
function deleteMessage(messageId: string, options?: OperationOptions): Promise<void>매개 변수
- messageId
-
string
메시지의 메시지 ID입니다.
- options
- OperationOptions
작업 옵션입니다.
반환
Promise<void>
getMessage(string, OperationOptions)
messageId로 식별되는 채팅 메시지를 가져옵니다. 특정 메시지를 반환합니다.
function getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>매개 변수
- messageId
-
string
메시지의 메시지 ID입니다.
- options
- OperationOptions
작업 옵션입니다.
반환
Promise<ChatMessage>
getProperties(OperationOptions)
채팅 스레드를 가져옵니다. 채팅 스레드를 반환합니다.
function getProperties(options?: OperationOptions): Promise<ChatThreadProperties>매개 변수
- options
- OperationOptions
작업 옵션입니다.
반환
Promise<ChatThreadProperties>
listMessages(ChatThreadListChatMessagesOptionalParams)
threadId로 식별된 스레드에서 메시지 목록을 가져옵니다. 메시지 목록을 반환합니다.
function listMessages(options?: ChatThreadListChatMessagesOptionalParams): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>매개 변수
- options
- RestListMessagesOptions
메시지 옵션을 가져옵니다.
반환
listParticipants(ChatThreadListChatParticipantsOptionalParams)
threadId로 식별되는 스레드의 참가자를 가져옵니다. 참가자 목록을 반환합니다.
function listParticipants(options?: ChatThreadListChatParticipantsOptionalParams): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>매개 변수
- options
- RestListParticipantsOptions
작업 옵션입니다.
반환
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)
threadId로 식별된 스레드에서 읽음 확인 목록을 가져옵니다. 메시지 목록을 반환합니다.
function listReadReceipts(options?: ChatThreadListChatReadReceiptsOptionalParams): PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>매개 변수
- options
- RestListReadReceiptsOptions
메시지 옵션을 가져옵니다.
반환
removeParticipant(CommunicationIdentifier, OperationOptions)
threadId로 식별되는 스레드에서 참가자를 제거합니다.
function removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>매개 변수
- participant
- CommunicationIdentifier
스레드 명단에서 제거할 스레드 참가자
- options
- OperationOptions
작업 옵션입니다.
반환
Promise<void>
sendMessage(SendMessageRequest, SendMessageOptions)
threadId로 식별되는 스레드에 채팅 메시지를 보냅니다. 만든 메시지의 ID를 반환합니다.
function sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResult>매개 변수
- request
- SendMessageRequest
메시지를 보내기 위한 요청입니다.
- options
- SendMessageOptions
작업 옵션입니다.
반환
Promise<SendChatMessageResult>
sendReadReceipt(SendReadReceiptRequest, OperationOptions)
threadId로 식별된 스레드에 읽음 확인을 보냅니다.
function sendReadReceipt(request: SendReadReceiptRequest, options?: OperationOptions): Promise<void>매개 변수
- request
- SendReadReceiptRequest
읽음 확인 보내기 요청
- options
- OperationOptions
작업 옵션입니다.
반환
Promise<void>
sendTypingNotification(SendTypingNotificationOptions)
스레드에 입력 알림을 보냅니다. 마지막 알림 이후의 시간이 최소 입력 간격보다 작은 경우 전송을 시도하지 않습니다.
function sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>매개 변수
- options
- SendTypingNotificationOptions
작업 옵션
반환
Promise<boolean>
입력 메시지 알림을 보낼 수 있으면 True이고, 그렇지 않으면 false입니다.
updateMessage(string, UpdateMessageOptions)
threadId 및 messageId로 식별되는 메시지를 업데이트합니다.
function updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<void>매개 변수
- messageId
-
string
메시지의 메시지 ID입니다.
- options
- UpdateMessageOptions
작업 옵션입니다.
반환
Promise<void>
updateProperties(UpdateChatThreadPropertiesOptions)
스레드의 속성을 업데이트합니다.
function updateProperties(options?: UpdateChatThreadPropertiesOptions): Promise<void>매개 변수
작업 옵션입니다.
반환
Promise<void>
updateTopic(string, UpdateTopicOptions)
스레드의 토픽을 업데이트합니다.
function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>매개 변수
- topic
-
string
토픽을 업데이트해야 합니다.
- options
- UpdateTopicOptions
작업 옵션입니다.
반환
Promise<void>