|
1 | 1 | # Instance |
2 | 2 |
|
| 3 | +* `hidden` field is only present if InstanceType is `hidden` aka \"Friends+\", and is instance creator. * `friends` field is only present if InstanceType is `friends` aka \"Friends\", and is instance creator. * `private` field is only present if InstanceType is `private` aka \"Invite\" or \"Invite+\", and is instance creator. |
3 | 4 |
|
4 | 5 | ## Properties |
5 | 6 | Name | Type | Description | Notes |
6 | 7 | ------------ | ------------- | ------------- | ------------- |
7 | 8 | **capacity** | **int** | | |
8 | | -**client_number** | **str** | | |
| 9 | +**client_number** | **str** | Always returns \"unknown\". | |
9 | 10 | **id** | [**InstanceID**](InstanceID.md) | | |
10 | 11 | **instance_id** | **str** | | |
11 | | -**location** | **str** | | |
| 12 | +**location** | [**InstanceID**](InstanceID.md) | | |
12 | 13 | **n_users** | **int** | | |
13 | 14 | **name** | **str** | | |
14 | | -**photon_region** | **str** | | |
| 15 | +**photon_region** | [**Region**](Region.md) | | |
15 | 16 | **platforms** | [**InstancePlatforms**](InstancePlatforms.md) | | |
16 | | -**region** | **str** | | |
| 17 | +**region** | [**Region**](Region.md) | | |
17 | 18 | **short_name** | **str** | | |
18 | | -**tags** | [**[Tag]**](Tag.md) | | |
19 | | -**type** | **str** | | |
| 19 | +**tags** | [**[Tag]**](Tag.md) | The tags array on Instances usually contain the language tags of the people in the instance. | |
| 20 | +**type** | [**InstanceType**](InstanceType.md) | | |
20 | 21 | **world_id** | [**WorldID**](WorldID.md) | | |
21 | 22 | **active** | **bool** | | defaults to True |
22 | 23 | **can_request_invite** | **bool** | | defaults to True |
23 | 24 | **full** | **bool** | | defaults to False |
24 | 25 | **permanent** | **bool** | | defaults to False |
25 | | -**nonce** | **str** | | [optional] |
26 | | -**owner_id** | **str** | | [optional] |
27 | | -**users** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Always empty on non-existing instances, and non-present on existing instances. | [optional] |
28 | | -**world** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Only present on non-existing instances, and only contains a very small subject of World object. Use World API instead. | [optional] |
| 26 | +**owner_id** | **str** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] |
| 27 | +**hidden** | **str** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] |
| 28 | +**friends** | **str** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] |
| 29 | +**private** | **str** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. | [optional] |
29 | 30 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] |
30 | 31 |
|
31 | 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
|
0 commit comments