Class: Knockapi::Models::Recipients::PushChannelDataDevicesOnly::Device

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/recipients/push_channel_data_devices_only.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(token:, locale: nil, timezone: nil) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Recipients::PushChannelDataDevicesOnly::Device for more details.

Parameters:

  • token (String) —

    The device token to send the push notification to.

  • locale (String, nil) (defaults to: nil) —

    The locale of the object. Used for [message localization](/concepts/translations

  • timezone (String, nil) (defaults to: nil) —

    The timezone of the object. Must be a valid [tz database time zone string](https



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/knockapi/models/recipients/push_channel_data_devices_only.rb', line 23

class Device < Knockapi::Internal::Type::BaseModel
  # @!attribute token
  #   The device token to send the push notification to.
  #
  #   @return [String]
  required :token, String

  # @!attribute locale
  #   The locale of the object. Used for
  #   [message localization](/concepts/translations).
  #
  #   @return [String, nil]
  optional :locale, String, nil?: true

  # @!attribute timezone
  #   The timezone of the object. Must be a
  #   valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
  #   Used
  #   for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
  #
  #   @return [String, nil]
  optional :timezone, String, nil?: true

  # @!method initialize(token:, locale: nil, timezone: nil)
  #   Some parameter documentations has been truncated, see
  #   {Knockapi::Models::Recipients::PushChannelDataDevicesOnly::Device} for more
  #   details.
  #
  #   @param token [String] The device token to send the push notification to.
  #
  #   @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
  #
  #   @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
end

Instance Attribute Details

#locale ⇒ String?

The locale of the object. Used for [message localization](/concepts/translations).

Returns:

  • (String, nil) 


35
 
# File 'lib/knockapi/models/recipients/push_channel_data_devices_only.rb', line 35

optional :locale, String, nil?: true

#timezone ⇒ String?

The timezone of the object. Must be a valid [tz database time zone string](en.wikipedia.org/wiki/List_of_tz_database_time_zones). Used for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).

Returns:

  • (String, nil) 


44
 
# File 'lib/knockapi/models/recipients/push_channel_data_devices_only.rb', line 44

optional :timezone, String, nil?: true

#token ⇒ String

The device token to send the push notification to.

Returns:

  • (String) 


28
 
# File 'lib/knockapi/models/recipients/push_channel_data_devices_only.rb', line 28

required :token, String