Class: Vk::API::Friends::Methods::AddList

Inherits:

Schema::Method

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

Defined in:

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

Overview

Creates a new friend list for the current user.

Arguments

• #name ⇒ String

  Name of the friend list.

• #user_ids ⇒ Array

  IDs of users to be added to the friend list.;.

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :name (String) —

  Name of the friend list.

• :user_ids (Array) —

  IDs of users to be added to the friend list.;

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

Instance Method Details

#name ⇒ String

Returns Name of the friend list.

Returns:

• (String) —

  Name of the friend list.

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

attribute :name, API::Types::Coercible::String

#user_ids ⇒ Array

Returns IDs of users to be added to the friend list.;.

Returns:

• (Array) —

  IDs of users to be added to the friend list.;

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

attribute :user_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int).optional.default(nil)