Class: Vk::API::Video::Methods::GetAlbums

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

Overview

Returns a list of video albums owned by a user or community.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video album(s).

  • :offset (Integer)

    Offset needed to return a specific subset of video albums.

  • :count (Integer)

    Number of video albums to return.

  • :extended (Boolean)

    '1' — to return additional information about album privacy settings for the current user


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

Instance Method Details

#countInteger

Returns Number of video albums to return.

Returns:

  • (Integer)

    Number of video albums to return.


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

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

#extendedBoolean

Returns '1' — to return additional information about album privacy settings for the current user.

Returns:

  • (Boolean)

    '1' — to return additional information about album privacy settings for the current user


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

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

#offsetInteger

Returns Offset needed to return a specific subset of video albums.

Returns:

  • (Integer)

    Offset needed to return a specific subset of video albums.


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

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

#owner_idInteger

Returns ID of the user or community that owns the video album(s).

Returns:

  • (Integer)

    ID of the user or community that owns the video album(s).


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

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