Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

RTKChat

最終更新 Markdown で表示Agent セットアップ

これはチャットモジュールです。ミーティングでのメッセージ送受信に使えます。

meeting.chat.messages

非推奨

種類: RTKChat のインスタンスプロパティ

meeting.chat.setMaxTextLimit(limit)

テキストメッセージの最大文字数を設定します。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
limit number テキストメッセージの最大文字数です。

meeting.chat.updateRateLimits(num, period)

種類: RTKChat のインスタンスメソッド

パラメーター
num number
period number

meeting.chat.sendTextMessage(message, [peerIds])

ルームへチャットのテキストメッセージを送信します。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
message string ルームへ送信するメッセージです。
[peerIds] Array.<string> メッセージの送信先ピア ID です。

meeting.chat.sendCustomMessage(message, [peerIds])

種類: RTKChat のインスタンスメソッド

パラメーター 説明
message CustomMessagePayload カスタムメッセージのペイロードです。
[peerIds] Array.<string> メッセージの送信先ピア ID です。

meeting.chat.sendImageMessage(image, [peerIds])

ミーティングへ画像メッセージを送信します。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
image File | ReactNativeFile 送信する画像です。
[peerIds] Array.<string> メッセージの送信先ピア ID です。

meeting.chat.sendFileMessage(file, [peerIds])

ミーティングへファイルを送信します。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
file File | ReactNativeFile File オブジェクトです。
[peerIds] Array.<string> メッセージの送信先ピア ID です。

meeting.chat.sendMessage(message, [participantIds])

ミーティングへメッセージを送信します。テキスト、画像、ファイルのメッセージを送れます。メッセージの種類は、message オブジェクトの type キーで決まります。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
message MessagePayload メッセージの種類と内容を含むオブジェクトです。
[participantIds] Array.<string> 参加者の userId を含む配列です。

meeting.chat.editTextMessage(messageId, message)

種類: RTKChat のインスタンスメソッド

パラメーター 説明
messageId string 編集するメッセージの ID です。
message string 更新後のテキストメッセージです。

meeting.chat.editImageMessage(messageId, image)

種類: RTKChat のインスタンスメソッド

パラメーター 説明
messageId string 編集するメッセージの ID です。
image File | ReactNativeFile 更新後の画像ファイルです。

meeting.chat.editFileMessage(messageId, file)

種類: RTKChat のインスタンスメソッド

パラメーター 説明
messageId string 編集するメッセージの ID です。
file File | ReactNativeFile 更新後のファイルです。

meeting.chat.editMessage(messageId, message)

種類: RTKChat のインスタンスメソッド

パラメーター 説明
messageId string 編集するメッセージの ID です。
message MessagePayload 更新後のメッセージペイロードです。

meeting.chat.deleteMessage(messageId)

種類: RTKChat のインスタンスメソッド

パラメーター 説明
messageId string 削除するメッセージの ID です。

meeting.chat.pin(id)

チャットメッセージをピン留めします。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
id string ピン留めするメッセージの ID です。

meeting.chat.unpin(id)

チャットメッセージのピン留めを解除します。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
id string ピン留めを解除するメッセージの ID です。

meeting.chat.fetchPublicMessages(options)

ページネーション付きで、チャットからメッセージを取得します。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
options FetchMessageOptions メッセージ取得の設定です。タイムスタンプ、件数上限、ページネーションの方向を含みます。

meeting.chat.fetchPrivateMessages(options)

現在のユーザーと別の参加者の間のプライベートメッセージを、ページネーション付きで取得します。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
options FetchPrivateMessagesOptions プライベートメッセージ取得の設定です。プライベート RTKChat ID(参加者の User ID)とページネーション設定を含みます。

meeting.chat.fetchPinnedMessages(options)

ページネーション付きで、ピン留め済みメッセージを取得します。

種類: RTKChat のインスタンスメソッド

パラメーター 説明
options FetchMessageOptions ピン留め済みメッセージ取得の設定です。タイムスタンプ、件数上限、方向を含みます。

役に立ちましたか?