AuthKey class abstract

Provides a method of access for a user to authenticate with the server.

Inheritance
Available Extensions

Constructors

AuthKey({int? id, required int userId, required String hash, String? key, required List<String> scopeNames, required String method})
factory
AuthKey.fromJson(Map<String, dynamic> jsonSerialization, SerializationManager serializationManager)
factory

Properties

hash ↔ String
The hashed version of the key.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ int?
The id column of the row. Can be null if this row is not yet stored in the database.
getter/setter pairinherited
key ↔ String?
The key sent to the server to authenticate.
getter/setter pair
method ↔ String
The method of signing in this key was generated through. This can be email or different social logins.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopeNames ↔ List<String>
The scopes this key provides access to.
getter/setter pair
table → Table
The table that this row belongs to.
no setteroverride
tableName → String
The name of the table that contains this row.
no setterinherited
userId ↔ int
The id of the user to provide access to.
getter/setter pair

Methods

allToJson() → Map<String, dynamic>
Returns a serialized JSON structure of the model which also includes fields used by the database.
override
copyWith({int? id, int? userId, String? hash, String? key, List<String>? scopeNames, String? method}) → AuthKey
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setColumn(String columnName, dynamic value) → void
Sets the value of a column by its name. Used in communication with the database.
override
toJson() → Map<String, dynamic>
Returns a serialized JSON structure of the model, ready to be sent through the API. This does not include fields that are marked as database only.
override
toJsonForDatabase() → Map<String, dynamic>
Will create a serialization of with the fields that are stored in the database only.
override
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

t → AuthKeyTable
final

Static Methods

count(Session session, {WhereExpressionBuilder<AuthKeyTable>? where, int? limit, bool useCache = true, Transaction? transaction}) → Future<int>
delete(Session session, {required WhereExpressionBuilder<AuthKeyTable> where, Transaction? transaction}) → Future<int>
deleteRow(Session session, AuthKey row, {Transaction? transaction}) → Future<bool>
find(Session session, {WhereExpressionBuilder<AuthKeyTable>? where, int? limit, int? offset, Column? orderBy, List<Order>? orderByList, bool orderDescending = false, bool useCache = true, Transaction? transaction}) → Future<List<AuthKey>>
findById(Session session, int id) → Future<AuthKey?>
findSingleRow(Session session, {WhereExpressionBuilder<AuthKeyTable>? where, int? offset, Column? orderBy, bool orderDescending = false, bool useCache = true, Transaction? transaction}) → Future<AuthKey?>
include() → AuthKeyInclude
includeList({WhereExpressionBuilder<AuthKeyTable>? where, int? limit, int? offset, OrderByBuilder<AuthKeyTable>? orderBy, bool orderDescending = false, OrderByListBuilder<AuthKeyTable>? orderByList, AuthKeyInclude? include}) → AuthKeyIncludeList
insert(Session session, AuthKey row, {Transaction? transaction}) → Future<void>
update(Session session, AuthKey row, {Transaction? transaction}) → Future<bool>

Constants

db → const AuthKeyRepository