Skip to content

Latest commit

 

History

History
350 lines (229 loc) · 18.2 KB

README.md

File metadata and controls

350 lines (229 loc) · 18.2 KB

RoomsV1

(RoomsV1)

Overview

Available Operations

CreateRoomDeprecated

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;
using System.Collections.Generic;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

CreateRoomDeprecatedRequest req = new CreateRoomDeprecatedRequest() {
    CreateRoomParams = new CreateRoomParams() {
        Region = Region.Chicago,
        RoomConfig = "{\"name\":\"my-room\"}",
    },
    RoomId = "2swovpy1fnunu",
};


using(var res = await sdk.RoomsV1.CreateRoomDeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter Type Required Description
request CreateRoomDeprecatedRequest ✔️ The request object to use for the request.

Response

CreateRoomDeprecatedResponse

Errors

Error Object Status Code Content Type
HathoraCloud.Models.Errors.ApiError 400,401,402,404,422,429,500 application/json
HathoraCloud.Models.Errors.SDKException 4xx-5xx /

DestroyRoomDeprecated

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

DestroyRoomDeprecatedRequest req = new DestroyRoomDeprecatedRequest() {
    RoomId = "2swovpy1fnunu",
};


using(var res = await sdk.RoomsV1.DestroyRoomDeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter Type Required Description
request DestroyRoomDeprecatedRequest ✔️ The request object to use for the request.

Response

DestroyRoomDeprecatedResponse

Errors

Error Object Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401,404,429,500 application/json
HathoraCloud.Models.Errors.SDKException 4xx-5xx /

GetActiveRoomsForProcessDeprecated

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

GetActiveRoomsForProcessDeprecatedRequest req = new GetActiveRoomsForProcessDeprecatedRequest() {
    ProcessId = "cbfcddd2-0006-43ae-996c-995fff7bed2e",
};


using(var res = await sdk.RoomsV1.GetActiveRoomsForProcessDeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter Type Required Description
request GetActiveRoomsForProcessDeprecatedRequest ✔️ The request object to use for the request.

Response

GetActiveRoomsForProcessDeprecatedResponse

Errors

Error Object Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401,404,429 application/json
HathoraCloud.Models.Errors.SDKException 4xx-5xx /

GetConnectionInfoDeprecated

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

GetConnectionInfoDeprecatedRequest req = new GetConnectionInfoDeprecatedRequest() {
    RoomId = "2swovpy1fnunu",
};


using(var res = await sdk.RoomsV1.GetConnectionInfoDeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter Type Required Description
request GetConnectionInfoDeprecatedRequest ✔️ The request object to use for the request.

Response

GetConnectionInfoDeprecatedResponse

Errors

Error Object Status Code Content Type
HathoraCloud.Models.Errors.ApiError 400,402,404,429,500 application/json
HathoraCloud.Models.Errors.SDKException 4xx-5xx /

GetInactiveRoomsForProcessDeprecated

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

GetInactiveRoomsForProcessDeprecatedRequest req = new GetInactiveRoomsForProcessDeprecatedRequest() {
    ProcessId = "cbfcddd2-0006-43ae-996c-995fff7bed2e",
};


using(var res = await sdk.RoomsV1.GetInactiveRoomsForProcessDeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter Type Required Description
request GetInactiveRoomsForProcessDeprecatedRequest ✔️ The request object to use for the request.

Response

GetInactiveRoomsForProcessDeprecatedResponse

Errors

Error Object Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401,404,429 application/json
HathoraCloud.Models.Errors.SDKException 4xx-5xx /

GetRoomInfoDeprecated

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

GetRoomInfoDeprecatedRequest req = new GetRoomInfoDeprecatedRequest() {
    RoomId = "2swovpy1fnunu",
};


using(var res = await sdk.RoomsV1.GetRoomInfoDeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter Type Required Description
request GetRoomInfoDeprecatedRequest ✔️ The request object to use for the request.

Response

GetRoomInfoDeprecatedResponse

Errors

Error Object Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401,404,422,429 application/json
HathoraCloud.Models.Errors.SDKException 4xx-5xx /

SuspendRoomDeprecated

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

SuspendRoomDeprecatedRequest req = new SuspendRoomDeprecatedRequest() {
    RoomId = "2swovpy1fnunu",
};


using(var res = await sdk.RoomsV1.SuspendRoomDeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter Type Required Description
request SuspendRoomDeprecatedRequest ✔️ The request object to use for the request.

Response

SuspendRoomDeprecatedResponse

Errors

Error Object Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401,404,429,500 application/json
HathoraCloud.Models.Errors.SDKException 4xx-5xx /