SyncError

extension SyncError
Show on GitHub

  • An opaque token allowing the user to take action after certain types of errors have been reported.

    See

    RLMSyncErrorActionToken

    Declaration

    Swift

    public typealias ActionToken = RLMSyncErrorActionToken
    Show on GitHub

  • Given a client reset error, extract and return the recovery file path and the action token.

    The action token can be passed into SyncSession.immediatelyHandleError(_:) to immediately delete the local copy of the Realm which experienced the client reset error. The local copy of the Realm must be deleted before your application attempts to open the Realm again.

    The recovery file path is the path to which the current copy of the Realm on disk will be saved once the client reset occurs.

    Warning

    Do not call SyncSession.immediatelyHandleError(_:) until you are sure that all references to the Realm and managed objects belonging to the Realm have been nil'ed out, and that all autorelease pools containing these references have been drained.

    See

    SyncError.ActionToken, SyncSession.immediatelyHandleError(_:)

    Declaration

    Swift

    public func clientResetInfo() -> (String, SyncError.ActionToken)?
    Show on GitHub

  • Given a permission denied error, extract and return the action token.

    This action token can be passed into SyncSession.immediatelyHandleError(_:) to immediately delete the local copy of the Realm which experienced the permission denied error. The local copy of the Realm must be deleted before your application attempts to open the Realm again.

    Warning

    Do not call SyncSession.immediatelyHandleError(_:) until you are sure that all references to the Realm and managed objects belonging to the Realm have been nil'ed out, and that all autorelease pools containing these references have been drained.

    See

    SyncError.ActionToken, SyncSession.immediatelyHandleError(_:)

    Declaration

    Swift

    public func deleteRealmUserInfo() -> SyncError.ActionToken?
    Show on GitHub

  • Sync errors which originate from the server also produce server-side logs which may contain useful information. When applicable, this field contains the url of those logs, and nil otherwise.

    Declaration

    Swift

    public var serverLogURL: URL? { get }
    Show on GitHub

  • Extended information about what was reverted for .writeRejected errors.

    Declaration

    Swift

    public var compensatingWriteInfo: [CompensatingWriteInfo]? { get }
    Show on GitHub