UserInfo class

Information about a user. The UserInfo should only be shared with the user itself as it may contain sensative information, such as the users email. If you need to share a user's info with other users, use the UserInfoPublic instead. You can retrieve a UserInfoPublic through the toPublic() method.

Inheritance
Available extensions

Constructors

UserInfo({int? id, required String userIdentifier, required String userName, String? fullName, String? email, required DateTime created, String? imageUrl, required List<String> scopeNames, required bool blocked})
UserInfo.fromJson(Map<String, dynamic> jsonSerialization, SerializationManager serializationManager)
factory

Properties

blocked ↔ bool
True if the user is blocked from signing in.
getter/setter pair
created ↔ DateTime
The time when this user was created.
getter/setter pair
email ↔ String?
The email of the user.
getter/setter pair
fullName ↔ String?
The full name of the user.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ int?
The database id, set if the object has been inserted into the database or if it has been fetched from the database. Otherwise, the id will be null.
getter/setter pair
imageUrl ↔ String?
A URL to the user's avatar.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopeNames ↔ List<String>
List of scopes that this user can access.
getter/setter pair
userIdentifier ↔ String
Unique identifier of the user, may contain different information depending on how the user was created.
getter/setter pair
userName ↔ String
The first name of the user or the user's nickname.
getter/setter pair

Methods

allToJson() → dynamic
Returns a serialized JSON structure of the entity which also includes fields used by the database.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Returns a serialized JSON structure of the entity, ready to be sent through the API. This does not include fields that are marked as database only.
override
toPublic({bool includeUserId = true, bool includeFullName = true}) → UserInfoPublic

Available on UserInfo, provided by the UserInfoExtension extension

Returns an object with only the information that can safely be shared publicly for the user.
toString() → String
A string representation of this object.
inherited

Operators

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