ModelPermissionQueryUserType enum

Specify the target user for which you want to specify ModelPermissionQueryType.

ModelPermissionQueryTypeを指定する対象のユーザーを指定します。

Inheritance

Object
Enum
ModelPermissionQueryUserType

Available extensions

EnumName

Values

allUsers → const ModelPermissionQueryUserType

All users.

すべてのユーザー。

authUsers → const ModelPermissionQueryUserType

Authenticated users.

If allUsers is specified, it takes precedence.

認証済みのユーザー。

allUsersが指定されている場合はそちらが優先されます。

userFromPath → const ModelPermissionQueryUserType

An authenticated user whose user ID matches the dynamic value specified by :key in the document or collection path and the user ID authenticated on the app.

If Null is specified, a comparison with the document ID is performed.

If allUsers or authUsers is specified, it takes precedence.

userFromData can be specified at the same time.

認証済みユーザーのうち、ドキュメントやコレクションのパス中の:keyで指定する動的な値とアプリ上で認証しているユーザーIDが一致するユーザー。

Nullを指定するとドキュメントIDとの比較が行われます。

allUsersやauthUsersが指定されている場合はそちらが優先されます。

userFromDataとは同時に指定可能です。

// Path definition
/collection/:document_id
// Actual path
/collection/ABCDEFG
// Definition
ModelPermissionQueryUserType.userFromPath("document_id")
-> Allow users whose user ID is `ABCDEFG

userFromData → const ModelPermissionQueryUserType

An authenticated user whose user ID matches the value of a field with key in the document to be read or written and the user ID authenticated on the app.

Null or @uid will cause a comparison with the document ID.

If allUsers or authUsers is specified, it takes precedence.

userFromPath can be specified at the same time.

認証済みユーザーのうち、読み込みや書き込み対象のドキュメント中にkeyを持つフィールドの値ととアプリ上で認証しているユーザーIDが一致するユーザー。

Nullもしくは@uidを指定するとドキュメントIDとの比較が行われます。

allUsersやauthUsersが指定されている場合はそちらが優先されます。

userFromPathとは同時に指定可能です。

// Document data
{
  "user": "ABCDEFG",
  "name": "ABCD",
  "age": 20,
}
// Definition
ModelPermissionQueryUserType.userFromData("user")
-> Allow users whose user ID is `ABCDEFG

Properties

hashCode → int: The hash code for this object.
no setterinherited
index → int: A numeric identifier for the enumerated value.
no setterinherited
name → String: Available on Enum, provided by the EnumName extension
The name of the enum value.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

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

Constants

values → const List<ModelPermissionQueryUserType>: A constant List of the values in this enum, in order of their declaration.