io.realm.sync.permissions

Class RealmPrivileges

java.lang.Object

io.realm.sync.permissions.RealmPrivileges

public final class RealmPrivileges
extends Object

This object combines all privileges granted on the Realm by all Roles which the current User is a member of into the final privileges which will be enforced by the server. The privilege calculation is done locally using cached data, and inherently may be stale. It is possible that this method may indicate that an operation is permitted but the server will still reject it if permission is revoked before the changes have been integrated on the server. If this happens, the server will automatically revoke any illegal operations. Non-synchronized Realms always have permission to perform all operations.

Constructor Summary

Constructors

Constructor and Description
RealmPrivileges(long privileges)

Method Summary

Modifier and Type	Method and Description
boolean	canModifySchema() Returns whether or not the user can modify the schema of the given resource.
boolean	canRead() Returns whether or not can see this Realm.
boolean	canSetPermissions() Returns whether or not the user can change RealmPermissions.
boolean	canUpdate() Returns whether or not the user can update Realm objects.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RealmPrivileges

public RealmPrivileges(long privileges)

Method Detail

canRead

public boolean canRead()

Returns whether or not can see this Realm. If true, the user is allowed to read all objects and classes from the Realm. If false, the Realm will appear completely empty (including having no schema), effectively making it inaccessible.

Returns:

true if the user can see the Realm, false if not.

canUpdate

public boolean canUpdate()

Returns whether or not the user can update Realm objects. If true, the user is allowed to update properties on all objects in the Realm. This does not include updating permissions nor creating or deleting objects. If false, the Realm is effectively read-only.

This property also in part control if schema updates are possible. If this returns false, the user is not allowed to update the schema, if true, schema updates are allowed if canModifySchema() also returns true.

Returns:

true if the user can update this Realm, false if not.

canSetPermissions

public boolean canSetPermissions()

Returns whether or not the user can change RealmPermissions. See this class for further information.

Returns:

true if the user can modify the RealmPermissions object, false if not.

See Also:

RealmPermissions

canModifySchema

public boolean canModifySchema()

Returns whether or not the user can modify the schema of the given resource.

1. Realm: If true the user is allowed to create classes in the Realm.
2. Class: If true, the user is allowed to add properties to the given class.
3. Object: Not applicable.

Returns:

true if the user can modify the schema of the given resource, false if not.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object