これはチャットモジュールです。ミーティングでのメッセージ送受信に使えます。
- RTKChat
.messages- .setMaxTextLimit(limit)
- .updateRateLimits(num, period)
- .sendTextMessage(message, [peerIds])
- .sendCustomMessage(message, [peerIds])
- .sendImageMessage(image, [peerIds])
- .sendFileMessage(file, [peerIds])
- .sendMessage(message, [participantIds])
- .editTextMessage(messageId, message)
- .editImageMessage(messageId, image)
- .editFileMessage(messageId, file)
- .editMessage(messageId, message)
- .deleteMessage(messageId)
- .pin(id)
- .unpin(id)
- .fetchPublicMessages(options)
- .fetchPrivateMessages(options)
- .fetchPinnedMessages(options)
非推奨
種類: RTKChat のインスタンスプロパティ
テキストメッセージの最大文字数を設定します。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| limit | number |
テキストメッセージの最大文字数です。 |
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 |
|---|---|
| num | number |
| period | number |
ルームへチャットのテキストメッセージを送信します。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| message | string |
ルームへ送信するメッセージです。 |
| [peerIds] | Array.<string> |
メッセージの送信先ピア ID です。 |
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| message | CustomMessagePayload |
カスタムメッセージのペイロードです。 |
| [peerIds] | Array.<string> |
メッセージの送信先ピア ID です。 |
ミーティングへ画像メッセージを送信します。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| image | File | ReactNativeFile |
送信する画像です。 |
| [peerIds] | Array.<string> |
メッセージの送信先ピア ID です。 |
ミーティングへファイルを送信します。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| file | File | ReactNativeFile |
File オブジェクトです。 |
| [peerIds] | Array.<string> |
メッセージの送信先ピア ID です。 |
ミーティングへメッセージを送信します。テキスト、画像、ファイルのメッセージを送れます。メッセージの種類は、message オブジェクトの type キーで決まります。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| message | MessagePayload |
メッセージの種類と内容を含むオブジェクトです。 |
| [participantIds] | Array.<string> |
参加者の userId を含む配列です。 |
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| messageId | string |
編集するメッセージの ID です。 |
| message | string |
更新後のテキストメッセージです。 |
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| messageId | string |
編集するメッセージの ID です。 |
| image | File | ReactNativeFile |
更新後の画像ファイルです。 |
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| messageId | string |
編集するメッセージの ID です。 |
| file | File | ReactNativeFile |
更新後のファイルです。 |
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| messageId | string |
編集するメッセージの ID です。 |
| message | MessagePayload |
更新後のメッセージペイロードです。 |
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| messageId | string |
削除するメッセージの ID です。 |
チャットメッセージをピン留めします。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| id | string |
ピン留めするメッセージの ID です。 |
チャットメッセージのピン留めを解除します。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| id | string |
ピン留めを解除するメッセージの ID です。 |
ページネーション付きで、チャットからメッセージを取得します。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| options | FetchMessageOptions |
メッセージ取得の設定です。タイムスタンプ、件数上限、ページネーションの方向を含みます。 |
現在のユーザーと別の参加者の間のプライベートメッセージを、ページネーション付きで取得します。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| options | FetchPrivateMessagesOptions |
プライベートメッセージ取得の設定です。プライベート RTKChat ID(参加者の User ID)とページネーション設定を含みます。 |
ページネーション付きで、ピン留め済みメッセージを取得します。
種類: RTKChat のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| options | FetchMessageOptions |
ピン留め済みメッセージ取得の設定です。タイムスタンプ、件数上限、方向を含みます。 |