io.realm.permissions

Class PermissionOffer

java.lang.Object

io.realm.RealmObject

io.realm.permissions.PermissionOffer

All Implemented Interfaces:

RealmModel

public class PermissionOffer
extends RealmObject

This model is used for offering permission changes to other users. It should be used in conjunction with an SyncUser's management Realm.

See Also:

Permissions description for general documentation.

Constructor Summary

Constructors

Constructor and Description
PermissionOffer()
PermissionOffer(String url, boolean mayRead, boolean mayWrite, boolean mayManage, Date expiresAt) Construct a permission offer object used to offer permission changes to other users.

Method Summary

Modifier and Type	Method and Description
Date	getCreatedAt()
Date	getExpiresAt()
String	getId()
String	getRealmUrl()
Integer	getStatusCode() Returns the status code for this change.
String	getStatusMessage()
String	getToken()
Date	getUpdatedAt()
boolean	isMayManage()
boolean	isMayRead()
boolean	isMayWrite()
boolean	isSuccessful() Check if the request was successfully handled by the Realm Object Server.

Methods inherited from class io.realm.RealmObject

addChangeListener, addChangeListener, addChangeListener, addChangeListener, asObservable, asObservable, deleteFromRealm, deleteFromRealm, isLoaded, isLoaded, isManaged, isManaged, isValid, isValid, load, load, removeAllChangeListeners, removeAllChangeListeners, removeChangeListener, removeChangeListener, removeChangeListener, removeChangeListener, removeChangeListeners, removeChangeListeners

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionOffer

public PermissionOffer()

PermissionOffer

public PermissionOffer(String url,
                       boolean mayRead,
                       boolean mayWrite,
                       boolean mayManage,
                       Date expiresAt)

Construct a permission offer object used to offer permission changes to other users.

Parameters:

url - The URL to the Realm on which to apply these permission changes to, once the offer is accepted.

mayRead - Grant or revoke read access.

mayWrite - Grant or revoked read-write access.

mayManage - Grant or revoke administrative access.

expiresAt - When this token will expire and become invalid. Pass null if this offer should not expire.

Method Detail

getId

public String getId()

getCreatedAt

public Date getCreatedAt()

getUpdatedAt

public Date getUpdatedAt()

getStatusCode

public Integer getStatusCode()

Returns the status code for this change.

Returns:

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

isSuccessful

public boolean isSuccessful()

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

Returns:

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

getStatusMessage

public String getStatusMessage()

getToken

public String getToken()

getRealmUrl

public String getRealmUrl()

isMayRead

public boolean isMayRead()

isMayWrite

public boolean isMayWrite()

isMayManage

public boolean isMayManage()

getExpiresAt

public Date getExpiresAt()