Show / Hide Table of Contents

    Class NotifierConfiguration

    A Notifier configuration specifying various settings that affect the Notifier's behavior.

    Inheritance
    Object
    NotifierConfiguration
    Namespace: Realms.Server
    Assembly: Realm.dll
    Syntax
    public class NotifierConfiguration

    Constructors

    | Improve this Doc View Source

    NotifierConfiguration(User)

    Initializes a new instance of the NotifierConfiguration class.

    Declaration
    public NotifierConfiguration(User user)
    Parameters
    Type Name Description
    User user

    A valid User that has administrative access.

    Properties

    | Improve this Doc View Source

    EnableSSLValidation

    Gets or sets a value indicating whether SSL certificate validation is enabled for the connection associated with this configuration value.

    Declaration
    public bool EnableSSLValidation { get; set; }
    Property Value
    Type Description
    Boolean

    true if SSL validation is enabled; otherwise, false. Default value is true.

    | Improve this Doc View Source

    EncryptionKey

    Gets or sets the key, used to encrypt the Realms at rest that the INotifier observes. Once set, must be specified each time a notifier is started in the same working directory.

    Declaration
    public byte[] EncryptionKey { get; set; }
    Property Value
    Type Description
    Byte[]

    Full 64byte (512bit) key for AES-256 encryption.

    | Improve this Doc View Source

    Handlers

    Gets or sets a collection of INotificationHandlers that will be invoked when a change occurs in a Realm file.

    Declaration
    public IList<INotificationHandler> Handlers { get; set; }
    Property Value
    Type Description
    IList<INotificationHandler>

    The IList<T> that will handle Realm changes.

    Remarks

    The members of the collection will be called sequentially in the order that they appear.

    | Improve this Doc View Source

    TrustedCAPath

    Gets or sets the path to the trusted root certificate(s) authority (CA) in PEM format, that should be used to validate the TLS connections to the Realm Object Server.

    Declaration
    public string TrustedCAPath { get; set; }
    Property Value
    Type Description
    String

    The path to the certificate.

    Remarks

    The file will be copied at runtime into the internal storage.
    It is recommended to include only the root CA you trust, and not the entire list of root CA as this file will be loaded at runtime. It is your responsibility to download and verify the correct PEM for the root CA you trust.
    This property is ignored on Apple platforms - you should use the KeyChain API to install your certificate instead.

    See Also
    OpenSSL documentation for SSL_CTX_load_verify_locations.
    Mozilla Included CA Certificate List
    | Improve this Doc View Source

    User

    Gets the User used to create this NotifierConfiguration.

    Declaration
    public User User { get; }
    Property Value
    Type Description
    User

    The User whose Realms will be synced.

    | Improve this Doc View Source

    WorkingDirectory

    Gets or sets the directory which the INotifier will use to store the Realms it observes.

    Declaration
    public string WorkingDirectory { get; set; }
    Property Value
    Type Description
    String

    A folder on the filesystem, that your application has permissions to write to.

    • Improve this Doc
    • View Source
    Back to top Copyright © 2019 Realm
    Generated by DocFX