Class 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.

    Inheritance
    Object
    RealmObject
    PermissionOffer
    Inherited Members
    Realms.RealmObject.System.Reflection.IReflectableType.GetTypeInfo()
    Namespace:Realms.Sync
    Assembly:Realm.Sync.dll
    Syntax
    public class PermissionOffer : RealmObject, IReflectableType, INotifyPropertyChanged, ISchemaSource, IPermissionObject
    Remarks

    When offering permissions, you should create the offer and add it to the User's Management Realm. Then you should subscribe to PropertyChanged to be notified when the server has processed the request. Once the request has been processed, the Status, 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, the StatusMessage will be updated with relevant information about the failure and ErrorCode will be set to a non-null value.

    Constructors

    | Improve this Doc View Source

    PermissionOffer(String, Boolean, Boolean, Boolean, Nullable<DateTimeOffset>)

    Initializes a new instance of the PermissionOffer class.

    Declaration
    public PermissionOffer(string realmUrl, bool mayRead = true, bool mayWrite = false, bool mayManage = false, DateTimeOffset? expiresAt = null)
    Parameters
    Type Name Description
    String realmUrl

    The Realm URL to offer permissions to.
    Boolean mayRead

    If set to true grants read access.
    Boolean mayWrite

    If set to true grants write access.
    Boolean mayManage

    If set to true grants manage access.
    Nullable<DateTimeOffset> expiresAt

    Optional expiration date of the offer. If set to null, the offer doesn't expire.

    Properties

    | Improve this Doc View Source

    CreatedAt

    Declaration
    [MapTo("createdAt")]
public DateTimeOffset CreatedAt { get; }
    Property Value
    Type Description
    DateTimeOffset
    Implements
    | Improve this Doc View Source

    ErrorCode

    Declaration
    public ErrorCode? ErrorCode { get; }
    Property Value
    Type Description
    Nullable<ErrorCode>
    Implements
    | Improve this Doc View Source

    ExpiresAt

    Gets or sets the expiration date and time of the offer.

    Declaration
    [MapTo("expiresAt")]
public DateTimeOffset? ExpiresAt { get; set; }
    Property Value
    Type Description
    Nullable<DateTimeOffset>

    If null, the offer will never expire. Otherwise, the offer may not be consumed past the expiration date.
    | Improve this Doc View Source

    Id

    Declaration
    [PrimaryKey]
[Required]
[MapTo("id")]
public string Id { get; }
    Property Value
    Type Description
    String
    Implements
    | Improve this Doc View Source

    MayManage

    Gets a value indicating whether the receiver of this offer will be able to manage access rights for others.

    Declaration
    [MapTo("mayManage")]
public bool MayManage { get; }
    Property Value
    Type Description
    Boolean

    true to allow the receiver to offer others access to the Realm.
    | Improve this Doc View Source

    MayRead

    Gets a value indicating whether the receiver of this offer will be able to read from the Realm.

    Declaration
    [MapTo("mayRead")]
public bool MayRead { get; }
    Property Value
    Type Description
    Boolean

    true to allow the receiver to read data from the Realm.
    | Improve this Doc View Source

    MayWrite

    Gets a value indicating whether the receiver of this offer will be able to write to the Realm.

    Declaration
    [MapTo("mayWrite")]
public bool MayWrite { get; }
    Property Value
    Type Description
    Boolean

    true to allow the receiver to write data to the Realm.
    | Improve this Doc View Source

    RealmUrl

    Gets the url of the Realm to offer permissions to.

    Declaration
    [MapTo("realmUrl")]
[Required]
public string RealmUrl { get; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    Status

    Declaration
    public ManagementObjectStatus Status { get; }
    Property Value
    Type Description
    ManagementObjectStatus
    Implements
    | Improve this Doc View Source

    StatusMessage

    Declaration
    [MapTo("statusMessage")]
public string StatusMessage { get; }
    Property Value
    Type Description
    String
    Implements
    | Improve this Doc View Source

    Token

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

    Declaration
    [MapTo("token")]
[Indexed]
public string Token { get; }
    Property Value
    Type Description
    String

    A string, set by the server, that can be used to create a PermissionOfferResponse.
    | Improve this Doc View Source

    UpdatedAt

    Declaration
    [MapTo("updatedAt")]
public DateTimeOffset UpdatedAt { get; }
    Property Value
    Type Description
    DateTimeOffset
    Implements

    Methods

    | Improve this Doc View Source

    OnPropertyChanged(String)

    Declaration
    protected override void OnPropertyChanged(string propertyName)
    Parameters
    Type Name Description
    String propertyName
    Overrides