StatefulChatClient interface

패키지:

@azure/communication-react

{@Link @azure/communication-chat#ChatClient} 중앙 집중식으로 생성된 상태로 사용할 수 있도록 하는 메서드를 정의합니다.

인터페이스는 프록시된 상태에 대한 액세스를 제공하고 상태 변경 이벤트에 대한 처리기를 등록할 수도 있습니다.

Extends

ChatClient

메서드

dispose()	채팅 스레드 클라이언트에서 리소스 캐시를 정리합니다.
downloadResourceToCache(string, string, string)	특정 메시지에 대한 리소스를 다운로드하여 캐시합니다.
getState()	ChatClient {@Link @azure/communication-chat#ChatClient}에서 ChatClientState {@Link ChatClientState}로 프록시할 수 있는 모든 상태를 보유합니다.
offStateChange((state: ChatClientState) => void)	'stateChanged' 이벤트에 대한 등록을 취소할 수 있습니다.
onStateChange((state: ChatClientState) => void)	처리기를 'stateChanged' 이벤트에 등록할 수 있습니다.
removeResourceFromCache(string, string, string)	특정 메시지에 대한 리소스를 캐시에서 제거합니다.

상속된 메서드

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	채팅 스레드를 만듭니다. 만든 스레드의 ID를 사용하여 스레드 클라이언트를 반환합니다.
deleteChatThread(string, OperationOptions)	채팅 스레드를 삭제합니다.
getChatThreadClient(string)	특정 스레드 ID를 사용하여 ChatThreadClient를 반환합니다.
listChatThreads(ChatListChatThreadsOptionalParams)	사용자의 채팅 스레드 목록을 가져옵니다.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	chatMessageDeleted에서 구독을 취소합니다.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	chatMessageEdited에서 구독을 취소합니다.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	chatMessageReceived에서 구독을 취소합니다.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	chatThreadCreated에서 구독을 취소합니다.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	chatThreadDeleted에서 구독을 취소합니다.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	chatThreadPropertiesUpdated에서 구독을 취소합니다.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	participantsAdded에서 구독을 취소합니다.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	참가자로부터 구독 취소Removed.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	readReceiptReceived에서 구독을 취소합니다.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	typingIndicatorReceived에서 구독을 취소합니다.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	chatMessageDeleted에 대한 구독 함수입니다. 초기 보낸 사람도 이 이벤트를 받게 됩니다.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	chatMessageEdited에 대한 구독 함수입니다. 초기 보낸 사람도 이 이벤트를 받게 됩니다.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	chatMessageReceived에 대한 구독 함수입니다. 초기 보낸 사람도 이 이벤트를 받게 됩니다. 이벤트를 구독하기 전에 startRealtimeNotifications를 호출해야 합니다.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	chatThreadCreated에 대한 구독 함수입니다.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	chatThreadDeleted에 대한 구독 함수입니다.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	chatThreadPropertiesUpdated에 대한 구독 함수입니다.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	participantsAdded에 대한 구독 함수입니다.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	참가자에 대한 Subscribe 함수Removed.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	readReceiptReceived에 대한 Subscribe 함수입니다.
on("realTimeNotificationConnected", () => void)	realTimeNotificationConnected에 대한 구독 함수입니다.
on("realTimeNotificationDisconnected", () => void)	realTimeNotificationDisconnected에 대한 구독 함수입니다.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	typingIndicatorReceived에 대한 Subscribe 함수입니다. 초기 보낸 사람도 이 이벤트를 받게 됩니다.
startRealtimeNotifications()	실시간 알림 수신을 시작합니다. 이벤트를 구독하기 전에 이 함수를 호출합니다.
stopRealtimeNotifications()	실시간 알림 수신을 중지합니다. 이 함수는 모든 이벤트를 구독 취소합니다.

메서드 세부 정보

dispose()

채팅 스레드 클라이언트에서 리소스 캐시를 정리합니다.

function dispose()

downloadResourceToCache(string, string, string)

특정 메시지에 대한 리소스를 다운로드하여 캐시합니다.

function downloadResourceToCache(threadId: string, messageId: string, resourceUrl: string)

매개 변수

threadId

string

채팅 스레드의 스레드 ID입니다.

messageId

string

채팅 메시지의 메시지 ID입니다.

resourceUrl

string

가져오고 캐시할 리소스 URL입니다.

getState()

ChatClient {@Link @azure/communication-chat#ChatClient}에서 ChatClientState {@Link ChatClientState}로 프록시할 수 있는 모든 상태를 보유합니다.

function getState(): ChatClientState

반환

ChatClientState

offStateChange((state: ChatClientState) => void)

'stateChanged' 이벤트에 대한 등록을 취소할 수 있습니다.

function offStateChange(handler: (state: ChatClientState) => void)

매개 변수

handler

(state: ChatClientState) => void

구독을 취소할 원래 콜백입니다.

onStateChange((state: ChatClientState) => void)

처리기를 'stateChanged' 이벤트에 등록할 수 있습니다.

function onStateChange(handler: (state: ChatClientState) => void)

매개 변수

handler

(state: ChatClientState) => void

상태를 수신하기 위한 콜백입니다.

removeResourceFromCache(string, string, string)

특정 메시지에 대한 리소스를 캐시에서 제거합니다.

function removeResourceFromCache(threadId: string, messageId: string, resourceUrl: string)

매개 변수

threadId

string

채팅 스레드의 스레드 ID입니다.

messageId

string

채팅 메시지의 메시지 ID입니다.

resourceUrl

string

캐시에서 제거할 리소스 URL입니다.

상속된 메서드 세부 정보

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

채팅 스레드를 만듭니다. 만든 스레드의 ID를 사용하여 스레드 클라이언트를 반환합니다.

function createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResult>

매개 변수

request

CreateChatThreadRequest

채팅 스레드를 만들기 위한 요청입니다.

options

CreateChatThreadOptions

작업 옵션입니다.

반환

Promise<CreateChatThreadResult>

ChatClient.createChatThread에서 상속된

deleteChatThread(string, OperationOptions)

채팅 스레드를 삭제합니다.

function deleteChatThread(threadId: string, options?: OperationOptions): Promise<void>

매개 변수

threadId

string

삭제할 스레드의 ID입니다.

options

OperationOptions

작업 옵션입니다.

반환

Promise<void>

ChatClient.deleteChatThread에서 상속된

getChatThreadClient(string)

특정 스레드 ID를 사용하여 ChatThreadClient를 반환합니다.

function getChatThreadClient(threadId: string): ChatThreadClient

매개 변수

threadId

string

ChatThreadClient의 스레드 ID

반환

ChatThreadClient

ChatClient.getChatThreadClient에서 상속된

listChatThreads(ChatListChatThreadsOptionalParams)

사용자의 채팅 스레드 목록을 가져옵니다.

function listChatThreads(options?: ChatListChatThreadsOptionalParams): PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

매개 변수

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

채팅 스레드 옵션을 나열합니다.

반환

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

ChatClient.listChatThreads에서 상속된

off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

chatMessageDeleted에서 구독을 취소합니다.

function off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

매개 변수

event

"chatMessageDeleted"

ChatMessageDeletedEvent입니다.

listener

(e: ChatMessageDeletedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

chatMessageEdited에서 구독을 취소합니다.

function off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

매개 변수

event

"chatMessageEdited"

ChatMessageEditedEvent입니다.

listener

(e: ChatMessageEditedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

chatMessageReceived에서 구독을 취소합니다.

function off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

매개 변수

event

"chatMessageReceived"

ChatMessageReceivedEvent입니다.

listener

(e: ChatMessageReceivedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

chatThreadCreated에서 구독을 취소합니다.

function off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

매개 변수

event

"chatThreadCreated"

ChatThreadCreatedEvent입니다.

listener

(e: ChatThreadCreatedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

chatThreadDeleted에서 구독을 취소합니다.

function off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

매개 변수

event

"chatThreadDeleted"

ChatThreadDeletedEvent입니다.

listener

(e: ChatThreadDeletedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

chatThreadPropertiesUpdated에서 구독을 취소합니다.

function off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

매개 변수

event

"chatThreadPropertiesUpdated"

ChatThreadPropertiesUpdatedEvent입니다.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("participantsAdded", (e: ParticipantsAddedEvent) => void)

participantsAdded에서 구독을 취소합니다.

function off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

매개 변수

event

"participantsAdded"

ParticipantsAddedEvent입니다.

listener

(e: ParticipantsAddedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

참가자로부터 구독 취소Removed.

function off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

매개 변수

event

"participantsRemoved"

ParticipantsRemoved이벤트.

listener

(e: ParticipantsRemovedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

readReceiptReceived에서 구독을 취소합니다.

function off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

매개 변수

event

"readReceiptReceived"

ReadReceiptReceivedEvent입니다.

listener

(e: ReadReceiptReceivedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

typingIndicatorReceived에서 구독을 취소합니다.

function off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

매개 변수

event

"typingIndicatorReceived"

TypingIndicatorReceivedEvent입니다.

listener

(e: TypingIndicatorReceivedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.off에서 상속된

on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

chatMessageDeleted에 대한 구독 함수입니다. 초기 보낸 사람도 이 이벤트를 받게 됩니다.

function on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

매개 변수

event

"chatMessageDeleted"

ChatMessageDeletedEvent입니다.

listener

(e: ChatMessageDeletedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

chatMessageEdited에 대한 구독 함수입니다. 초기 보낸 사람도 이 이벤트를 받게 됩니다.

function on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

매개 변수

event

"chatMessageEdited"

ChatMessageEditedEvent입니다.

listener

(e: ChatMessageEditedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

chatMessageReceived에 대한 구독 함수입니다. 초기 보낸 사람도 이 이벤트를 받게 됩니다. 이벤트를 구독하기 전에 startRealtimeNotifications를 호출해야 합니다.

function on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

매개 변수

event

"chatMessageReceived"

ChatMessageReceivedEvent입니다.

listener

(e: ChatMessageReceivedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

chatThreadCreated에 대한 구독 함수입니다.

function on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

매개 변수

event

"chatThreadCreated"

ChatThreadCreatedEvent입니다.

listener

(e: ChatThreadCreatedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

chatThreadDeleted에 대한 구독 함수입니다.

function on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

매개 변수

event

"chatThreadDeleted"

ChatThreadDeletedEvent입니다.

listener

(e: ChatThreadDeletedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

chatThreadPropertiesUpdated에 대한 구독 함수입니다.

function on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

매개 변수

event

"chatThreadPropertiesUpdated"

ChatThreadPropertiesUpdatedEvent입니다.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("participantsAdded", (e: ParticipantsAddedEvent) => void)

participantsAdded에 대한 구독 함수입니다.

function on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

매개 변수

event

"participantsAdded"

ParticipantsAddedEvent입니다.

listener

(e: ParticipantsAddedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

참가자에 대한 Subscribe 함수Removed.

function on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

매개 변수

event

"participantsRemoved"

ParticipantsRemoved이벤트.

listener

(e: ParticipantsRemovedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

readReceiptReceived에 대한 Subscribe 함수입니다.

function on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

매개 변수

event

"readReceiptReceived"

ReadReceiptReceivedEvent입니다.

listener

(e: ReadReceiptReceivedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("realTimeNotificationConnected", () => void)

realTimeNotificationConnected에 대한 구독 함수입니다.

function on(event: "realTimeNotificationConnected", listener: () => void)

매개 변수

event

"realTimeNotificationConnected"

realTimeNotificationConnected 이벤트

listener

() => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("realTimeNotificationDisconnected", () => void)

realTimeNotificationDisconnected에 대한 구독 함수입니다.

function on(event: "realTimeNotificationDisconnected", listener: () => void)

매개 변수

event

"realTimeNotificationDisconnected"

realTimeNotificationDisconnected 이벤트

listener

() => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

typingIndicatorReceived에 대한 Subscribe 함수입니다. 초기 보낸 사람도 이 이벤트를 받게 됩니다.

function on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

매개 변수

event

"typingIndicatorReceived"

TypingIndicatorReceivedEvent입니다.

listener

(e: TypingIndicatorReceivedEvent) => void

이벤트를 처리할 수신기입니다.

ChatClient.on에서 상속된

startRealtimeNotifications()

실시간 알림 수신을 시작합니다. 이벤트를 구독하기 전에 이 함수를 호출합니다.

function startRealtimeNotifications(): Promise<void>

반환

Promise<void>

ChatClient.startRealtimeNotifications에서 상속된

stopRealtimeNotifications()

실시간 알림 수신을 중지합니다. 이 함수는 모든 이벤트를 구독 취소합니다.

function stopRealtimeNotifications(): Promise<void>

반환

Promise<void>

ChatClient.stopRealtimeNotifications에서 상속된