Class: Line::Bot::V2::MessagingApi::GetJoinedMembershipUsersResponse

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

Overview

List of users who have joined the membership

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_ids:, _next: nil, **dynamic_attributes) ⇒ GetJoinedMembershipUsersResponse

Returns a new instance of GetJoinedMembershipUsersResponse.

Parameters:

  • user_ids (Array[String]) —

    A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned.

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

    A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren’t returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).



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/messaging_api/model/get_joined_membership_users_response.rb', line 26

def initialize(
  user_ids:,
  _next: nil,
  **dynamic_attributes
)
  
  @user_ids = user_ids
  @_next = _next

  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

#_next ⇒ String?

Returns A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren’t returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).

Returns:

  • (String, nil) —

    A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren’t returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).



22
23
24
 
# File 'lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb', line 22

def _next
  @_next
end

#user_ids ⇒ Array[String]

Returns A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned.

Returns:

  • (Array[String]) —

    A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned.



19
20
21
 
# File 'lib/line/bot/v2/messaging_api/model/get_joined_membership_users_response.rb', line 19

def user_ids
  @user_ids
end

Class Method Details

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

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/messaging_api/model/get_joined_membership_users_response.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/messaging_api/model/get_joined_membership_users_response.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/messaging_api/model/get_joined_membership_users_response.rb', line 67

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