io.realm.permissions

Class Permission

java.lang.Object

io.realm.RealmObject

io.realm.permissions.Permission

All Implemented Interfaces:

RealmModel

public class Permission
extends RealmObject

This class represents a given set of permissions for one user on one Realm.

Permissions can be changed by users with administrative rights using the PermissionManager.

See Also:

SyncUser.getPermissionManager()

Constructor Summary

Constructors

Constructor and Description
Permission() Required by Realm.

Method Summary

Modifier and Type	Method and Description
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.˚
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 io.realm.RealmObject

addChangeListener, addChangeListener, addChangeListener, addChangeListener, asChangesetObservable, asChangesetObservable, asFlowable, asFlowable, deleteFromRealm, deleteFromRealm, getRealm, getRealm, isLoaded, isLoaded, isManaged, isManaged, isValid, isValid, load, load, removeAllChangeListeners, removeAllChangeListeners, removeChangeListener, removeChangeListener, removeChangeListener, removeChangeListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Permission

public Permission()

Required by Realm. Do not use.

Method Detail

getUserId

public String getUserId()

Returns the SyncUser.getIdentity() of the user effected by this permission.˚

Returns:

the user 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.

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