Class: Vk::API::Photos::Methods::GetAlbums

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

Overview

Returns a list of a user's or community's photo albums.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the albums.

  • :album_ids (Array)

    Album IDs.

  • :offset (Integer)

    Offset needed to return a specific subset of albums.

  • :count (Integer)

    Number of albums to return.

  • :need_system (Boolean)

    '1' — to return system albums with negative IDs

  • :need_covers (Boolean)

    '1' — to return an additional 'thumb_src' field; '0' — (default)

  • :photo_sizes (Boolean)

    '1' — to return photo sizes in a


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

Instance Method Details

#album_idsArray

Returns Album IDs.

Returns:

  • (Array)

    Album IDs.


31
# File 'lib/vk/api/photos/methods/get_albums.rb', line 31

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

#countInteger

Returns Number of albums to return.

Returns:

  • (Integer)

    Number of albums to return.


35
# File 'lib/vk/api/photos/methods/get_albums.rb', line 35

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

#need_coversBoolean

Returns '1' — to return an additional 'thumb_src' field; '0' — (default).

Returns:

  • (Boolean)

    '1' — to return an additional 'thumb_src' field; '0' — (default)


39
# File 'lib/vk/api/photos/methods/get_albums.rb', line 39

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

#need_systemBoolean

Returns '1' — to return system albums with negative IDs.

Returns:

  • (Boolean)

    '1' — to return system albums with negative IDs


37
# File 'lib/vk/api/photos/methods/get_albums.rb', line 37

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

#offsetInteger

Returns Offset needed to return a specific subset of albums.

Returns:

  • (Integer)

    Offset needed to return a specific subset of albums.


33
# File 'lib/vk/api/photos/methods/get_albums.rb', line 33

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

#owner_idInteger

Returns ID of the user or community that owns the albums.

Returns:

  • (Integer)

    ID of the user or community that owns the albums.


29
# File 'lib/vk/api/photos/methods/get_albums.rb', line 29

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

#photo_sizesBoolean

Returns '1' — to return photo sizes in a.

Returns:

  • (Boolean)

    '1' — to return photo sizes in a


41
# File 'lib/vk/api/photos/methods/get_albums.rb', line 41

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