Class: Line::Bot::V2::Webhook::UserMentionee

Inherits:
Mentionee
  • Object
show all
Defined in:
lib/line/bot/v2/webhook/model/user_mentionee.rb

Overview

Mentioned target is user

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(index:, length:, user_id: nil, is_self: nil, **dynamic_attributes) ⇒ UserMentionee

Returns a new instance of UserMentionee.

Parameters:

  • index (Integer) —

    Index position of the user mention for a character in text, with the first character being at position 0.

  • length (Integer) —

    The length of the text of the mentioned user. For a mention @example, 8 is the length.

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

    User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information.

  • is_self (Boolean, nil) (defaults to: nil) —

    Whether the mentioned user is the bot that receives the webhook.



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
 
# File 'lib/line/bot/v2/webhook/model/user_mentionee.rb', line 38

def initialize(
  index:,
  length:,
  user_id: nil,
  is_self: nil,
  **dynamic_attributes
)
  @type = "user"
  
  @index = index
  @length = length
  @user_id = user_id
  @is_self = is_self

  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

#index ⇒ Integer

Returns Index position of the user mention for a character in text, with the first character being at position 0.

Returns:

  • (Integer) —

    Index position of the user mention for a character in text, with the first character being at position 0.



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

def index
  @index
end

#is_self ⇒ Boolean?

Returns Whether the mentioned user is the bot that receives the webhook.

Returns:

  • (Boolean, nil) —

    Whether the mentioned user is the bot that receives the webhook.



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

def is_self
  @is_self
end

#length ⇒ Integer

Returns The length of the text of the mentioned user. For a mention @example, 8 is the length.

Returns:

  • (Integer) —

    The length of the text of the mentioned user. For a mention @example, 8 is the length.



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

def length
  @length
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



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

def type
  @type
end

#user_id ⇒ String?

Returns User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information.

Returns:

  • (String, nil) —

    User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information.



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

def user_id
  @user_id
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



68
69
70
71
 
# File 'lib/line/bot/v2/webhook/model/user_mentionee.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

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



75
76
77
78
79
80
81
 
# File 'lib/line/bot/v2/webhook/model/user_mentionee.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

#hash ⇒ Integer

Returns Hash code of the object.

Returns:

  • (Integer) —

    Hash code of the object



84
85
86
 
# File 'lib/line/bot/v2/webhook/model/user_mentionee.rb', line 84

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