Show / Hide Table of Contents

    Class PermissionOfferResponse

    Objects of this class are used to accept a PermissionOffer using a provided Token.

    Inheritance
    Object
    RealmObject
    PermissionOfferResponse
    Inherited Members
    RealmObject.PropertyChanged
    RealmObject.IsManaged
    RealmObject.IsValid
    RealmObject.Realm
    RealmObject.ObjectSchema
    RealmObject.Equals(Object)
    RealmObject.RaisePropertyChanged(String)
    Realms.RealmObject.System.Reflection.IReflectableType.GetTypeInfo()
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace:Realms.Sync
    Assembly:Realm.Sync.dll
    Syntax
    public class PermissionOfferResponse : RealmObject, IReflectableType, INotifyPropertyChanged, ISchemaSource, IPermissionObject
    Remarks

    Create an instance of PermissionOfferResponse using the provided Token and add it to the User's ManagementRealm. After that, you should subscribe to PropertyChanged to be notified when the server processes the response. Once the request has been processed, the Status, StatusMessage, and ErrorCode will be updated accordingly. If the request has been processed successfully, the RealmUrl will be populated and you can use it to create a new SyncConfiguration. 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

    PermissionOfferResponse(String)

    Initializes a new instance of the PermissionOfferResponse class.

    Declaration
    public PermissionOfferResponse(string token)
    Parameters
    Type Name Description
    String token

    The token that was provided by the offering user.

    Properties

    | Improve this Doc View Source

    CreatedAt

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

    ErrorCode

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

    Id

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

    RealmUrl

    Gets the url of the Realm that the token has granted permissions to.

    Declaration
    [MapTo("realmUrl")]
    public string RealmUrl { get; }
    Property Value
    Type Description
    String
    Remarks

    Filled by the server after the PermissionOfferResponse was processed.

    | Improve this Doc View Source

    Status

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

    StatusMessage

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

    Token

    Gets the token that was provided by the offering user.

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

    UpdatedAt

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

    Methods

    | Improve this Doc View Source

    OnPropertyChanged(String)

    Declaration
    protected override void OnPropertyChanged(string propertyName)
    Parameters
    Type Name Description
    String propertyName
    Overrides
    RealmObject.OnPropertyChanged(String)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2017 Realm
    Generated by DocFX