class RoomManagementService

(Niantic.Lightship.SharedAR.Rooms.RoomManagementService）

概要

RoomManagementServiceは、ルーム管理サービスのバックエンドにアクセスし、ルームを作成、削除、検索するためのインターフェイスを提供します。 ルームとは、サーバーを中継したネットワークで複数のピア同士を接続するためのエンティティである。

class RoomManagementService {
    public：
    
        struct GetOrCreateRoomAsyncTaskResult;

        // methods
    
        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は、ルーム管理サービスのバックエンドにアクセスし、ルームを作成、削除、検索するためのインターフェイスを提供します。 ルームとは、サーバーを中継したネットワークで複数のピア同士を接続するためのエンティティである。

方法

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を持つタスク