class Line::Bot::V2::MessagingApi::MulticastRequest
@see developers.line.biz/en/reference/messaging-api/#send-multicast-message
Attributes
@!attribute [rw] custom_aggregation_units
@return [Array[String],nil] Name of aggregation unit. Case-sensitive.
@!attribute [rw] messages
@return [Array[Message]] Messages to send
@!attribute [rw] notification_disabled
@return [Boolean,nil] `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.
@!attribute [rw] to
@return [Array[String]] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE.
Public Class Methods
Source
# File lib/line/bot/v2/messaging_api/model/multicast_request.rb, line 68 def self.create(args) # steep:ignore symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args) return new(**symbolized_args) # steep:ignore end
Create an instance of the class from a hash @param args [Hash] Hash containing all the required attributes @return [Line::Bot::V2::MessagingApi::MulticastRequest] Instance of the class
Source
# File lib/line/bot/v2/messaging_api/model/multicast_request.rb, line 33 def initialize( messages:, to:, notification_disabled: false, custom_aggregation_units: nil, **dynamic_attributes ) @messages = messages.map do |item| if item.is_a?(Hash) Line::Bot::V2::MessagingApi::Message.create(**item) # steep:ignore InsufficientKeywordArguments else item end end @to = to @notification_disabled = notification_disabled @custom_aggregation_units = custom_aggregation_units dynamic_attributes.each do |key, value| self.class.attr_accessor key if value.is_a?(Hash) struct_klass = Struct.new(*value.keys.map(&:to_sym)) struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v } instance_variable_set("@#{key}", struct_klass.new(*struct_values)) else instance_variable_set("@#{key}", value) end end end
@param messages [Array[Message, Hash[Symbol, untyped]]] Messages to send @param to [Array] Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. @param notification_disabled
[Boolean,nil] ‘true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. @param custom_aggregation_units
[Array,nil] Name of aggregation unit. Case-sensitive.
Public Instance Methods
Source
# File lib/line/bot/v2/messaging_api/model/multicast_request.rb, line 75 def ==(other) return false unless self.class == other.class instance_variables.all? do |var| instance_variable_get(var) == other.instance_variable_get(var) end end
@param other [Object] Object to compare @return [Boolean] true if the objects are equal, false otherwise
Source
# File lib/line/bot/v2/messaging_api/model/multicast_request.rb, line 84 def hash [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash end
@return [Integer] Hash code of the object