io.realm.permissions

Class Permission

java.lang.Object

io.realm.permissions.Permission

public final class Permission
extends Object

This class represents the given set of permissions provided to a user for the Realm identified by path.

Permissions can be changed by users with administrative rights using SyncUser.applyPermissions(PermissionRequest).

Constructor Summary

Constructors

Constructor and Description
Permission(String userId, String path, AccessLevel accessLevel, boolean mayRead, boolean mayWrite, boolean mayManage, Date updatedAt)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
AccessLevel	getAccessLevel() Returns the access level granted by this permission.
String	getPath() Returns the path to the Realm on the server effected by this permission.
Date	getUpdatedAt() Returns the timestamp for when this permission object was last updated.
String	getUserId() Returns the SyncUser.getIdentity() of the user effected by this permission or null if this permissions applies to all users.
int	hashCode()
boolean	mayManage() Checks whether or not the user defined by this permission is allowed to manage access to the Realm defined by getPath().
boolean	mayRead() Checks whether or not the user defined by this permission is allowed to read the Realm defined by getPath().
boolean	mayWrite() Checks whether or not the user defined by this permission is allowed to write to the Realm defined by getPath().
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Permission

public Permission(String userId,
                  String path,
                  AccessLevel accessLevel,
                  boolean mayRead,
                  boolean mayWrite,
                  boolean mayManage,
                  Date updatedAt)

Method Detail

getUserId

public String getUserId()

Returns the SyncUser.getIdentity() of the user effected by this permission or null if this permissions applies to all users.

Returns:

the user(s) effected by this permission.

getPath

public String getPath()

Returns the path to the Realm on the server effected by this permission. This is not the full URL.

Returns:

the path to the Realm this permission object refers to.

getAccessLevel

public AccessLevel getAccessLevel()

Returns the access level granted by this permission.

Returns:

access level granted by this permission.

mayRead

public boolean mayRead()

Checks whether or not the user defined by this permission is allowed to read the Realm defined by getPath().

Returns:

true if this permission grant read permissions to the Realm, false if not.

mayWrite

public boolean mayWrite()

Checks whether or not the user defined by this permission is allowed to write to the Realm defined by getPath().

Returns:

true if this permission grant write permissions to the Realm, false if not.

mayManage

public boolean mayManage()

Checks whether or not the user defined by this permission is allowed to manage access to the Realm defined by getPath(). Having this permission enable those users to add or remove permissions from other users, including the one who granted it.

Returns:

true if this permission grant administrative rights to the Realm, false if not.

getUpdatedAt

public Date getUpdatedAt()

Returns the timestamp for when this permission object was last updated.

Returns:

the timestamp for when this permission was last updated.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object