class RoomManagementService
(Niantic.Lightship.SharedAR.Rooms.RoomManagementService)
概要
RoomManagementServiceは、ルーム管理サービスのバックエンドにアクセスし、Roomsを作成、削除、検索するためのインターフェイスを提供します。 ルームとは、サーバーを中継したネットワークで複数のピア同士を接続するためのエンティティのことです。
class RoomManagementService {
public：
struct GetOrCreateRoomAsyncTaskResult;
// メソッド
static RoomManagementServiceStatus CreateRoom(
RoomParams roomParams,
out IRoom outRoom
);
static RoomManagementServiceStatus DeleteRoom(string roomId)；
static RoomManagementServiceStatus GetRoom(string roomId, out IRoom outRoom);
static RoomManagementServiceStatus QueryRoomsByName(
string name,
out List<IRoom> rooms
);
static RoomManagementServiceStatus GetAllRooms(out List<IRoom> rooms)；
static RoomManagementServiceStatus GetOrCreateRoomForName(
RoomParams roomParams,
out IRoom outRoom
);
static void GetOrCreateRoomAsync(
string roomName,
string roomDesc,
uint roomCapacity,
GetOrCreateRoomCallback doneCb
)；
static async Task<GetOrCreateRoomAsyncTaskResult> GetOrCreateRoomAsync(
string roomName,
string roomDescription,
uint roomCapacity
);
delegate void GetOrCreateRoomCallback(
RoomManagementServiceStatus status,
string room_id
);
}；
詳細なドキュメント
RoomManagementServiceは、ルーム管理サービスのバックエンドにアクセスし、Roomsを作成、削除、検索するためのインターフェイスを提供します。 ルームとは、サーバーを中継したネットワークで複数のピア同士を接続するためのエンティティのことです。
メソッド
CreateRoom
static RoomManagementServiceStatus CreateRoom(
RoomParams roomParams,
out IRoom outRoom
)
サーバーに新しいルームを作 る。
パラメーター:
roomParams - ルームのパラメーター
outRoom - IRoom オブジェクトとして作成されたルーム。 作成に失敗した場合は null。
戻り値:
操作のステータス
DeleteRoom
static RoomManagementServiceStatus DeleteRoom(string roomId)
サーバー上のルームを削除する。
パラメーター:
roomId - 削除するルームのID
戻り値:
操作のステータス
GetRoom
static RoomManagementServiceStatus GetRoom(string roomId, out IRoom outRoom)
サーバー上のRoom IDでルームを取得する
パラメーター:
roomId - ルームのID（文字列）
outRoom - 検出されたルームオブジェクト。 操作に失敗した場合、またはルームIDが見つからない場合はNULL<//param>
戻り値:
操作のステータス
QueryRoomsByName
static RoomManagementServiceStatus QueryRoomsByName(
string name,
out List<IRoom> rooms
)
サーバー上のルームをルーム名で検索します
パラメーター:
name - 検索するルームの名前
rooms - ルーム名が一致するルームのリスト
戻り値:
操作のステータス
GetAllRooms
静的 RoomManagementServiceStatus GetAllRooms(out List<IRoom> rooms)
このアプリによって作成されたサーバー上のすべてのルームを取得します
パラメーター:
rooms - このアプリで利用可能なルームのリスト
戻り値:
操作のステータス
GetOrCreateRoomForName
static RoomManagementServiceStatus GetOrCreateRoomForName(
RoomParams roomParams,
out IRoom outRoom
)
サーバー上の指定された名前のIRoomオブジェクトを取得します。 その名前のルームが見つからない場合、与えられたルームパラメーターを使用して新しいルームを作成します。
パラメーター:
roomParams - 取得または作成するルームのパラメーター
outRoom - IRoom オブジェクト。 サーバー操作に失敗した場合はnull
戻り値:
操作のステータス
GetOrCreateRoomAsync
static void GetOrCreateRoomAsync(
string roomName,
string roomDesc,
uint roomCapacity,
GetOrCreateRoomCallback doneCb
)
GetOrCreateRoom リクエストの非同期実装。 この関数は、"roomName "という名前のルームが存在するかどうかをチェックし、存在しない場合はルームを作成します。 この関数は、これらの 操作のいずれかによって有効なRoomIDを取得すると、"doneCb "を介してそれを返します。 "doneCb"には2つのパラメータがあります。 1つ目のパラメーターは、サービスに問題があった場合のレスポンスコードで、2つ目のパラメーターは、発見/作成されたルームIDです。
パラメーター:
roomName - チェックする部屋名
roomDesc - ルームを作る必要がある場合に使用するルームの説明
roomCapacity - ルームを作る必要がある場合に使用するルームの収容人数
doneCb - 関数がエラーになった後、または有効なルームIDを受け取った後に呼び出されるコールバック
GetOrCreateRoomAsync
static async Task<GetOrCreateRoomAsyncTaskResult> GetOrCreateRoomAsync(
string roomName,
string roomDescription,
uint roomCapacity
)
GetOrCreateRoom リクエストの非同期実装。 この関数は、"roomName "という名前のルームが存在するかどうかをチェックし、存在しない場合はルームを作成します。 こ のバリアントはタスクを返すので、C# の async/await 機能で await することができます。 タスクは2つの結果を受け取る。リクエストのステータスと、成功した場合、リクエストのroomIdです。
パラメーター:
roomName - チェックする部屋名
roomDescription - ルームを作る必要がある場合に使用するルームの説明。
roomCapacity - ルームを作る必要がある場合に使用するルームの収容人数
戻り値:
リクエストステータスとリクエスト成功時のroomIdを持つタスク