ChatAdapterThreadManagement interface

  • Referens
Paket:
@azure/communication-react

Funktioner för att hantera den aktuella chatttråden.

Metoder

deleteMessage(string)

Ta bort ett meddelande i tråden.
fetchInitialData()

Hämta initialt tillstånd för chattkortet.

Utför den minimala hämtning som krävs för ChatComposite- och API-metoder.
loadPreviousChatMessages(number)

Läs in fler tidigare meddelanden i chatttrådens historik.
removeParticipant(string)

Ta bort en deltagare i tråden.
sendMessage(string, SendMessageOptions)

Skicka ett meddelande i tråden.
sendReadReceipt(string)

Skicka ett läskvitto för ett meddelande.
sendTypingIndicator()

Skicka inmatningsindikatorn i tråden.
setTopic(string)

Ange ämnet för tråden.
updateMessage(string, string, Record<string, string>)

Uppdatera ett meddelandeinnehåll.

Metodinformation

deleteMessage(string)

Ta bort ett meddelande i tråden.

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

Parametrar

messageId

string

Returer

Promise<void>

fetchInitialData()

Hämta initialt tillstånd för chattkortet.

Utför den minimala hämtning som krävs för ChatComposite- och API-metoder.

function fetchInitialData(): Promise<void>

Returer

Promise<void>

loadPreviousChatMessages(number)

Läs in fler tidigare meddelanden i chatttrådens historik.

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

Parametrar

messagesToLoad

number

Returer

Promise<boolean>

Kommentarer

Den här metoden används vanligtvis för att styra inkrementell hämtning/oändlig rullning

removeParticipant(string)

Ta bort en deltagare i tråden.

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

Parametrar

userId

string

Returer

Promise<void>

sendMessage(string, SendMessageOptions)

Skicka ett meddelande i tråden.

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

Parametrar

content

string

options
SendMessageOptions

Returer

Promise<void>

sendReadReceipt(string)

Skicka ett läskvitto för ett meddelande.

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

Parametrar

chatMessageId

string

Returer

Promise<void>

sendTypingIndicator()

Skicka inmatningsindikatorn i tråden.

function sendTypingIndicator(): Promise<void>

Returer

Promise<void>

setTopic(string)

Ange ämnet för tråden.

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

Parametrar

topicName

string

Returer

Promise<void>

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

Uppdatera ett meddelandeinnehåll.

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

Parametrar

messageId

string

content

string

metadata

Record<string, string>

Returer

Promise<void>