PermissionOffer

Objects of this class are used to offer permissions to owned Realms. They are created exclusively by the client and are processed by the server as indicated by the status fields. When offering permissions, you should create the offer and add it to the User's Management Realm. Once the request has been processed, the statusCode, statusMessage, and ErrorCode will be updated accordingly. If the request has been processed successfully, the token will be populated and you can share it with users you wish to grant permissions to. If the request has failed, statusMessage will be updated with relevant information about the failure and statusCode will be set.

Members

createdAt

Gets the creation time of this object.

Type:
Date
expiresAt

Gets or sets the expiration date and time of the offer. If null, the offer will never expire. Otherwise, the offer may not be consumed past the expiration date.

Type:
Date
id

Gets the unique identifier of this object in the Management realm.

Type:
string
mayManage

Should the user be allowed to manage the Realm?

Type:
bool
mayRead

Should the user be allowed to read from the Realm?

Type:
bool
mayWrite

Should the user be allowed to write to the Realm?

Type:
bool
realmUrl

The URL for the Realm that the changes should apply to.

Type:
string
statusCode
statusMessage

A detailed message describing the status (success, error) of the operation. null if the object has not been processed yet. Filled by the server after an object was processed with additional info explaining the status if necessary.

token

Gets the token that can be used to offer the permissions defined in this object to another user.

Type:
string
updatedAt

Gets when the object was updated the last time.

Type:
Date