Class: Dirigible::DeviceRegistration

Inherits:

Object

• Object
• Dirigible::DeviceRegistration

Defined in:

lib/dirigible/device_registration.rb

Class Method Summary

• .delete_device_pin(id) ⇒ Object

  Deactivate the PIN and clear metadata.

• .delete_device_token(id) ⇒ Object

  Deactivate the device token and clear metadata.

• .register_apid(id, options = {}) ⇒ Object

  Register the APID and options with Urban Airship.

• .register_device_pin(id, options = {}) ⇒ Object

  Register this PIN with this application.

• .register_device_token(id, options = {}) ⇒ Object

  Register the device token with this application.

Class Method Details

.delete_device_pin(id) ⇒ Object

Deactivate the PIN and clear metadata. Pushes will not be sent to inactive PINs. A future registration will reactivate the PIN.

Examples:

Example request:

Dirigible::DeviceRegistration.delete_device_pin('12345678')

See Also:

• http://docs.urbanairship.com/reference/api/v3/registration.html#blackberry-pin-registration

# File 'lib/dirigible/device_registration.rb', line 76

def self.delete_device_pin(id)
  Dirigible.delete("/device_pins/#{id}")
end

.delete_device_token(id) ⇒ Object

Deactivate the device token and clear metadata. Pushes will not be sent to inactive device tokens. A future registration will reactivate the device token.

Examples:

Example request:

Dirigible::DeviceRegistration.delete_device_token('FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660')

See Also:

• http://docs.urbanairship.com/reference/api/v3/registration.html#device-token-registration

# File 'lib/dirigible/device_registration.rb', line 34

def self.delete_device_token(id)
  Dirigible.delete("/device_tokens/#{id}")
end

.register_apid(id, options = {}) ⇒ Object

Register the APID and options with Urban Airship.

Examples:

Example request:

Dirigible::DeviceRegistration.register_apid('11111111-1111-1111-1111-111111111111', {
  alias: "example_alias",
  tags: ["tag1", "tag2"]
})

See Also:

• http://docs.urbanairship.com/reference/api/v3/registration.html#apid-registration

# File 'lib/dirigible/device_registration.rb', line 47

def self.register_apid(id, options = {})
  Dirigible.put("/apids/#{id}", options)
end

.register_device_pin(id, options = {}) ⇒ Object

Register this PIN with this application. This will mark the PIN as active in our system. Optionally set metadata.

Examples:

Example request:

Dirigible::DeviceRegistration.register_device_pin('12345678')

Full capability:

Dirigible::DeviceRegistration.register_device_pin('12345678', {
  alias: "your_user_id",
  tags: ["tag1", "tag2"]
})

See Also:

• http://docs.urbanairship.com/reference/api/v3/registration.html#blackberry-pin-registration

# File 'lib/dirigible/device_registration.rb', line 64

def self.register_device_pin(id, options = {})
  Dirigible.put("/device_pins/#{id}", options)
end

.register_device_token(id, options = {}) ⇒ Object

Register the device token with this application. This will mark the device token as active in our system. Optionally set metadata.

Examples:

Example request:

Dirigible::DeviceRegistration.register_device_token('FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660')

Full capability:

Dirigible::DeviceRegistration.register_device_token('FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660', {
  alias: "your_user_id",
  tags: ["tag1", "tag2"],
  badge: 2,
  quiettime: {
    start: "22:00",
    end: "8:00"
  },
  tz: "America/Los_Angeles"
})

See Also:

• http://docs.urbanairship.com/reference/api/v3/registration.html#device-token-registration

# File 'lib/dirigible/device_registration.rb', line 22

def self.register_device_token(id, options = {})
  Dirigible.put("/device_tokens/#{id}", options)
end