PartyLocalChatControl::SendText

将聊天文本字符串传输到每个指定的目标聊天控件。

语法

PartyError SendText(  
    uint32_t targetChatControlCount,  
    PartyChatControlArray targetChatControls,  
    PartyString chatText,  
    uint32_t dataBufferCount,  
    const PartyDataBuffer* dataBuffers  
)  

参数

targetChatControlCount uint32_t

targetChatControls 数组中的目标聊天控件数量。

targetChatControls PartyChatControlArray
大小的输入数组targetChatControlCount

目标 PartyChatControls 的 targetChatControlCount 条目数组。

chatText PartyString

要发送的文本。

dataBufferCount uint32_t

dataBuffers 数组中提供的缓冲区结构数量。

dataBuffers PartyDataBuffer*
大小的输入数组dataBufferCount

PartyDataBuffer 结构的 dataBufferCount 条目数组,描述要发送的辅助消息有效负载。 如果 dataBufferCount 为零,此项将被忽略。

返回值

PartyError

如果调用成功,则为 c_partyErrorSuccess,否则为错误代码。 可通过 PartyManager::GetErrorMessage() 检索错误代码的可读形式。

备注

目前不支持将聊天文本发送到本地聊天控件。 如果目标聊天控件的数组包含任何本地目标,则此调用将同步失败。

不能保证对文本内容进行翻译、本地化或冒犯性语言过滤;聊天文本字符串将按文本原样生成。

文本字符串将仅传递到已将其实例配置为通过 PartyLocalChatControl::SetPermissions()从本地聊天控件接收短信的目标聊天控件。

如果目标聊天控件未连接到至少一个与源聊天控件共用的网络,则不会传递文本字符串。 如果有两个本地聊天控件,则可以执行此操作。 连接到本地聊天控件之一的目标聊天控件可能未连接到所有其他本地聊天控件。

dataBuffers数组中的 PartyDataBuffer 结构用于与聊天文本关联的辅助数据,例如指示渲染文本应使用颜色的元数据,或用来将图标与聊天文本一起渲染的包含图像数据的二进制 Blob。 有关发送与文本聊天无关的游戏数据,请参阅 PartyLocalEndpoint::SendMessage(),此消息传递选项可对消息传输行为进行更精细的控制。

调用方在 dataBuffers 数组中提供 0 个或多个 PartyDataBuffer 结构。 结构引用的内存不必是连续的,例如,可以轻松地使用固定标头缓冲区和变量有效负载。 缓冲区将按顺序组装、传输并作为 PartyEndpointMessageReceivedStateChange 中的单个连续数据块(独立于聊天文本)传送到目标聊天控件。 Party 库不会使用带宽传输元数据来描述原始 PartyDataBuffer 分段。

要求

标题: Party.h

另请参阅

PartyLocalChatControl
PartyChatTextReceivedStateChange