Class: Vk::API::Photos::Methods::GetAll

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Photos::Methods::GetAll

Defined in:

lib/vk/api/photos/methods/get_all.rb

Overview

Returns a list of photos belonging to a user or community, in reverse chronological order.

Arguments

• #count ⇒ Integer

  Number of photos to return.

• #extended ⇒ Boolean

  '1' — to return detailed information about photos.

• #need_hidden ⇒ Boolean

  '1' – to show information about photos being hidden from the block above the wall.

• #no_service_albums ⇒ Boolean

  '1' – to return photos only from standard albums; '0' – to return all photos including those in service albums, e.g., 'My wall photos' (default).

• #offset ⇒ Integer

  Offset needed to return a specific subset of photos.

• #owner_id ⇒ Integer

  ID of a user or community that owns the photos.; Use a negative value to designate a community ID.

• #photo_sizes ⇒ Boolean

  '1' – to return image sizes in .

• #skip_hidden ⇒ Boolean

  '1' – not to return photos being hidden from the block above the wall.

Instance Method Summary

• #initialize(arguments) ⇒ Photos::Methods::GetAll constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  ID of a user or community that owns the photos.; Use a negative value to designate a community ID.

• :extended (Boolean) —

  '1' — to return detailed information about photos

• :offset (Integer) —

  Offset needed to return a specific subset of photos. By default, '0'.

• :count (Integer) —

  Number of photos to return.

• :photo_sizes (Boolean) —

  '1' – to return image sizes in .

• :no_service_albums (Boolean) —

  '1' – to return photos only from standard albums; '0' – to return all photos including those in service albums, e.g., 'My wall photos' (default)

• :need_hidden (Boolean) —

  '1' – to show information about photos being hidden from the block above the wall.

• :skip_hidden (Boolean) —

  '1' – not to return photos being hidden from the block above the wall. Works only with owner_id>0, no_service_albums is ignored.

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

Instance Method Details

#count ⇒ Integer

Returns Number of photos to return.

Returns:

• (Integer) —

  Number of photos to return.

# File 'lib/vk/api/photos/methods/get_all.rb', line 36

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

#extended ⇒ Boolean

Returns '1' — to return detailed information about photos.

Returns:

• (Boolean) —

  '1' — to return detailed information about photos

# File 'lib/vk/api/photos/methods/get_all.rb', line 32

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

#need_hidden ⇒ Boolean

Returns '1' – to show information about photos being hidden from the block above the wall.

Returns:

• (Boolean) —

  '1' – to show information about photos being hidden from the block above the wall.

# File 'lib/vk/api/photos/methods/get_all.rb', line 42

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

#no_service_albums ⇒ Boolean

Returns '1' – to return photos only from standard albums; '0' – to return all photos including those in service albums, e.g., 'My wall photos' (default).

Returns:

• (Boolean) —

  '1' – to return photos only from standard albums; '0' – to return all photos including those in service albums, e.g., 'My wall photos' (default)

# File 'lib/vk/api/photos/methods/get_all.rb', line 40

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of photos. By default, '0'.

Returns:

• (Integer) —

  Offset needed to return a specific subset of photos. By default, '0'.

# File 'lib/vk/api/photos/methods/get_all.rb', line 34

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

#owner_id ⇒ Integer

Returns ID of a user or community that owns the photos.; Use a negative value to designate a community ID.

Returns:

• (Integer) —

  ID of a user or community that owns the photos.; Use a negative value to designate a community ID.

# File 'lib/vk/api/photos/methods/get_all.rb', line 30

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

#photo_sizes ⇒ Boolean

Returns '1' – to return image sizes in .

Returns:

• (Boolean) —

  '1' – to return image sizes in .

# File 'lib/vk/api/photos/methods/get_all.rb', line 38

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

#skip_hidden ⇒ Boolean

Returns '1' – not to return photos being hidden from the block above the wall. Works only with owner_id>0, no_service_albums is ignored.

Returns:

• (Boolean) —

  '1' – not to return photos being hidden from the block above the wall. Works only with owner_id>0, no_service_albums is ignored.

# File 'lib/vk/api/photos/methods/get_all.rb', line 44

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