Class: Line::Bot::V2::Module::ModuleBot

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

Overview

basic information about the bot.

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, **dynamic_attributes) ⇒ ModuleBot

Returns a new instance of ModuleBot.

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. Image URL starting with ‘https://`. Not included in the response if the bot doesn’t have a profile image.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 38

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

  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



22
23
24
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 22

def basic_id
  @basic_id
end

#display_name ⇒ String

Returns Bot’s display name.

Returns:

  • (String) —

    Bot’s display name



28
29
30
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 28

def display_name
  @display_name
end

#picture_url ⇒ String?

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

Returns:

  • (String, nil) —

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



31
32
33
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 31

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.



25
26
27
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 25

def premium_id
  @premium_id
end

#user_id ⇒ String

Returns Bot’s user ID.

Returns:

  • (String) —

    Bot’s user ID



19
20
21
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 19

def user_id
  @user_id
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::Module::ModuleBot

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



69
70
71
72
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 69

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



76
77
78
79
80
81
82
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 76

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



85
86
87
 
# File 'lib/line/bot/v2/module/model/module_bot.rb', line 85

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