Class: Vk::API::Friends::Methods::GetLists

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Friends::Methods::GetLists

Defined in:

lib/vk/api/friends/methods/get_lists.rb

Overview

Returns a list of the user's friend lists.

Arguments

• #return_system ⇒ Boolean

  '1' — to return system friend lists.

• #user_id ⇒ Integer

  User ID.

Instance Method Summary

• #initialize(arguments) ⇒ Friends::Methods::GetLists constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Friends::Methods::GetLists

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :user_id (Integer) —

  User ID.

• :return_system (Boolean) —

  '1' — to return system friend lists. By default: '0'.

# File 'lib/vk/api/friends/methods/get_lists.rb', line 15

Instance Method Details

#return_system ⇒ Boolean

Returns '1' — to return system friend lists. By default: '0'.

Returns:

• (Boolean) —

  '1' — to return system friend lists. By default: '0'.

# File 'lib/vk/api/friends/methods/get_lists.rb', line 26

attribute :return_system, API::Types::Form::Bool.optional.default(nil)

#user_id ⇒ Integer

Returns User ID.

Returns:

• (Integer) —

  User ID.

# File 'lib/vk/api/friends/methods/get_lists.rb', line 24

attribute :user_id, API::Types::Coercible::Int.optional.default(nil)