メッセージ¶

Hive チャット機能は、ユーザーが参加しているチャンネルにメッセージを送信するためのチャンネルメッセージ送信と、特定の個人に直接メッセージを送信するための1:1 メッセージ送信をサポートしています。

チャンネルメッセージ送信¶

ユーザーが参加したチャンネルにメッセージを送信するには、ChannelSendMessageParamsオブジェクトを作成し、それをChatクラスのsendMessage()メソッドに引数として渡します。

sendMessage()メソッドは、送信結果と送信に使用されたChannelSendMessageParamsをretryParamとして返します。
送信に失敗した場合は、retryParamsを使用して再送信を試みることができます。

チャンネル送信メッセージパラメータ¶

フィールド名	説明	タイプ	必須
channelId	メッセージを送信するチャンネルID	文字列	Y
message	チャンネルに送信するメッセージ (最大200文字)	文字列	Y
extraData	チャンネルメッセージの追加情報最大256Bバイト (UTF-8)	文字列	N

これは、ユーザーが参加したチャンネルにメッセージを送信する例のコードです。

ユニティアンリアルエンジンC++コトリンJavaスウィフトObjective-C

using hive;

ChannelSendMessageParams channelSendMessageParams = new ChannelSendMessageParams();
channelSendMessageParams.channelId = "CHANNEL_ID";
channelSendMessageParams.message = "こんにちはハイブ";
channelSendMessageParams.extraData = "EXTRA_DATA";

Chat.sendMessage(channelSendMessageParams, (ResultAPI result, ChannelSendMessageParams retryParams) => {
    if (!result.isSuccess()) {
        // メッセージの送信に失敗しました。`retryParams`を使用して再送信を試みてください

    }
});

#include "HiveChat.h"

FHiveChatChannelSendMessageParams ChannelSendMessageParams;
ChannelSendMessageParams.ChannelId = TEXT("CHANNEL_ID");
ChannelSendMessageParams.Message = TEXT("こんにちはハイブ");
ChannelSendMessageParams.ExtraData = TEXT("EXTRA_DATA");

FHiveChat::SendMessageWithChannelSendMessageParams(ChannelSendMessageParams, FHiveChatOnResultDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHiveChatChannelSendMessageParams& RetryParams) {
    if (!Result.IsSuccess) {
        // メッセージ送信に失敗しました。`RetryParams`を使用して再送信を試みてください
    }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>
  using namespace hive;

ChannelSendMessageParams params;
params.channelId = "CHANNEL_ID";
params.message = "こんにちはハイブ";
params.extraData = "EXTRA_DATA";

Chat::sendMessageWithChannelSendMessageParams(params, [=](ResultAPI const & result, ChannelSendMessageParams const & retryParams) {
    if (!result.isSuccess()) {
        // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください。
    }
});

import com.hive.Chat;
import com.hive.ResultAPI;

val params = Chat.ChannelSendMessageParams(
    channelId = "CHANNEL_ID",
    message = "こんにちはハイブ",
    extraData = "EXTRA_DATA"
)
Chat.sendMessage(params, object: Chat.SendMessageListener {
    override fun onResult(
        result: ResultAPI,
        retryParams: Chat.ChannelSendMessageParams?
    ) {
        if (!result.isSuccess) {
            // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください
        }
    }
})

import com.hive.Chat;

Chat.ChannelSendMessageParams params = new Chat.ChannelSendMessageParams(
    "CHANNEL_ID",
    "こんにちはハイブ",
    "EXTRA_DATA"
);

Chat.sendMessage(params, (result, retryParams) -> {
    if(!result.isSuccess()) {
        // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください
    }
});

import HIVEService

let params = HiveChatParams.ChannelSendMessageParams(
    channelId = "CHANNEL_ID",
    message = "こんにちはハイブ",
    extraData = "EXTRA_DATA"
)
ChatInterface.sendMessage(params) { result, retryParams in
    if !result.isSuccess {
        // メッセージ送信に失敗しました。`retryParams`を使って再送信を試みてください。
    }
}

#import "HIVEService.h"

HiveChatChannelSendMessageParams* sendMessageParams = [[HiveChatChannelSendMessageParams alloc] init];
sendMessageParams.channelId = "CHANNEL_ID";
sendMessageParams.message = "こんにちはハイブ";
sendMessageParams.extraData = "EXTRA_DATA";

[HiveChat sendMessageWithChannelSendMessageParams:sendMessageParams handler:^(HIVEResultAPI * result, HiveChatChannelSendMessageParams * retryParams) {
    if (!result.isSuccess) {
        // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください
    }
}];

チャンネルメッセージイベント管理¶

送信されたメッセージは、addChannelListenerイベントのonChannelMessageイベントハンドラーによって受信されます。イベント処理の詳細については、イベント管理 > チャンネルイベントドキュメントを参照してください。

1:1 メッセージ送信¶

特定の受信者にダイレクトメッセージを送信するには、ユーザーはDirectSendMessageParamsオブジェクトを作成し、それをChatクラスのsendMessage()メソッドに引数として渡します。

sendMessage() メソッドは、送信結果と送信中に使用された DirectSendMessageParams を retryParam という名前で返します。送信が失敗した場合は、retryParams を使用して再送信を試みることができます。

ダイレクト送信メッセージパラメータ¶

フィールド名	説明	タイプ	必須
toPlayerId	Hive のターゲットユーザーのプレイヤーID	long	Y
message	ターゲットユーザーに送信されるメッセージ (最大200文字)	string	Y
extraData	1:1メッセージのための追加情報最大256Bバイト (UTF-8標準)	string	N

以下は、ユーザーが特定の受信者にダイレクトメッセージを送信するための例コードです。

UnityアンリアルエンジンC++コトリンジャバスウィフトオブジェクティブ-C

using hive;

DirectSendMessageParams directSendMessageParams = new DirectSendMessageParams();
directSendMessageParams.toPlayerId = 12345678;
directSendMessageParams.message = "こんにちはハイブ";
directSendMessageParams.extraData = "EXTRA_DATA";

Chat.sendMessage(directSendMessageParams, (ResultAPI result, DirectSendMessageParams retryParams) => {
    if (!result.isSuccess()) {
        // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください

    }
});

#include "HiveChat.h"

FHiveChatDirectSendMessageParams DirectSendMessageParams = FHiveChatDirectSendMessageParams();
DirectSendMessageParams.ToPlayerId = 12345678l;
DirectSendMessageParams.Message = TEXT("こんにちはハイブ");
DirectSendMessageParams.ExtraData = TEXT("EXTRA_DATA");

FHiveChat::SendMessageWithDirectSendMessageParams(DirectSendMessageParams, FHiveChatOnResultDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHiveChatDirectSendMessageParams& RetryParams) {
    if (!Result.IsSuccess) {
        // メッセージ送信に失敗しました。`RetryParams`を使用して再送信を試みてください。
    }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;

DirectSendMessageParams params;
params.toPlayerId = 12345678;
params.message = "Hello Hive";
params.extraData = "EXTRA_DATA";

Chat::sendMessageWithDirectSendMessageParams(params, [=](ResultAPI const & result, DirectSendMessageParams const & retryParams) {
    if (!result.isSuccess()) {
        // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください。
    }
});

import com.hive.Chat;
import com.hive.ResultAPI;

val params = Chat.DirectSendMessageParams(
    toPlayerId = 12345678,
    message = "こんにちはハイブ",
    extraData = "EXTRA_DATA"
)

Chat.sendMessage(params, object: Chat.SendMessageListener {
    override fun onResult(
        result: ResultAPI,
        retryParams: Chat.DirectSendMessageParams?
    ) {
        if (!result.isSuccess) {
            // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください。
        }
    }
})

import com.hive.Chat;

Chat.DirectSendMessageParams params = new Chat.DirectSendMessageParams(
        12345678,
        "Hello Hive",
        "EXTRA_DATA"
);

Chat.sendMessage(params, (result, retryParams) -> {
    if(!result.isSuccess()) {
        // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください。
    }
});

import HIVEService

let params = HiveChatParams.DirectSendMessageParams(toPlayerId: Int64(12345678), message: "Hello Hive", extraData: "EXTRA_DATA")

ChatInterface.sendMessage(sendMessageParams: params) { result, retryParams in
    if !result.isSuccess {
        // メッセージ送信に失敗しました。`retryParams`を使用して再送信を試みてください。
    }
}

#import "HIVEService.h"

HiveChatDirectSendMessageParams* sendMessageParams = [[HiveChatDirectSendMessageParams alloc] init];
sendMessageParams.toPlayerId = 12345678;
sendMessageParams.message = "こんにちはハイブ";
sendMessageParams.extraData = "EXTRA_DATA";

[HiveChat sendDirectMessageWithSendMessageParams:sendMessageParams handler:^(HIVEResultAPI * result, HiveChatDirectSendMessageParams * retryParams) {
    if (!result.isSuccess) {
        // メッセージの送信に失敗しました。`retryParams`を使用して再送信を試みてください
    }
}];

1:1 メッセージイベント管理¶

1:1メッセージ送信を通じて送信されたメッセージは、addUserListenerイベントのonDirectMessageイベントハンドラーを介して受信できます。イベント処理の詳細については、イベント管理 > ユーザーイベントドキュメントを参照してください。

メッセージ翻訳リクエスト¶

メッセージの翻訳をリクエストしようとしています。言語コードはISO 639 alpha-2標準に基づいています。

翻訳パラメータ¶

フィールド名	説明	タイプ	必須
message	メッセージ	文字列	Y
sourceLanguage	メッセージの言語コード。省略された場合は`auto`として推測されます。	文字列	N
targetLanguages	翻訳リクエストのための言語コードの配列	文字列配列	Y

ユニティアンリアルエンジンC++コトリンJavaスウィフトオブジェクティブ-C

using hive;

List<String> targetLanguages = new List<String>();
targetLanguages.Add("ko");
targetLanguages.Add("ja");
targetLanguages.Add("ar");

TranslateParams translateParams = new TranslateParams("hello", "auto", targetLanguages);

Chat.translate(translateParams, (ResultAPI result, TranslationData data) => {
    if (result.isSuccess() && data != null) {
        // data is translate languages
    }
});

#include "HiveChat.h"

TArray<FString> TargetLanguages;
TargetLanguages.Add(TEXT("ko"));
TargetLanguages.Add(TEXT("ja"));
TargetLanguages.Add(TEXT("ar"));

FHiveChatTranslateParams TranslateParams = FHiveChatTranslateParams(TEXT("こんにちは"), TEXT("auto"), TargetLanguages);

FHiveChat::Translate(TranslateParams, FHiveChatOnResultDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHiveChatTranslationData& data) {
    if (Result.ISSuccess && data != null) {
        // dataは翻訳された言語メッセージです
    }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;

std::vector<std::string> targetLanguages = { "ko", "ja", "ar" };

Chat::TranslateParams translateParams = new Chat::TranslateParams("こんにちは", "auto", targetLanguages);

Chat::translate(translateParams, [=](ResultAPI const & result, Chat::TranslationData const & data) {
    if (!result.isSuccess() && data != null ) {
        // data is translate language messages
    }
});

import com.hive.Chat;
import com.hive.ResultAPI;

var translateParams = Chat.TranslateParams(
    message = "hello",
    sourceLanguage = "auto",
    targetLanguages = ["ko", "ja", "ar"]
)

Chat.translate(translateParams, object: Chat.TranslateParamsListener {
    override fun onResult(
        result: ResultAPI,
        data: Chat.TranslationData?
    ) {
        if (!result.isSuccess && data != null) {
            // dataは翻訳された言語のメッセージです
        } 
    }
})

import com.hive.Chat;

Chat.TranslateParams translateParams = new Chat.TranslateParams(
    "hello",
    "auto",
    ["ko", "ja", "ar"]
);

Chat.translate(translateParams, (result, data) -> {
    if(result.isSuccess() && data != null) {
        // data is translate language messages
    }
});

import HIVEService

let translateParams = HiveChatParams.TranslateParams("こんにちは", "auto", ["ko", "ja", "ar"])
ChatInterface.translate(params: translateParams) { result, data in
    if result.isSuccess(), let data {
        // data is translate language messages
    }
}

#import "HIVEService.h"

NSArray<NSString *> *targetLanguages = @[@"ko", @"ja", @"ar"];
HiveChatTranslateParams translateParams = [[HiveChatTranslateParams alloc] message: @"hello"
                                                                           sourceLanguage: @"auto"
                                                                           targetLanguages: targetLanguages];


[HiveChat translateWithParams: translateParams
          handler:^(HIVEResultAPI * result, HiveChatTranslationData * data) {
            if (result.isSuccess && data) {
                // dataは翻訳された言語メッセージです
            }
          }];