Instance class

Annotations
  • @JsonSerializable(checked: true, createToJson: true, disallowUnrecognizedKeys: false, explicitToJson: true)

Constructors

Instance({bool active = true, bool canRequestInvite = true, required int capacity, required String clientNumber, bool full = false, required String id, required String instanceId, required String location, required int nUsers, required String name, String? ownerId, bool permanent = false, required Region photonRegion, required InstancePlatforms platforms, required Region region, required String secureName, String? shortName, required List<String> tags, required InstanceType type, required String worldId, String? hidden, String? friends, String? private, required bool queueEnabled, required int queueSize, required int recommendedCapacity, bool? roleRestricted, required bool strict, required int userCount, required World world, List<LimitedUser>? users, GroupAccessType? groupAccessType, bool? hasCapacityForYou, String? nonce, DateTime? closedAt, bool? hardClose})
Returns a new Instance instance.
Instance.fromJson(Map<String, dynamic> json)
factory

Properties

active bool
final
canRequestInvite bool
final
capacity int
final
clientNumber String
Always returns "unknown".
final
closedAt DateTime?
final
friends String?
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.
final
full bool
final
groupAccessType GroupAccessType?
final
hardClose bool?
final
hasCapacityForYou bool?
final
hashCode int
The hash code for this object.
no setteroverride
hidden String?
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.
final
id String
InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance.
final
instanceId String
final
location String
InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance.
final
name String
final
nonce String?
final
nUsers int
final
ownerId String?
A groupId if the instance type is "group", null if instance type is public, or a userId otherwise
final
permanent bool
final
photonRegion Region
final
platforms InstancePlatforms
final
private String?
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.
final
queueEnabled bool
final
queueSize int
final
recommendedCapacity int
final
region Region
final
roleRestricted bool?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
secureName String
final
shortName String?
final
strict bool
final
tags List<String>
The tags array on Instances usually contain the language tags of the people in the instance.
final
type InstanceType
final
userCount int
final
users List<LimitedUser>?
The users field is present on instances created by the requesting user.
final
world World
final
worldId String
WorldID be "offline" on User profiles if you are not friends with that user.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override