RLMRealm+Sync.h 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. #import <Foundation/Foundation.h>
  19. #import "RLMRealm.h"
  20. @class RLMResults, RLMSyncSession;
  21. /**
  22. A callback used to vend the results of a partial sync fetch.
  23. */
  24. typedef void(^RLMPartialSyncFetchCallback)(RLMResults * _Nullable results, NSError * _Nullable error);
  25. NS_ASSUME_NONNULL_BEGIN
  26. ///
  27. @interface RLMRealm (Sync)
  28. /**
  29. If the Realm is a partially synchronized Realm, fetch and synchronize the objects
  30. of a given object type that match the given query (in string format).
  31. The results will be returned asynchronously in the callback.
  32. Use `-[RLMResults addNotificationBlock:]` to be notified to changes to the set of
  33. synchronized objects.
  34. @warning Partial synchronization is a tech preview. Its APIs are subject to change.
  35. */
  36. - (void)subscribeToObjects:(Class)type where:(NSString *)query callback:(RLMPartialSyncFetchCallback)callback
  37. __deprecated_msg("Use -[RLMResults subscribe]");
  38. /**
  39. Get the RLMSyncSession used by this Realm. Will be nil if this is not a
  40. synchronized Realm.
  41. */
  42. @property (nonatomic, nullable, readonly) RLMSyncSession *syncSession;
  43. @end
  44. NS_ASSUME_NONNULL_END