You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

56 lines
2.0 KiB

6 years ago
  1. /*
  2. * Copyright 2017 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import "FIRMessagingTopicOperation.h"
  17. @class FIRMessagingCheckinService;
  18. @interface FIRMessagingPubSubRegistrar : NSObject
  19. /**
  20. * Designated Initializer.
  21. *
  22. * @param checkinService The checkin service used to register with Checkin
  23. * server.
  24. *
  25. * @return A new FIRMessagingPubSubRegistrar instance used to subscribe/unsubscribe.
  26. */
  27. - (instancetype)initWithCheckinService:(FIRMessagingCheckinService *)checkinService;
  28. /**
  29. * Stops all the subscription requests going on in parallel. This would
  30. * invalidate all the handlers associated with the subscription requests.
  31. */
  32. - (void)stopAllSubscriptionRequests;
  33. /**
  34. * Update subscription status for a given topic with FIRMessaging's backend.
  35. *
  36. * @param topic The topic to subscribe to.
  37. * @param token The registration token to be used.
  38. * @param options The options to be passed in during subscription request.
  39. * @param shouldDelete NO if the subscription is being added else YES if being
  40. * removed.
  41. * @param handler The handler invoked once the update subscription request
  42. * finishes.
  43. */
  44. - (void)updateSubscriptionToTopic:(NSString *)topic
  45. withToken:(NSString *)token
  46. options:(NSDictionary *)options
  47. shouldDelete:(BOOL)shouldDelete
  48. handler:(FIRMessagingTopicOperationCompletion)handler;
  49. @end