Skip to content

インスタンス (Instances)

メソッド

GetInstance(ctx, worldId, instanceId)

指定ワールドのインスタンス情報を取得します。

go
instance, err := client.GetInstance(ctx, "wrld_...", "12345~private(...)")

戻り値: (*shared.Instance, error)


GetInstanceByShortName(ctx, shortName)

短縮名でインスタンスを取得します。

go
instance, err := client.GetInstanceByShortName(ctx, "shortname123")

SendSelfInvite(ctx, worldId, instanceId)

現在のインスタンスに自分自身への招待を送信します。

go
err := client.SendSelfInvite(ctx, "wrld_...", "12345~private(...)")

CreateInstance(ctx, req)

新しいインスタンスを作成します。

go
instance, err := client.CreateInstance(ctx, shared.CreateInstanceRequest{
    WorldID:  "wrld_...",
    Type:     "private",
    Region:   "jp",
    OwnerID:  "usr_...",
})

CloseInstance(ctx, worldId, instanceId)

インスタンスを閉じます(オーナーのみ)。

go
err := client.CloseInstance(ctx, "wrld_...", "12345~private(...)")

型定義

shared.Instance

フィールド説明
IDstringインスタンスID
WorldIDstringワールドID
Typestringタイプ (public, friends, private など)
Regionstringリージョン (us, eu, jp)
UserCountint現在の参加者数
Capacityint最大収容人数
Platformsmap[string]intプラットフォーム別参加者数

Released under the Apache-2.0 License.