Class: Ably::Rest::Push

Inherits:
Object
  • Object
show all
Includes:
Modules::Conversions
Defined in:
lib/ably/rest/push.rb,
lib/ably/rest/push/admin.rb,
lib/ably/rest/push/device_registrations.rb,
lib/ably/rest/push/channel_subscriptions.rb

Overview

Class providing push notification functionality

Defined Under Namespace

Classes: Admin, ChannelSubscriptions, DeviceRegistrations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Push

Returns a new instance of Push


12
13
14
# File 'lib/ably/rest/push.rb', line 12

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientObject (readonly)


10
11
12
# File 'lib/ably/rest/push.rb', line 10

def client
  @client
end

Instance Method Details

#activate(*arg) ⇒ Object

Note:

This is unsupported in the Ruby library

Activate this device for push notifications by registering with the push transport such as GCM/APNS


25
26
27
# File 'lib/ably/rest/push.rb', line 25

def activate(*arg)
  raise_unsupported
end

#adminAbly::Rest::Push::Admin

Admin features for push notifications like managing devices and channel subscriptions


18
19
20
# File 'lib/ably/rest/push.rb', line 18

def admin
  @admin ||= Admin.new(self)
end

#deactivate(*arg) ⇒ Object

Note:

This is unsupported in the Ruby library

Deactivate this device for push notifications by removing the registration with the push transport such as GCM/APNS


32
33
34
# File 'lib/ably/rest/push.rb', line 32

def deactivate(*arg)
  raise_unsupported
end