io.realm.sync.permissions

Class Role

java.lang.Object

io.realm.RealmObject

io.realm.sync.permissions.Role

All Implemented Interfaces:

RealmModel

public class Role
extends RealmObject

A role describes a function or area of authority in the Realm Object Server permission system. Multiple users can have the same role and a role can be assigned different permissions.

See Also:

Object Level Permissions for an detailed description of the Realm Object Server permission system.

Constructor Summary

Constructors

Constructor and Description
Role()
Role(String name) Creates a new named role.

Method Summary

Modifier and Type	Method and Description
void	addMember(String userId) Adds a member to this Role.
RealmList<PermissionUser>	getMembers() Returns the list of PermissionUser within this role.
String	getName() Returns the name of this role.
boolean	hasMember(String userId) Checks if the provided user has this role.
boolean	removeMember(String userId) Removes a member from this Role.

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, toString, wait, wait, wait

Constructor Detail

Role

public Role()

Role

public Role(String name)

Creates a new named role. The name must be unique.

Parameters:

name - a unique name for the role.

Method Detail

getName

public String getName()

Returns the name of this role.

Returns:

name of this role.

addMember

public void addMember(String userId)

Adds a member to this Role. Must be done from within a write transaction.

Parameters:

userId - userid of the SyncUser.

Throws:

IllegalStateException - if not in a write transaction.

IllegalArgumentException - if null or empty userId is provided.

removeMember

public boolean removeMember(String userId)

Removes a member from this Role. Must be done from within a write transaction.

Parameters:

userId - userid of the SyncUser to remove.

Returns:

true if the user could be removed, false if not.

Throws:

IllegalStateException - if not in a write transaction.

hasMember

public boolean hasMember(String userId)

Checks if the provided user has this role.

Parameters:

userId - user to check

Returns:

true if the user has this role, false if not.

getMembers

public RealmList<PermissionUser> getMembers()

Returns the list of PermissionUser within this role.

Returns:

list of members associated with this role.