io.realm.permissions

Class UserCondition

java.lang.Object

io.realm.permissions.UserCondition

public final class UserCondition
extends Object

This class represents a condition for matching users on the Realm Object Server. It is used when a request for changing existing permissions is made.

See Also:

PermissionRequest, PermissionManager.applyPermissions(PermissionRequest, PermissionManager.ApplyPermissionsCallback)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserCondition.MatcherType Type of matcher this condition represents.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getKey() Returns the they in the users metadata that is used for evaluating this condition.
UserCondition.MatcherType	getType() Returns the type of data this condition matches.
String	getValue() Returns the value that is used when matching users.
int	hashCode()
static UserCondition	keyValue(String key, String value) Creates a custom permission condition.
static UserCondition	noExistingPermissions() Creates a condition that will match all users with no permissions for the Realm.
String	toString()
static UserCondition	userId(String userId) Creates a condition for matching, exactly, a users id.
static UserCondition	username(String username) Creates a condition for matching, exactly, a users username.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

username

public static UserCondition username(String username)

Creates a condition for matching, exactly, a users username. The comparison is case-sensitive and wildcards are not allowed.

Parameters:

username - exact username to match against.

userId

public static UserCondition userId(String userId)

Creates a condition for matching, exactly, a users id.

Parameters:

userId - user id to match against. No wildcards are allowed.

See Also:

SyncUser.getIdentity()

noExistingPermissions

public static UserCondition noExistingPermissions()

Creates a condition that will match all users with no permissions for the Realm.

The AccessLevel defined alongside this condition, will also be used as the default access level for future new users that might be given access to the Realm.

See Also:

PermissionManager.makeOffer(PermissionOffer, PermissionManager.MakeOfferCallback)

keyValue

public static UserCondition keyValue(String key,
                                     String value)

Creates a custom permission condition. This will apply the permissions based on a key/value combination in the user's metadata.

Parameters:

key - key to use.

value - value for that field to match.

getKey

public String getKey()

Returns the they in the users metadata that is used for evaluating this condition.

Returns:

the key in the users metadata.

getValue

public String getValue()

Returns the value that is used when matching users. The semantics of the value will be different depending on the type of key used.

Returns:

the value to searchh for in the users meta data.

getType

public UserCondition.MatcherType getType()

Returns the type of data this condition matches.

Returns:

the type of data this condition matches.

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