io.realm.permissions

Class PermissionRequest

java.lang.Object

io.realm.permissions.PermissionRequest

public final class PermissionRequest
extends Object

This class represents the intent of giving a set of permissions to some users for some Realm(s).

If the request is successful, a Permission entry will be added to each affected users, where it can be fetched using SyncUser.retrieveGrantedPermissionsAsync(SyncUser.Callback)

See Also:

SyncUser.applyPermissionsAsync(PermissionRequest, SyncUser.Callback), SyncUser.retrieveGrantedPermissionsAsync(SyncUser.Callback)

Constructor Summary

Constructors

Constructor and Description
PermissionRequest(UserCondition condition, String realmUrl, AccessLevel accessLevel) Creates a description of a set of permissions granted to some users for some Realms.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
AccessLevel	getAccessLevel() Returns the access level that users will be granted if the request is successful.
UserCondition	getCondition() Returns the UserCondition used to match users.
String	getUrl() The Realm URL for which the permissions are granted.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PermissionRequest

public PermissionRequest(UserCondition condition,
                         String realmUrl,
                         AccessLevel accessLevel)

Creates a description of a set of permissions granted to some users for some Realms.

Parameters:

realmUrl - the Realm URL whose permissions settings should be changed. Use * to change the permissions of all Realms managed by the user sending this request. The user that wants to grant these permissions must have administrative rights to those Realms.

condition - the conditions used to match which users are effected.

accessLevel - the AccessLevel to grant matching users. Setting the access level is absolute i.e., it may revoke permissions for users that previously had a higher access level. To revoke all permissions, use AccessLevel.NONE.

Method Detail

getAccessLevel

public AccessLevel getAccessLevel()

Returns the access level that users will be granted if the request is successful.

Returns:

the AccessLevel users will have once this request is successfully handled.

getCondition

public UserCondition getCondition()

Returns the UserCondition used to match users. Those users that match will be granted the the AccessLevel defined by getAccessLevel().

Returns:

the condition used to match users.

getUrl

public String getUrl()

The Realm URL for which the permissions are granted. * is returned if the request should match all Realms, for which the user sending the request, has administrative rights.

Returns:

the Realm URL for which the permissions should be granted.

See Also:

Permission.mayManage()

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