RLMSyncPermissionChange


@interface RLMSyncPermissionChange : RLMObject

This model is used for requesting changes to a Realm’s permissions.

It should be used in conjunction with an RLMSyncUser‘s Management Realm.

See https://realm.io/docs/realm-object-server/#permissions for general documentation.

  • id

    The globally unique ID string of this permission change object.

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull id;

    Swift

    var id: String { get }
    Show on GitHub

  • The date this object was initially created.

    Declaration

    Objective-C

    @property (readonly, atomic) NSDate *_Nonnull createdAt;

    Swift

    var createdAt: Date { get }
    Show on GitHub

  • The date this object was last modified.

    Declaration

    Objective-C

    @property (readonly, atomic) NSDate *_Nonnull updatedAt;

    Swift

    var updatedAt: Date { get }
    Show on GitHub

  • The status code of the object that was processed by Realm Object Server.

    Declaration

    Objective-C

    @property (readonly, atomic, nullable) NSNumber<RLMInt> *statusCode;

    Swift

    var statusCode: NSNumber? { get }
    Show on GitHub

  • An error or informational message, typically written to by the Realm Object Server.

    Declaration

    Objective-C

    @property (readonly, atomic, nullable) NSString *statusMessage;

    Swift

    var statusMessage: String? { get }
    Show on GitHub

  • Sync management object status.

    Declaration

    Objective-C

    @property (readonly, atomic) RLMSyncManagementObjectStatus status;

    Swift

    var status: Int32 { get }
    Show on GitHub

  • The remote URL to the realm.

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull realmUrl;

    Swift

    var realmUrl: String { get }
    Show on GitHub

  • The identity of a user affected by this permission change.

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull userId;

    Swift

    var userId: String { get }
    Show on GitHub

  • Define read access. Set to YES or NO to update this value. Leave unset to preserve the existing setting.

    Declaration

    Objective-C

    @property (readonly, atomic, nullable) NSNumber<RLMBool> *mayRead;

    Swift

    var mayRead: NSNumber? { get }
    Show on GitHub

  • Define write access. Set to YES or NO to update this value. Leave unset to preserve the existing setting.

    Declaration

    Objective-C

    @property (readonly, atomic, nullable) NSNumber<RLMBool> *mayWrite;

    Swift

    var mayWrite: NSNumber? { get }
    Show on GitHub

  • Define management access. Set to YES or NO to update this value. Leave unset to preserve the existing setting.

    Declaration

    Objective-C

    @property (readonly, atomic, nullable) NSNumber<RLMBool> *mayManage;

    Swift

    var mayManage: NSNumber? { get }
    Show on GitHub

  • Construct a permission change object used to change the access permissions for a user on a Realm.

    Declaration

    Objective-C

    + (nonnull instancetype)
permissionChangeWithRealmURL:(nonnull NSString *)realmURL
                      userID:(nonnull NSString *)userID
                        read:(nullable NSNumber<RLMBool> *)mayRead
                       write:(nullable NSNumber<RLMBool> *)mayWrite
                      manage:(nullable NSNumber<RLMBool> *)mayManage;

    Swift

    convenience init(realmURL: String, userID: String, read mayRead: NSNumber?, write mayWrite: NSNumber?, manage mayManage: NSNumber?)

    Parameters

    realmURL

    The Realm URL whose permissions settings should be changed. Use * to change the permissions of all Realms managed by the Management Realm’s RLMSyncUser.
    userID

    The user or users who should be granted these permission changes. Use * to change the permissions for all users.
    mayRead

    Define read access. Set to YES or NO to update this value. Leave unset to preserve the existing setting.
    mayWrite

    Define write access. Set to YES or NO to update this value. Leave unset to preserve the existing setting.
    mayManage

    Define management access. Set to YES or NO to update this value. Leave unset to preserve the existing setting.
    Show on GitHub