Class: Vk::API::Photos::Methods::GetAlbums
- Inherits:
-
Schema::Method
- Object
- Dry::Struct
- Schema::Method
- Vk::API::Photos::Methods::GetAlbums
- 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
-
#album_ids ⇒ Array
Album IDs.
-
#count ⇒ Integer
Number of albums to return.
-
#need_covers ⇒ Boolean
'1' — to return an additional 'thumb_src' field; '0' — (default).
-
#need_system ⇒ Boolean
'1' — to return system albums with negative IDs.
-
#offset ⇒ Integer
Offset needed to return a specific subset of albums.
-
#owner_id ⇒ Integer
ID of the user or community that owns the albums.
-
#photo_sizes ⇒ Boolean
'1' — to return photo sizes in a.
Instance Method Summary collapse
Methods inherited from Schema::Method
Constructor Details
#initialize(arguments) ⇒ Photos::Methods::GetAlbums
|
# File 'lib/vk/api/photos/methods/get_albums.rb', line 15
|
Instance Method Details
#album_ids ⇒ Array
Returns 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) |
#count ⇒ Integer
Returns 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_covers ⇒ Boolean
Returns '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_system ⇒ Boolean
Returns '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) |
#offset ⇒ Integer
Returns 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) |