ChatAdapterThreadManagement interface

패키지:

@azure/communication-react

현재 채팅 스레드를 관리하기 위한 기능입니다.

메서드

deleteMessage(string)	스레드에서 메시지를 삭제합니다.
downloadResourceToCache(ResourceDetails)	지정된 메시지에 대한 리소스를 캐시로 다운로드합니다.
fetchInitialData()	채팅 어댑터의 초기 상태를 가져옵니다. ChatComposite 및 API 메서드에 필요한 최소 인출을 수행합니다.
loadPreviousChatMessages(number)	채팅 스레드 기록에 이전 메시지를 더 로드합니다.
removeParticipant(string)	스레드에서 참가자를 제거합니다.
removeResourceFromCache(ResourceDetails)	지정된 메시지에 대한 캐시에서 리소스를 제거합니다.
sendMessage(string, SendMessageOptions)	스레드에서 메시지를 보냅니다. SendMessageOptions는 더 이상 사용되지 않으므로 대신 MessageOptions를 사용하십시오.
sendReadReceipt(string)	메시지에 대한 읽음 확인 메시지를 보냅니다.
sendTypingIndicator()	스레드에서 입력 표시기를 보냅니다.
setTopic(string)	스레드에 대한 토픽을 설정합니다.
updateMessage(string, string, Record<string, string>)	메시지 콘텐츠를 업데이트합니다. 메타데이터는 더 이상 사용되지 않으므로 대신 MessageOptions.metadata를 사용하십시오.

메서드 세부 정보

deleteMessage(string)

스레드에서 메시지를 삭제합니다.

function deleteMessage(messageId: string): Promise<void>

매개 변수

messageId

string

반환

Promise<void>

downloadResourceToCache(ResourceDetails)

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

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

매개 변수

resourceDetails

ResourceDetails

반환

Promise<void>

fetchInitialData()

채팅 어댑터의 초기 상태를 가져옵니다.

ChatComposite 및 API 메서드에 필요한 최소 인출을 수행합니다.

function fetchInitialData(): Promise<void>

반환

Promise<void>

loadPreviousChatMessages(number)

채팅 스레드 기록에 이전 메시지를 더 로드합니다.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

매개 변수

messagesToLoad

number

반환

Promise<boolean>

설명

이 메서드는 일반적으로 증분 인출/무한 스크롤을 제어하는 데 사용됩니다.

removeParticipant(string)

스레드에서 참가자를 제거합니다.

function removeParticipant(userId: string): Promise<void>

매개 변수

userId

string

반환

Promise<void>

removeResourceFromCache(ResourceDetails)

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

function removeResourceFromCache(resourceDetails: ResourceDetails)

매개 변수

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

스레드에서 메시지를 보냅니다. SendMessageOptions는 더 이상 사용되지 않으므로 대신 MessageOptions를 사용하십시오.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

매개 변수

content

string

options

SendMessageOptions

반환

Promise<void>

sendReadReceipt(string)

메시지에 대한 읽음 확인 메시지를 보냅니다.

function sendReadReceipt(chatMessageId: string): Promise<void>

매개 변수

chatMessageId

string

반환

Promise<void>

sendTypingIndicator()

스레드에서 입력 표시기를 보냅니다.

function sendTypingIndicator(): Promise<void>

반환

Promise<void>

setTopic(string)

스레드에 대한 토픽을 설정합니다.

function setTopic(topicName: string): Promise<void>

매개 변수

topicName

string

반환

Promise<void>

updateMessage(string, string, Record<string, string>)

메시지 콘텐츠를 업데이트합니다. 메타데이터는 더 이상 사용되지 않으므로 대신 MessageOptions.metadata를 사용하십시오.

function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>

매개 변수

messageId

string

content

string

options

Record<string, string>

반환

Promise<void>