iOS/Pods/Realm/include/NSError+RLMSync.h

   1 ////////////////////////////////////////////////////////////////////////////
   2 //
   3 // Copyright 2017 Realm Inc.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 // http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 ////////////////////////////////////////////////////////////////////////////
  18
  19 #import <Foundation/Foundation.h>
  20
  21 NS_ASSUME_NONNULL_BEGIN
  22
  23 @class RLMSyncErrorActionToken;
  24
  25 /// NSError category extension providing methods to get data out of Realm's
  26 /// "client reset" error.
  27 @interface NSError (RLMSync)
  28
  29 /**
  30  Given an appropriate Realm Object Server error, return the token that
  31  can be passed into `+[RLMSyncSession immediatelyHandleError:]` to
  32  immediately perform error clean-up work, or nil if the error isn't of
  33  a type that provides a token.
  34  */
  35 - (nullable RLMSyncErrorActionToken *)rlmSync_errorActionToken NS_REFINED_FOR_SWIFT;
  36
  37 /**
  38  Given a Realm Object Server client reset error, return the path where the
  39  backup copy of the Realm will be placed once the client reset process is
  40  complete.
  41  */
  42 - (nullable NSString *)rlmSync_clientResetBackedUpRealmPath NS_SWIFT_UNAVAILABLE("");
  43
  44 @end
  45
  46 NS_ASSUME_NONNULL_END