iOS/Pods/Realm/include/RLMRealm+Sync.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 #import "RLMRealm.h"
  22
  23 @class RLMResults;
  24
  25 /**
  26  A callback used to vend the results of a partial sync fetch.
  27  */
  28 typedef void(^RLMPartialSyncFetchCallback)(RLMResults * _Nullable results, NSError * _Nullable error);
  29
  30 NS_ASSUME_NONNULL_BEGIN
  31
  32 ///
  33 @interface RLMRealm (Sync)
  34
  35 /**
  36  If the Realm is a partially synchronized Realm, fetch and synchronize the objects
  37  of a given object type that match the given query (in string format).
  38
  39  The results will be returned asynchronously in the callback.
  40  Use `-[RLMResults addNotificationBlock:]` to be notified to changes to the set of
  41  synchronized objects.
  42
  43  @warning Partial synchronization is a tech preview. Its APIs are subject to change.
  44 */
  45 - (void)subscribeToObjects:(Class)type where:(NSString *)query callback:(RLMPartialSyncFetchCallback)callback;
  46
  47 @end
  48
  49 NS_ASSUME_NONNULL_END