Class: Line::Bot::V2::MessagingApi::BotInfoResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/line/bot/v2/messaging_api/model/bot_info_response.rb

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_id:, basic_id:, premium_id: nil, display_name:, picture_url: nil, chat_mode:, mark_as_read_mode:, **dynamic_attributes) ⇒ BotInfoResponse

Returns a new instance of BotInfoResponse.

Parameters:

  • user_id (String) —

    Bot’s user ID

  • basic_id (String) —

    Bot’s basic ID

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

    Bot’s premium ID. Not included in the response if the premium ID isn’t set.

  • display_name (String) —

    Bot’s display name

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

    Profile image URL. ‘https` image URL. Not included in the response if the bot doesn’t have a profile image.

  • chat_mode (String) —

    (‘chat’|‘bot’) Chat settings set in the LINE Official Account Manager. One of: ‘chat`: Chat is set to "On". `bot`: Chat is set to "Off".

  • mark_as_read_mode (String) —

    (‘auto’|‘manual’) Automatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned. ‘auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 45

def initialize(
  user_id:,
  basic_id:,
  premium_id: nil,
  display_name:,
  picture_url: nil,
  chat_mode:,
  mark_as_read_mode:,
  **dynamic_attributes
)
  
  @user_id = user_id
  @basic_id = basic_id
  @premium_id = premium_id
  @display_name = display_name
  @picture_url = picture_url
  @chat_mode = chat_mode
  @mark_as_read_mode = mark_as_read_mode

  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

#basic_id ⇒ String

Returns Bot’s basic ID.

Returns:

  • (String) —

    Bot’s basic ID



21
22
23
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 21

def basic_id
  @basic_id
end

#chat_mode ⇒ String

Returns (‘chat’|‘bot’) Chat settings set in the LINE Official Account Manager. One of: ‘chat`: Chat is set to "On". `bot`: Chat is set to "Off".

Returns:

  • (String) —

    (‘chat’|‘bot’) Chat settings set in the LINE Official Account Manager. One of: ‘chat`: Chat is set to "On". `bot`: Chat is set to "Off".



33
34
35
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 33

def chat_mode
  @chat_mode
end

#display_name ⇒ String

Returns Bot’s display name.

Returns:

  • (String) —

    Bot’s display name



27
28
29
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 27

def display_name
  @display_name
end

#mark_as_read_mode ⇒ String

Returns (‘auto’|‘manual’) Automatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned. ‘auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled.

Returns:

  • (String) —

    (‘auto’|‘manual’) Automatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned. ‘auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled.



36
37
38
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 36

def mark_as_read_mode
  @mark_as_read_mode
end

#picture_url ⇒ String?

Returns Profile image URL. ‘https` image URL. Not included in the response if the bot doesn’t have a profile image.

Returns:

  • (String, nil) —

    Profile image URL. ‘https` image URL. Not included in the response if the bot doesn’t have a profile image.



30
31
32
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 30

def picture_url
  @picture_url
end

#premium_id ⇒ String?

Returns Bot’s premium ID. Not included in the response if the premium ID isn’t set.

Returns:

  • (String, nil) —

    Bot’s premium ID. Not included in the response if the premium ID isn’t set.



24
25
26
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 24

def premium_id
  @premium_id
end

#user_id ⇒ String

Returns Bot’s user ID.

Returns:

  • (String) —

    Bot’s user ID



18
19
20
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 18

def user_id
  @user_id
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::MessagingApi::BotInfoResponse

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



80
81
82
83
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 80

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



87
88
89
90
91
92
93
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 87

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



96
97
98
 
# File 'lib/line/bot/v2/messaging_api/model/bot_info_response.rb', line 96

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