チャンネルメッセージ
Send, receive and manage text messages in Vivox channels.
読み終わるまでの所要時間 2 分最終更新 7ヶ月前
TextOnly または TextAndAudio の ChatCapability を使用して、テキストが有効になっている特定の Vivox チャンネルに VivoxMessage を送信できます。
チャンネルメッセージを送信する
VivoxService.Instance.SendChannelTextMessageAsync(string channelName, string message)channelNamemessage以下のコードスニペットは、設定された Lobby チャンネルにメッセージを送信し、MessageInputField InputField オブジェクトからテキストをプルするための実装例です。
public async void SendMessageAsync(){ if (string.IsNullOrEmpty(MessageInputField.text)) { return; } VivoxService.Instance.SendChannelTextMessageAsync(LobbyChannelName, MessageInputField.text); MessageInputField.text = string.Empty;}
チャンネルメッセージを受信する
テキストが有効になっているチャンネルからメッセージを受信するには、 アクションにサブスクライブする必要があります。
VivoxService.Instance.ChannelMessageReceivedチャンネルに送信される VivoxMessage は 直接送信メッセージ とほぼ同じですが、 に ChannelName が追加され、メッセージが現在サインインしているユーザーから送信されたかどうかに基づいて フィールドが設定されます。
VivoxMessage.ChannelNameVivoxMessage.FromSelf以下のコードスニペットは、このアクションにサブスクライブする行の例と、受信時に VivoxMessage から利用可能なすべての情報をプルする例です。
//Subscribe to this event at some point in the Vivox initialization process,//preferably before joining any channels.. . .VivoxService.Instance.ChannelMessageReceived += OnChannelMessageReceived;. . .void OnChannelMessageReceived(VivoxMessage message){ var channelName = message.ChannelName; var senderName = message.SenderDisplayName; var senderId = message.SenderPlayerId; var messageText = message.MessageText; var timeReceived = message.ReceivedTime; var language = message.Language; var fromSelf = message.FromSelf; var messageId = message.MessageId;}
チャンネルテキストメッセージの履歴
Vivox では、 を使用して、ユーザーがチャンネルのテキストアクティビティの履歴にアクセスできるようにします。 は履歴をリクエストするチャンネルの名前、 は返すメッセージの最大数 (デフォルトは 10) で、 はメッセージに含まれる単語やフレーズ、特定の PlayerId のメッセージ送信者、クエリの対象とする時刻 (その時刻の前または後) の指定などができる任意のパラメーターです。 のより具体的な情報については、チャット履歴のクエリオプション を参照してください。
VivoxService.Instance.GetChannelTextMessageHistoryAsync(string channelName, int requestSize = 10, ChatHistoryQueryOptions chatHistoryQueryOptions = null)channelNamerequestSizechatHistoryQueryOptionsChatHistoryQueryOptionIReadOnlyCollection注
チャット履歴は 7 日間保存されます。テキストエビデンス管理 が使用される場合、チャット履歴の保存期間が 30 日間に延長されます。
以下のコードスニペットは、設定された LobbyChannelName から最新の 25 件のメッセージをプルし、任意の ChatHistoryQueryOptions は使用せずに、送信者の表示名とメッセージを古いものから新しいものへの順でログ記録する例です。
public async void FetchHistoryAsync(){ var historyMessages = await VivoxService.Instance.GetChannelTextMessageHistoryAsync(LobbyChannelName, 10); //Reversing the messages so they display from oldest to newest var reversedMessages = historyMessages.Reverse(); foreach(VivoxMessage message in reversedMessages) { Debug.Log($"{message.SenderDisplayName}: {message.MessageText}"); }}
チャンネルメッセージを編集する
Vivox では、 を使用して、ユーザーがチャンネルに送信したメッセージのテキストを編集できるようにします。channelName はメッセージが送信されたチャンネルの名前、messageId は変更するメッセージの ID、newMessage はメッセージの更新後のテキストです。
VivoxService.Instance.EditChannelTextMessageAsync(string channelName, string messageId, string newMessage)チャンネル内の誰かによってメッセージが正常に編集されると、チャンネル内のすべてのユーザーは、編集された VivoxMessage と更新後の MessageText を含む アクションを受信します。
VivoxService.Instance.ChannelMessageEditedpublic async void UpdateChannelMessageAsync(VivoxMessage messageToUpdate, string updatedMessageText){ await VivoxService.Instance.EditChannelTextMessageAsync(messageToUpdate.ChannelName, messageToUpdate.MessageId, updatedMessageText);}
チャンネルメッセージを削除する
Vivox では、 を使用して、ユーザーがチャンネルに送信したメッセージのテキストを削除できるようにします。channelName はメッセージが送信されたチャンネルの名前、messageId は削除するメッセージの ID です。
VivoxService.Instance.DeleteChannelTextMessageAsync(string channelName, string messageId)チャンネル内の誰かによってメッセージが正常に削除されると、チャンネル内のすべてのユーザーは、削除された VivoxMessage を含む アクションを受信します。
VivoxService.Instance.ChannelMessageDeletedpublic async void DeleteChannelMessageAsync(VivoxMessage messageToDelete){ await VivoxService.Instance.DeleteChannelTextMessageAsync(messageToDelete.ChannelName, messageToDelete.MessageId)}