Class: Vk::API::Newsfeed::Methods::GetSuggestedSources

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

Overview

Returns communities and users that current user is suggested to follow.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :offset (Integer) —

    offset required to choose a particular subset of communities or users.

  • :count (Integer) —

    amount of communities or users to return.

  • :shuffle (Boolean) —

    shuffle the returned list or not.

  • :fields (Array) —

    list of extra fields to be returned. See and .




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

Instance Method Details

#count ⇒ Integer

Returns amount of communities or users to return.

Returns:

  • (Integer) —

    amount of communities or users to return.



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

attribute :count, API::Types::Coercible::Int.optional.default(20)

#fields ⇒ Array

Returns list of extra fields to be returned. See and .

Returns:

  • (Array) —

    list of extra fields to be returned. See and .



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

attribute :fields, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#offset ⇒ Integer

Returns offset required to choose a particular subset of communities or users.

Returns:

  • (Integer) —

    offset required to choose a particular subset of communities or users.



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

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

#shuffle ⇒ Boolean

Returns shuffle the returned list or not.

Returns:

  • (Boolean) —

    shuffle the returned list or not.



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

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