Class: Vk::API::Friends::Methods::Edit

Inherits:

Schema::Method

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

Defined in:

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

Overview

Edits the friend lists of the selected user.

Arguments

• #list_ids ⇒ Array

  IDs of the friend lists to which to add the user.

• #user_id ⇒ Integer

  ID of the user whose friend list is to be edited.

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :user_id (Integer) —

  ID of the user whose friend list is to be edited.

• :list_ids (Array) —

  IDs of the friend lists to which to add the user.

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

Instance Method Details

#list_ids ⇒ Array

Returns IDs of the friend lists to which to add the user.

Returns:

• (Array) —

  IDs of the friend lists to which to add the user.

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

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

#user_id ⇒ Integer

Returns ID of the user whose friend list is to be edited.

Returns:

• (Integer) —

  ID of the user whose friend list is to be edited.

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

attribute :user_id, API::Types::Coercible::Int