Class: Vk::API::Newsfeed::Methods::SaveList

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

Overview

Creates and edits user newsfeed lists

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Newsfeed::Methods::SaveList

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :list_id (Integer)

    numeric list identifier (if not sent, will be set automatically).

  • :title (String)

    list name.

  • :source_ids (Array)

    users and communities identifiers to be added to the list. Community identifiers must be negative numbers.

  • :no_reposts (Boolean)

    reposts display on and off ('1' is for off).


# File 'lib/vk/api/newsfeed/methods/save_list.rb', line 15

Instance Method Details

#list_idInteger

Returns numeric list identifier (if not sent, will be set automatically).

Returns:

  • (Integer)

    numeric list identifier (if not sent, will be set automatically).


26
# File 'lib/vk/api/newsfeed/methods/save_list.rb', line 26

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

#no_repostsBoolean

Returns reposts display on and off ('1' is for off).

Returns:

  • (Boolean)

    reposts display on and off ('1' is for off).


32
# File 'lib/vk/api/newsfeed/methods/save_list.rb', line 32

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

#source_idsArray

Returns users and communities identifiers to be added to the list. Community identifiers must be negative numbers.

Returns:

  • (Array)

    users and communities identifiers to be added to the list. Community identifiers must be negative numbers.


30
# File 'lib/vk/api/newsfeed/methods/save_list.rb', line 30

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

#titleString

Returns list name.

Returns:

  • (String)

    list name.


28
# File 'lib/vk/api/newsfeed/methods/save_list.rb', line 28

attribute :title, API::Types::Coercible::String