チャンネル¶
チャンネル作成¶
新しい会話チャンネルを作成するには、CreateChannelParamsオブジェクトを作成し、次にChatクラスのcreateChannel()メソッドを呼び出します。
チャンネルパラメータを作成する¶
| フィールド名 | 説明 | 型 | 必須 |
|---|---|---|---|
| channelId | チャンネルID (英字、数字、一部の特殊文字( -, ., _, ~, :)が許可され、最大100文字) | 文字列 | Y |
| password | パスワード(PRIVATE チャンネルの場合のみ必要)(最大50文字) | 文字列 | N |
| channelName | チャンネル名 (最大50文字) | 文字列 | Y |
| maxMemberCount | チャンネル参加者の最大数 (最小2から最大5,000) | 整数 | Y |
| type | チャンネルタイプ(PRIVATE, PUBLIC, GROUP) | 列挙 | Y |
| chatHistoryAllowed | チャット履歴の取得が許可されているかどうか | 列挙 | N |
新しい会話チャンネルを作成するためのコードの例です。
using hive;
CreateChannelParams createChannelParams = new CreateChannelParams();
createChannelParams.channelId = "CHANNEL_ID";
createChannelParams.password = "";
createChannelParams.channelName = "CHANNEL_NAME";
createChannelParams.maxMemberCount = 8;
createChannelParams.type = ChannelType.PUBLIC;
Chat.createChannel(createChannelParams, (ResultAPI result) => {
if (result.isSuccess()) {
// API Call Success
}
});
#include "HiveChat.h"
FHiveCreateChannelParams CreateChannelParams = FHiveCreateChannelParams();
CreateChannelParams.ChannelId = TEXT("CHANNEL_ID");
CreateChannelParams.Password = TEXT("");
CreateChannelParams.ChannelName = TEXT("CHANNEL_NAME");
CreateChannelParams.MaxMemberCount = 8;
CreateChannelParams.Type = EHiveChannelType::Public;
FHiveChat::CreateChannel(CreateChannelParams, FHiveChatOnResultDelegate::CreateLambda([this](const FHiveResultAPI& Result) {
if (Result.IsSuccess()) {
// API Call Success
}
});
#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;
CreateChannelParams param;
param.channelId = "CHANNEL_ID";
param.channelName = "CHANNEL_NAME";
param.password = "";
param.maxMemberCount = 8;
param.type = ChannelType::PUBLIC;
Chat::createChannel(param, [=](ResultAPI const & result) {
if (result.isSuccess()) {
// API Call Success
}
});
import com.hive.Chat;
import com.hive.ResultAPI;
val params = Chat.CreateChannelParams(
channelId = "CHANNEL_ID",
password = "",
channelName = "CHANNEL_NAME",
maxMemberCount = 8,
type = Chat.ChannelType.PUBLIC
)
Chat.createChannel(params, object: Chat.CreateChannelListener{
override fun onResult(result: ResultAPI) {
if (result.isSuccess) {
// API Call Success
}
}
})
#import "HIVEService.h"
HiveChatCreateChannelParams* params = [[HiveChatCreateChannelParams alloc] init];
params.channelId = @"CHANNEL_ID";
params.password = @"";
params.channelName = @"CHANNEL_NAME";
params.maxMemberCount = 8;
params.type = HiveChatChannelTypePublicChannel;
[HiveChat createChannelWithCreateParams:params handler:^(HIVEResultAPI * result) {
if (result.isSuccess) {
// API Call Success
}
}];
チャンネル削除¶
既存の会話チャンネルを削除するには、ChatクラスのdeleteChannel()メソッドを呼び出します。
会話チャンネルを削除するための例のコードです。
チャンネルエントリー¶
既存の会話チャンネルに入るには、EnterChannelParamsオブジェクトを作成し、次にChatクラスのenterChannel()メソッドを呼び出します。
チャンネルパラメータを入力¶
| フィールド名 | 説明 | タイプ | 必須 |
|---|---|---|---|
| channelId | チャンネルID | 文字列 | Y |
| password | パスワード(PRIVATE チャンネルに必要) | 文字列 | N |
会話チャンネルに入るための例のコードです。
#include "HiveChat.h"
FHiveEnterChannelParams EnterChannelParams = FHiveEnterChannelParams();
EnterChannelParams.ChannelId = TEXT("CHANNEL_ID");
EnterChannelParams.Password = TEXT("");
FHiveChat::EnterChannel(EnterChannelParams, FHiveChatOnResultDelegate::CreateLambda([this](const FHiveResultAPI& Result) {
if (Result.IsSuccess()) {
// API Call Success
}
}));
チャンネルの終了¶
参加していたチャットチャンネルを退出するには、ChatクラスのexitChannel()メソッドを呼び出してください。
これは、参加した会話チャンネルから退出するためのサンプルコードです。
すべてのチャンネルリストを見る¶
現在存在するすべてのチャンネルのリストを取得するには、GetChannelsParamsオブジェクトを作成し、次にChatクラスのgetChannels()メソッドを呼び出します。
Note
GetChannelsParamsオブジェクトを渡さない場合(オブジェクトが提供されていない場合はnullを渡す)、フィルタリングなしで現在存在するチャンネルの全リストが返されます。
チャンネルパラメータを取得する¶
| フィールド名 | 説明 | 型 | 必須 |
|---|---|---|---|
| type | チャンネルタイプ(PRIVATE, PUBLIC, GROUP) | enum | Y |
| channelId | 特定のチャンネルIDで始まるチャンネルを取得 | string | N |
| channelName | 特定のチャンネル名を含むチャンネルを取得 | string | N |
| sort | チャンネルのソート基準(ChannelId, ChannelName, RegTime) | enum | N |
| pageOrder | ソート方法(ASC, DESC)(デフォルトは DESC) | string | N |
| pageSize | ページごとに取得するチャンネルの数 (最小1〜最大10、デフォルト10) | integer | N |
| pageNumber | 取得するページ番号 (1から開始、デフォルトは1) | integer | N |
ChannelオブジェクトとChannelPageオブジェクトがレスポンスとして提供され、その構造は以下の通りです。
チャンネル¶
| フィールド名 | 説明 | タイプ |
|---|---|---|
| channelId | チャンネルID | string |
| type | チャンネルタイプ (PRIVATE, PUBLIC, GROUP) | enum |
| owner | チャンネル所有者の Hive PlayerID | string |
| channelName | チャンネル名 | string |
| memberCount | 現在の参加メンバー数 | integer |
| maxMemberCount | チャンネルの最大参加者数 | integer |
| regTime | チャンネル作成日時(UTC+0に基づく、フォーマットyyyy-MM-dd'T'HH:mm:ss.SSSZ) | string |
| regTimeMillis | チャンネル作成日時(Unixタイムスタンプ) | long |
| chatHistoryAllowed | チャンネル履歴の取得が許可されているかどうか | bool |
| query | チャンネルメッセージ履歴を取得するためのメソッド | method |
チャンネルページ¶
| フィールド名 | 説明 | タイプ |
|---|---|---|
| size | ページあたりのアイテム数 | 整数 |
| currentPage | 現在のページ番号 | 整数 |
| totalElements | アイテムの総数 | 整数 |
| totalPages | ページの総数 | 整数 |
以下は、すべての既存のPUBLICタイプのチャンネルのリストを取得するための例コードです。
using hive;
GetChannelsParams getChannelsParams = new GetChannelsParams();
getChannelsParams.type = ChannelType.PUBLIC;
Chat.getChannels(getChannelsParams, (ResultAPI result, List<Channel> channels, ChannelPage channelPage) => {
if (result.isSuccess()) {
// API Call Success
foreach (Channel channel in channels) {
// Retrieve Channel
}
if (channelPage != null) {
// Retrieve ChannelPage
}
}
});
#include "HiveChat.h"
TOptional<FHiveGetChannelsParams> GetChannelsParams = FHiveGetChannelsParams();
GetChannelsParams->Type = EHiveChannelType::Public;
FHiveChat::GetChannels(GetChannelsParams, FHiveChatOnGetChannelsDelegate::CreateLambda([this](const FHiveResultAPI& Result, const TArray<FHiveChannel>& channels, FHiveChannelPage const & channelPage) {
if (Result.IsSuccess()) {
// API Call Success
for (const FHiveChannel& Channel : Channels) {
// Retrieve Channel
}
if (ChannelPage != nullptr) {
// Retrieve ChannelPage
}
}
}));
#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;
Chat::GetChannelsParams params = Chat::GetChannelsParams();
params.type = Chat::ChannelType::PUBLIC;
Chat::getChannels(param, [=](ResultAPI const & result, std::vector<Channel> const & channels, ChannelPage const & pageInfo) {
if (result.isSuccess()) {
// API コール成功
for (Chat::Channel channel : channels) {
// Retrieve Channel
}
if (channelPage != null) {
// Retrieve ChannelPage
}
}
});
import com.hive.Chat;
import com.hive.ResultAPI;
val params = Chat.GetChannelsParams(type = Chat.ChannelType.PUBLIC)
Chat.getChannels(params, object: Chat.GetChannelsListener{
override fun onResult(
result: ResultAPI,
channels: ArrayList<Chat.Channel>,
channelPage: Chat.ChannelPage?
) {
if (result.isSuccess) {
// API呼び出し成功
channels.forEach {
// チャンネルを取得
}
channelPage?.let {
// ChannelPageを取得
}
}
}
})
import com.hive.Chat;
Chat.GetChannelsParams params = new Chat.GetChannelsParams(Chat.ChannelType.PUBLIC, null, null, null, null, null);
Chat.getChannels(params, (result, channels, channelPage) -> {
if (result.isSuccess()) {
// API Call Success
for (Chat.Channel channel : channels) {
// Retrieve Channel
}
if (channelPage != null) {
// Retrieve ChannelPage
}
}
});
#import "HIVEService.h"
HiveChatGetChannelsParams* params = [[HiveChatGetChannelsParams alloc] init];
params.type = Chat::ChannelType::PUBLIC;
[HiveChat getChannelsWithGetChannelsParams:params handler:^(HIVEResultAPI * result, NSArray<HiveChatChannelContent *> * channels, HiveChatPageInfo * pageInfo) {
if (result.isSuccess) {
// APIコール成功
for (Chat::Channel *channel : channels) {
// チャンネルを取得
}
if (channelPage != null) {
// Retrieve ChannelPage
}
}
}];
チャンネル情報の取得¶
特定のチャンネルに関する詳細情報を取得するには、ChatクラスのgetChannelInfo()メソッドを呼び出します。
レスポンスにはChannelオブジェクトとMemberオブジェクトが含まれており、構造は以下の通りです。
チャンネル¶
| フィールド名 | 説明 | タイプ |
|---|---|---|
| channelId | チャンネルID | string |
| type | チャンネルタイプ(PRIVATE, PUBLIC, GROUP) | enum |
| owner | チャンネル所有者のHive PlayerID | string |
| channelName | チャンネル名 | string |
| memberCount | 現在の参加メンバー数 | integer |
| maxMemberCount | チャンネル参加者の最大数 | integer |
| regTime | チャンネル作成日時(UTC+0に基づく、フォーマットyyyy-MM-dd'T'HH:mm:ss.SSSZ) | string |
| regTimeMillis | チャンネル作成日時(Unixタイムスタンプ) | long |
| chatHistoryAllowed | チャンネル履歴がクエリ可能かどうか | bool |
| query | チャンネルメッセージ履歴をクエリするためのメソッド | method |
メンバー¶
| フィールド名 | 説明 | タイプ |
|---|---|---|
| playerId | Hive プレイヤーID | long |
| connectedTime | 接続時間(UTC+0に基づく、フォーマットyyyy-MM-dd'T'HH:mm:ss.SSSZ) | string |
| connectedTimeeMillis | 接続時間(Unix タイムスタンプ) | long |
特定のチャンネルに関する詳細情報を取得するための例コードは以下の通りです。
#include "HiveChat.h"
FString ChannelId = TEXT("CHANNEL_ID");
FHiveChat::GetChannelInfo(ChannelId, FHiveChatOnGetChannelInfoDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHiveChannel& channel, const TArray<FHiveMember>& members) {
if (Result.IsSuccess()) {
// API Call Success
if (channel != nullptr) {
// チャンネルを取得
}
for (const FHiveMember& Member : Members) {
// Retrieve Member
}
}
}));
#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;
std::string channelId = "CHANNEL_ID";
Chat::getChannelInfo(channelId, [=](ResultAPI const & result, Channel const & channel, std::vector<Member> const & members) {
if (result.isSuccess()) {
if (channel != null) {
// チャンネルを取得する
}
for (Chat::Member member : members) {
// Retrieve Member
}
}
});
import com.hive.Chat;
import com.hive.ResultAPI;
val channelId = "CHANNEL_ID"
Chat.getChannelInfo(channelId, object: Chat.GetChannelInfoListener {
override fun onResult(
result: ResultAPI,
channel: Chat.Channel?,
members: ArrayList<Chat.Member>
) {
if (result.isSuccess) {
channel?.let {
// Retrieve Channel
}
members.forEach {
// Retrieve Member
}
}
}
})
#import "HIVEService.h"
NSString *channelId = @"CHANNEL_ID";
[HiveChat getChannelInfoWithChannelId:channelId handler:^(HIVEResultAPI * result, HiveChatChannelContent * channel, NSArray<HiveChatMember *> * members) {
if (result.isSuccess) {
if (channel != null) {
// チャンネルを取得
}
for (Chat::Member *member : members) {
// メンバーを取得
}
}
}];
チャンネルメンバーの問い合わせ¶
チャンネル参加者メンバーを表示するには、ChatクラスのgetChannelMembers()メソッドを呼び出します。
Note
レスポンス値は、getChannelInfo()から渡されたMemberオブジェクトと同じです。
#include "HiveChat.h"
FString ChannelId = TEXT("CHANNEL_ID");
FHiveChat::GetChannelMembers(ChannelId, FHiveChatOnGetChannelMembersDelegate::CreateLambda([this](const FHiveResultAPI& Result, const TArray<FHiveMember>& members) {
if (Result.IsSuccess()) {
for (const FHiveMember& Member : members) {
// Retrieve Member
}
}
}));
チャンネルメッセージ履歴照会¶
channel.query(ChannelMessageListQueryParams, ChannelMessageListQueryListener) メソッドを呼び出して、以前のチャット履歴を取得します。
chatHistoryAllowed プロパティが true に設定されているチャンネルのみが履歴を取得できます。
チャンネルメッセージリストクエリパラメータ¶
| フィールド名 | 説明 | 型 | 必須 |
|---|---|---|---|
| prevSize | 取得する前のメッセージの数 (最小 0 ~ 最大 50, デフォルト 0) | 整数 | N |
| nextSize | 取得する次のメッセージの数 (最小 0 ~ 最大 50, デフォルト 0) | 整数 | N |
| messageId | このメッセージIDに基づいてメッセージを取得します。nullの場合、最新のメッセージから取得します。 | 文字列 | N |
| sort | デフォルトのソートは日付の降順です。クエリの方向に応じてソート方向を変更できます(DESCまたはASC、デフォルトはDESC)。 | 文字列 | N |
チャンネルメッセージリストクエリレスポンス¶
| フィールド名 | 説明 | 型 |
|---|---|---|
| hasNext | 現在のセットの後に取得するメッセージがあるかどうか | boolean |
| nextMessageId | 追加のメッセージを取得するための参照として使用するメッセージID | string |
| hasPrev | 現在のセットの前に取得するメッセージがあるかどうか | boolean |
| prevMessageId | 追加のメッセージを取得するための参照として使用するメッセージID | string |
| content | 取得したメッセージのリスト | list<ChannelMessage> |
using hive;
ChannelMessageListQueryParams queryParams = new ChannelMessageListQueryParams();
queryParams.prevSize = 10;
queryParams.nextSize = 10;
queryParams.messageId = "TARGET_MESSAGE_ID";
channel.query(queryParams, (ResultAPI result, ChannelMessageListQueryResponse response) => {
if (result.isSuccess() && response != null) {
foreach (ChannelMessage message in response.content) {
// channel message list
}
}
});
#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace hive;
ChannelMessageListQueryParams queryParams;
queryParams.prevSize = 10;
queryParams.nextSize = 10;
queryParams.messageId = "TARGET_MESSAGE_ID";
channel.query(queryParams, [=](ResultAPI const & result, ChannelMessageListQueryResponse const & response) {
if (result.isSuccess()) {
for (auto message : response.message) {
// channel message list
}
}
});
import com.hive.Chat;
import com.hive.ResultAPI;
val queryParams = Chat.ChannelMessageListQueryParams(
prevSize = 10,
nextSize = 10,
messageId = "TARGET_MESSAGE_ID"
)
channel.query(queryParams, object : Chat.ChannelMessageListQueryListener {
override fun onResult(
result: ResultAPI,
response: Chat.ChannelMessageListQueryResponse?
) {
if(result.isSuccess && response != null) {
response.content.forEach {
// channel message list
}
}
}
})
import com.hive.Chat;
Chat.ChannelMessageListQueryParams queryParams = new Chat.ChannelMessageListQueryParams();
queryParams.prevSize = 10;
queryParams.nextSize = 10;
queryParams.messageId = "TARGET_MESSAGE_ID";
channel.query(queryParams, (result, response) -> {
if (result.isSuccess() && response != null) {
for (HiveChatChannelMessage message : response.getContent()) {
// channel message list
}
}
});
import HIVEService
let queryParams = HiveChatParams.ChannelMessageListQueryParams(prevSize: 10, nextSize: 10, messageId: "TARGET_MESSAGE_ID")
channel.query(queryParams) { result, response in
if result.isSuccess(),
let contents = response.content {
for (let message in contents) {
// channel message list
}
}
}
#import "HIVEService.h"
HiveChatChannelMessageListQueryParams* queryParams = [HiveChatChannelMessageListQueryParams new];
queryParams.prevSize = 10;
queryParams.nextSize = 10;
queryParams.messageId = @"TARGET_MESSAGE_ID";
[channel queryWithParams:queryParams listener:^(HIVEResultAPI * result, HiveChatChannelMessageListQueryResponse* response) {
if (result.isSuccess() && response.content) {
for (HiveChatChannelMessage *message in response.content) {
// channel message list
}
}
}];
チャンネル自動翻訳受信設定¶
このチャンネルからのメッセージの自動翻訳を受け取るかどうかを設定できます。
翻訳されたメッセージは、受信したChannelMessageオブジェクトで確認できます。
チャンネルイベント管理¶
Hive チャットソケットサーバーは接続状況を検出し、アプリユーザーとチャンネル間で発生するステータス変更イベントをアプリに継続的に配信します。詳細なイベント処理方法については、イベント管理 > チャンネルイベント ドキュメントを参照してください。