io.realm.sync.permissions

Class ClassPrivileges

java.lang.Object

io.realm.sync.permissions.ClassPrivileges

public final class ClassPrivileges
extends Object

This object combines all privileges granted on the Class 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
ClassPrivileges(long privileges)

Method Summary

Modifier and Type	Method and Description
boolean	canCreate() Returns whether or not this user is allowed to create objects of this type.
boolean	canQuery() Returns whether or not the user can query the given class.
boolean	canRead() Returns whether or not the user can read objects of this type.
boolean	canSetPermissions() Returns whether or not the user can change the ClassPermissions object representing the given class.
boolean	canUpdate() Returns whether or not the user can update objects of the given type.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClassPrivileges

public ClassPrivileges(long privileges)

Method Detail

canRead

public boolean canRead()

Returns whether or not the user can read objects of this type.

If false, the current User is not permitted to see objects of this type, and + attempting to query this class will always return empty results. +

+ Note that Read permissions are transitive, and so it may be possible to read an + object which the user does not directly have Read permissions for by following a + link to it from an object they do have Read permissions for. This does not apply + to any of the other permission types.

Returns:

true if the user can read objects of the given type, false if not.

canUpdate

public boolean canUpdate()

Returns whether or not the user can update objects of the given type.

If true, the user is allowed to update properties on all objects of this type in the Realm. This does not include updating permissions nor creating or deleting objects.

Returns:

true if the user can update objects of the given type, false if not.

canSetPermissions

public boolean canSetPermissions()

Returns whether or not the user can change the ClassPermissions object representing the given class. See this clas for further details.

Returns:

true if the user can modify the ClassPermissions object for the given class, false if not.

See Also:

ClassPermissions

canQuery

public boolean canQuery()

Returns whether or not the user can query the given class.

If this returns false, queries can still be run, but they will always return the empty result. This can be useful to prevent people from querying leaf objects in a tree structure and force them to only access objects through some parent objects that reference them.

Returns:

true if the user can query the given class, false if not.

canCreate

public boolean canCreate()

Returns whether or not this user is allowed to create objects of this type.

Returns:

true if the user can create objects of this type, 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