Class: Line::Bot::V2::Webhook::StickerMessageContent

Inherits:
MessageContent show all
Defined in:
lib/line/bot/v2/webhook/model/sticker_message_content.rb

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, package_id:, sticker_id:, sticker_resource_type:, keywords: nil, text: nil, quote_token:, quoted_message_id: nil, mark_as_read_token: nil, **dynamic_attributes) ⇒ StickerMessageContent

Returns a new instance of StickerMessageContent.

Parameters:

  • id (String) —

    Message ID

  • package_id (String) —

    Package ID

  • sticker_id (String) —

    Sticker ID

  • sticker_resource_type (String) —

    (‘STATIC’|‘ANIMATION’|‘SOUND’|‘ANIMATION_SOUND’|‘POPUP’|‘POPUP_SOUND’|‘CUSTOM’|‘MESSAGE’|‘NAME_TEXT’|‘PER_STICKER_TEXT’)

  • keywords (Array[String], nil) (defaults to: nil) —

    Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker.

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

    Any text entered by the user. This property is only included for message stickers. Max character limit: 100

  • quote_token (String) —

    Quote token to quote this message.

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

    Message ID of a quoted message. Only included when the received message quotes a past message.

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

    Token used to mark the message as read.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 58

def initialize(
  id:,
  package_id:,
  sticker_id:,
  sticker_resource_type:,
  keywords: nil,
  text: nil,
  quote_token:,
  quoted_message_id: nil,
  mark_as_read_token: nil,
  **dynamic_attributes
)
  @type = "sticker"
  
  @id = id
  @package_id = package_id
  @sticker_id = sticker_id
  @sticker_resource_type = sticker_resource_type
  @keywords = keywords
  @text = text
  @quote_token = quote_token
  @quoted_message_id = quoted_message_id
  @mark_as_read_token = mark_as_read_token

  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

Instance Attribute Details

#id ⇒ String

Returns Message ID.

Returns:

  • (String) —

    Message ID



23
24
25
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 23

def id
  @id
end

#keywords ⇒ Array[String]?

Returns Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker.

Returns:

  • (Array[String], nil) —

    Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker.



35
36
37
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 35

def keywords
  @keywords
end

#mark_as_read_token ⇒ String?

Returns Token used to mark the message as read.

Returns:

  • (String, nil) —

    Token used to mark the message as read.



47
48
49
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 47

def mark_as_read_token
  @mark_as_read_token
end

#package_id ⇒ String

Returns Package ID.

Returns:

  • (String) —

    Package ID



26
27
28
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 26

def package_id
  @package_id
end

#quote_token ⇒ String

Returns Quote token to quote this message.

Returns:

  • (String) —

    Quote token to quote this message.



41
42
43
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 41

def quote_token
  @quote_token
end

#quoted_message_id ⇒ String?

Returns Message ID of a quoted message. Only included when the received message quotes a past message.

Returns:

  • (String, nil) —

    Message ID of a quoted message. Only included when the received message quotes a past message.



44
45
46
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 44

def quoted_message_id
  @quoted_message_id
end

#sticker_id ⇒ String

Returns Sticker ID.

Returns:

  • (String) —

    Sticker ID



29
30
31
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 29

def sticker_id
  @sticker_id
end

#sticker_resource_type ⇒ String

Returns (‘STATIC’|‘ANIMATION’|‘SOUND’|‘ANIMATION_SOUND’|‘POPUP’|‘POPUP_SOUND’|‘CUSTOM’|‘MESSAGE’|‘NAME_TEXT’|‘PER_STICKER_TEXT’).

Returns:

  • (String) —

    (‘STATIC’|‘ANIMATION’|‘SOUND’|‘ANIMATION_SOUND’|‘POPUP’|‘POPUP_SOUND’|‘CUSTOM’|‘MESSAGE’|‘NAME_TEXT’|‘PER_STICKER_TEXT’)



32
33
34
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 32

def sticker_resource_type
  @sticker_resource_type
end

#text ⇒ String?

Returns Any text entered by the user. This property is only included for message stickers. Max character limit: 100.

Returns:

  • (String, nil) —

    Any text entered by the user. This property is only included for message stickers. Max character limit: 100



38
39
40
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 38

def text
  @text
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



20
21
22
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 20

def type
  @type
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::Webhook::StickerMessageContent

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



98
99
100
101
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 98

def self.create(args) # steep:ignore
  symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
  return new(**symbolized_args) # steep:ignore
end

Instance Method Details

#==(other) ⇒ Boolean

Returns true if the objects are equal, false otherwise.

Parameters:

  • other (Object) —

    Object to compare

Returns:

  • (Boolean) —

    true if the objects are equal, false otherwise



105
106
107
108
109
110
111
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 105

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

#hash ⇒ Integer

Returns Hash code of the object.

Returns:

  • (Integer) —

    Hash code of the object



114
115
116
 
# File 'lib/line/bot/v2/webhook/model/sticker_message_content.rb', line 114

def hash
  [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
end