AuthData class

Holds data returned from the server after a successful handshake.

Inheritance
Annotations
  • @JsonSerializable()

Constructors

AuthData({required String authToken, required String projectId, required DateTime timestamp, bool isTemplate = false, required Set<String>? teams, required Set<String>? users, required Map<String, Role> roles, Map<String, Role>? invitations})
Creates a AuthData instance.
const
AuthData.fromJson(Map<String, dynamic> json)
Converts a JSON map to an AuthData instance.
factory
AuthData.private({required String authToken, required String projectId, required DateTime timestamp, bool isTemplate = false, required PrivacyBase privacy, required Map<String, Role>? invitations})

Properties

authToken → String
The authentication token used to authenticate this client.
final
editors → List<String>
A list of user ids that are editors of this object.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isTemplate → bool
Whether the project is published as template or not.
final
owners → Set<String>
An owner ID must always exist in the roles map. It's an error if it doesn't.
no setterinherited
privacy → PrivacyBaseImpl
While this PrivacyBase object is extended by other models, calling toJson on those models will return data in addition to these core privacy properties.
no setterinherited
projectId → String
The project id of the project.
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setteroverride
public → bool
Whether the object is public or not. If it is public, then it is accessible to read by anyone on the platform.
finalinherited
roles → Map<String, Role>
The roles of each user from the users set.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
teams → Set<String>
The list of teams associated with a particular document.
finalinherited
timestamp → DateTime
The issued timestamp of the authentication. The time the handshake was done that resulted in the successful authentication.
final
users → Set<String>
A set of user ids that are allowed to access the project in some way defined by the roles map.
finalinherited
viewers → List<String>
A list of user ids that are viewers of this object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts an AuthData instance to a JSON map.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited