io.realm.permissions

Class PermissionOffer

java.lang.Object

io.realm.permissions.PermissionOffer

public class PermissionOffer
extends Object

This class represents a permission offer for a Realm that can be given to other users. When an offer is successfully created, it will be represented by an offerToken that can be sent to other users. Once they accept this token, the permissions covered by this offer will take effect for that user.

Permission offers can only be created by users that can manage the Realm, the offer is about.

See Also:

PermissionManager.makeOffer(PermissionOffer, PermissionManager.MakeOfferCallback), PermissionManager.acceptOffer(String, PermissionManager.AcceptOfferCallback), Permissions description for general documentation.

Constructor Summary

Constructors

Constructor and Description
PermissionOffer() Constructor required by Realm.
PermissionOffer(String url, AccessLevel accessLevel) Creates a request for an permission offer that last until it is manually revoked.
PermissionOffer(String url, AccessLevel accessLevel, Date expiresAt) Creates a request for a permission offer that last until it is manually revoked.

Method Summary

Modifier and Type	Method and Description
Date	getCreatedAt() Returns the timestamp when this offer was created.
Date	getExpiresAt() Returns when this offer expires.
String	getId() Returns the id uniquely identifying this offer.
String	getRealmUrl() Returns the Realm URL for which the permissions are granted.
Integer	getStatusCode() Returns the server status code for this change.
String	getStatusMessage() Returns the servers status message, if an error occurred.
String	getToken() Returns the offer token if this offer was successfully created.
Date	getUpdatedAt() Returns the timestamp this offer was last updated.
boolean	isOfferCreated() Checks if the request was successfully handled by the Realm Object Server.
boolean	mayManage() Returns whether or not the user accepting this offer is granted manage permission.
boolean	mayRead() Returns whether or not the user accepting this offer is granted read permission.
boolean	mayWrite() Returns whether or not the user accepting this offer is granted write permission.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionOffer

public PermissionOffer()

Constructor required by Realm. Should not be used.

PermissionOffer

public PermissionOffer(String url,
                       AccessLevel accessLevel)

Creates a request for an permission offer that last until it is manually revoked.

Parameters:

url - specific url to Realm effected this offer encompasses all Realms manged by the user making the offer.

accessLevel - the AccessLevel granted to the user accepting the offer.

See Also:

PermissionManager.revokeOffer(String, PermissionManager.RevokeOfferCallback)

PermissionOffer

public PermissionOffer(String url,
                       AccessLevel accessLevel,
                       Date expiresAt)

Creates a request for a permission offer that last until it is manually revoked.

Parameters:

url - specific url to Realm effected. The user sending the offer must have manage rights to this Realm.

accessLevel - the AccessLevel granted to the user accepting the offer.

expiresAt - the date and time when this offer expires. If null is provided the offer never expires.

See Also:

PermissionManager.revokeOffer(String, PermissionManager.RevokeOfferCallback)

Method Detail

getId

public String getId()

Returns the id uniquely identifying this offer.

Returns:

the id uniquely identifying this offer.

getCreatedAt

public Date getCreatedAt()

Returns the timestamp when this offer was created.

Returns:

the timstamp when this offer was created.

getUpdatedAt

public Date getUpdatedAt()

Returns the timestamp this offer was last updated.

Returns:

the timestamp when this offer was last updated.

getStatusCode

public Integer getStatusCode()

Returns the server status code for this change.

Returns:

null if not yet processed. 0 if successful, >0 if an error happened. See getStatusMessage().

getStatusMessage

public String getStatusMessage()

Returns the servers status message, if an error occurred. Otherwise it will return null.

Returns:

The servers status message in case of an error, null otherwise.

isOfferCreated

public boolean isOfferCreated()

Checks if the request was successfully handled by the Realm Object Server.

Returns:

true if the request was handled successfully. false if not. See getStatusMessage() for the full error message.

getToken

public String getToken()

Returns the offer token if this offer was successfully created.

Returns:

the offer token or null if the offer wasn't created yet.

getRealmUrl

public String getRealmUrl()

Returns the Realm URL for which the permissions are granted.

Returns:

the Realm URL for which the permissions should be granted.

mayRead

public boolean mayRead()

Returns whether or not the user accepting this offer is granted read permission.

Returns:

true if the user accepting this offer is granted read permission, false if not.

mayWrite

public boolean mayWrite()

Returns whether or not the user accepting this offer is granted write permission.

Returns:

true if the user accepting this offer is granted write permission, false if not.

mayManage

public boolean mayManage()

Returns whether or not the user accepting this offer is granted manage permission. This will allow this user to also grant or remove permission for other users on this Realm.

Returns:

true if the user accepting this offer is granted mange permission, false if not.

getExpiresAt

public Date getExpiresAt()

Returns when this offer expires. null is returned if this offer never expires.

Returns:

the date when this offer expires or null if it never expires.

toString

public String toString()

Overrides:

toString in class Object