Class: Vk::API::Friends::Methods::EditList

Inherits:
Schema::Method
  • Object
show all
Defined in:
lib/vk/api/friends/methods/edit_list.rb

Overview

Edits a friend list of the current user.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :name (String) —

    Name of the friend list.

  • :list_id (Integer) —

    Friend list ID.

  • :user_ids (Array) —

    IDs of users in the friend list.

  • :add_user_ids (Array) — default: Applies if 'user_ids' parameter is not set. —

    ; User IDs to add to the friend list.

  • :delete_user_ids (Array) — default: Applies if 'user_ids' parameter is not set. —

    ; User IDs to delete from the friend list.




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

Instance Method Details

#add_user_ids ⇒ Array

Returns (Applies if 'user_ids' parameter is not set.); User IDs to add to the friend list.

Returns:

  • (Array) —

    (Applies if 'user_ids' parameter is not set.); User IDs to add to the friend list.



33
 
# File 'lib/vk/api/friends/methods/edit_list.rb', line 33

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

#delete_user_ids ⇒ Array

Returns (Applies if 'user_ids' parameter is not set.); User IDs to delete from the friend list.

Returns:

  • (Array) —

    (Applies if 'user_ids' parameter is not set.); User IDs to delete from the friend list.



35
 
# File 'lib/vk/api/friends/methods/edit_list.rb', line 35

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

#list_id ⇒ Integer

Returns Friend list ID.

Returns:

  • (Integer) —

    Friend list ID.



29
 
# File 'lib/vk/api/friends/methods/edit_list.rb', line 29

attribute :list_id, API::Types::Coercible::Int

#name ⇒ String

Returns Name of the friend list.

Returns:

  • (String) —

    Name of the friend list.



27
 
# File 'lib/vk/api/friends/methods/edit_list.rb', line 27

attribute :name, API::Types::Coercible::String.optional.default(nil)

#user_ids ⇒ Array

Returns IDs of users in the friend list.

Returns:

  • (Array) —

    IDs of users in the friend list.



31
 
# File 'lib/vk/api/friends/methods/edit_list.rb', line 31

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