Class: Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull::Device

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/knockapi/models/recipients/channel_data.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(devices:, target_arns:) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull for more details.

AWS SNS push channel data.

Parameters:



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/knockapi/models/recipients/channel_data.rb', line 155

class Device < Knockapi::Internal::Type::BaseModel
  # @!attribute target_arn
  #   The ARN of a platform endpoint associated with a platform application and a
  #   device token. See
  #   [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
  #
  #   @return [String]
  required :target_arn, 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(target_arn:, locale: nil, timezone: nil)
  #   Some parameter documentations has been truncated, see
  #   {Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull::Device}
  #   for more details.
  #
  #   @param target_arn [String] The ARN of a platform endpoint associated with a platform application and a devi
  #
  #   @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) 


169
 
# File 'lib/knockapi/models/recipients/channel_data.rb', line 169

optional :locale, String, nil?: true

#target_arn ⇒ String

The ARN of a platform endpoint associated with a platform application and a device token. See [Setting up an Amazon SNS platform endpoint for mobile notifications](docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).

Returns:

  • (String) 


162
 
# File 'lib/knockapi/models/recipients/channel_data.rb', line 162

required :target_arn, String

#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) 


178
 
# File 'lib/knockapi/models/recipients/channel_data.rb', line 178

optional :timezone, String, nil?: true