Class: Vk::API::Video::Methods::GetCatalog

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

Overview

Returns video catalog

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Video::Methods::GetCatalog

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :count (Integer) —

    number of catalog blocks to return.

  • :items_count (Integer) —

    number of videos in each block.

  • :from (String) —

    parameter for requesting the next results page. Value for transmitting here is returned in the 'next' field in a reply.

  • :filters (Array) —

    list of requested catalog sections




# File 'lib/vk/api/video/methods/get_catalog.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns number of catalog blocks to return.

Returns:

  • (Integer) —

    number of catalog blocks to return.



26
 
# File 'lib/vk/api/video/methods/get_catalog.rb', line 26

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

#filters ⇒ Array

Returns list of requested catalog sections.

Returns:

  • (Array) —

    list of requested catalog sections



32
 
# File 'lib/vk/api/video/methods/get_catalog.rb', line 32

attribute :filters, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default([])

#from ⇒ String

Returns parameter for requesting the next results page. Value for transmitting here is returned in the 'next' field in a reply.

Returns:

  • (String) —

    parameter for requesting the next results page. Value for transmitting here is returned in the 'next' field in a reply.



30
 
# File 'lib/vk/api/video/methods/get_catalog.rb', line 30

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

#items_count ⇒ Integer

Returns number of videos in each block.

Returns:

  • (Integer) —

    number of videos in each block.



28
 
# File 'lib/vk/api/video/methods/get_catalog.rb', line 28

attribute :items_count, API::Types::Coercible::Int.optional.default(10)