lib/ably/realtime/push.rb in ably-1.2.2 vs lib/ably/realtime/push.rb in ably-1.2.3
- old
+ new
@@ -9,30 +9,42 @@
def initialize(client)
@client = client
end
- # Admin features for push notifications like managing devices and channel subscriptions
+ # A {Ably::Realtime::Push::Admin} object.
+ #
+ # @spec RSH1
+ #
# @return [Ably::Realtime::Push::Admin]
+ #
def admin
@admin ||= Admin.new(self)
end
- # Activate this device for push notifications by registering with the push transport such as GCM/APNS
+ # Activates the device for push notifications with FCM or APNS, obtaining a unique identifier from them.
+ # Subsequently registers the device with Ably and stores the deviceIdentityToken in local storage.
#
+ # @spec RSH2a
+ #
# @note This is unsupported in the Ruby library
+ #
def activate(*arg)
raise_unsupported
end
- # Deactivate this device for push notifications by removing the registration with the push transport such as GCM/APNS
+ # Deactivates the device from receiving push notifications with Ably and FCM or APNS.
#
+ # @spec RSH2b
+ #
# @note This is unsupported in the Ruby library
+ #
def deactivate(*arg)
raise_unsupported
end
private
+
def raise_unsupported
raise Ably::Exceptions::PushNotificationsNotSupported, 'This device does not support receiving or subscribing to push notifications. All PushChannel methods are unavailable'
end
end
end