Class: Line::Bot::V2::Module::AcquireChatControlRequest

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

Overview

Request entity of the Acquire Control API

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(expired: nil, ttl: nil, **dynamic_attributes) ⇒ AcquireChatControlRequest

Returns a new instance of AcquireChatControlRequest.

Parameters:

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

    ‘True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There’s no time limit and the initiative (Chat Control) doesn’t change over time.

  • ttl (Integer, nil) (defaults to: nil) —

    The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/line/bot/v2/module/model/acquire_chat_control_request.rb', line 26

def initialize(
  expired: nil,
  ttl: nil,
  **dynamic_attributes
)
  
  @expired = expired
  @ttl = ttl

  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

#expired ⇒ Boolean?

Returns ‘True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There’s no time limit and the initiative (Chat Control) doesn’t change over time.

Returns:

  • (Boolean, nil) —

    ‘True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There’s no time limit and the initiative (Chat Control) doesn’t change over time.



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

def expired
  @expired
end

#ttl ⇒ Integer?

Returns The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false.

Returns:

  • (Integer, nil) —

    The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false.



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

def ttl
  @ttl
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



51
52
53
54
 
# File 'lib/line/bot/v2/module/model/acquire_chat_control_request.rb', line 51

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



58
59
60
61
62
63
64
 
# File 'lib/line/bot/v2/module/model/acquire_chat_control_request.rb', line 58

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



67
68
69
 
# File 'lib/line/bot/v2/module/model/acquire_chat_control_request.rb', line 67

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