io.realm.sync.permissions

Class RealmPermissions

java.lang.Object

io.realm.RealmObject

io.realm.sync.permissions.RealmPermissions

All Implemented Interfaces:

RealmModel

public class RealmPermissions
extends RealmObject

Class describing all permissions related to a given Realm. Permissions attached to this class are treated as the default permissions if not otherwise overridden by ClassPermissions or object level permissions.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
RealmPermissions()

Method Summary

Modifier and Type	Method and Description
Permission	findOrCreate(String roleName) Finds the permissions associated with a given Role.
RealmList<Permission>	getPermissions() Returns all Realm level permissions, i.e.

Methods inherited from class io.realm.RealmObject

addChangeListener, addChangeListener, addChangeListener, addChangeListener, asChangesetObservable, asChangesetObservable, asFlowable, asFlowable, deleteFromRealm, deleteFromRealm, freeze, freeze, getRealm, getRealm, isFrozen, isFrozen, 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

RealmPermissions

public RealmPermissions()

Method Detail

getPermissions

public RealmList<Permission> getPermissions()

Returns all Realm level permissions, i.e. permissions that apply to the Realm as a whole.

Returns:

all Realm level permissions

findOrCreate

public Permission findOrCreate(String roleName)

Finds the permissions associated with a given Role. If either the role or the permission object doesn't exists, it will be created.

If the Permission object is created because one didn't exist already, it will be created with all privileges disabled.

If the role Role object is created because one didn't exists, it will be created with no members.

Parameters:

roleName - name of the role to find.

Returns:

permission object for the given role.

Throws:

IllegalStateException - if this object is not managed by Realm.

IllegalStateException - if this method is not called inside a write transaction.

IllegalArgumentException - if a null or empty