PrivacyBase class abstract
Represents the privacy controls of a given model that this mixin is applied to.
Constructors
-
PrivacyBase({required Set<
String> ? teams, required Set<String> ? users, required Map<String, Role> roles, required bool? public}) -
Creates a new PrivacyBase with the given parameters.
const
- PrivacyBase.private({required PrivacyBase privacy})
- Creates a new PrivacyBase derived from another PrivacyBase.
Properties
-
editors
→ List<
String> -
A list of user ids that are editors of this object.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
owners
→ Set<
String> -
An owner ID must always exist in the roles map. It's an error
if it doesn't.
no setter
- 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 setter
-
props
→ List<
Object?> -
The list of properties that will be used to determine whether
two instances are equal.
no setter
- public → bool
-
Whether the object is public or not. If it is public, then
it is accessible to read by anyone on the platform.
final
-
roles
→ Map<
String, Role> -
The roles of each user from the users set.
final
- 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.
final
-
users
→ Set<
String> -
A set of user ids that are allowed to access the project in some way
defined by the roles map.
final
-
viewers
→ List<
String> -
A list of user ids that are viewers of this object.
no setter
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map -
Returns a serializable map representation of the object.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited