Class: Vk::API::Photos::Methods::Get

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

Overview

Returns a list of a user's or community's photos.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

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

  • :album_id (String)

    Photo album ID. To return information about photos from service albums, use the following string values: 'profile, wall, saved'.

  • :photo_ids (Array)

    Photo IDs.

  • :rev (Boolean)

    Sort order:; '1' — reverse chronological; '0' — chronological

  • :extended (Boolean)

    '1' — to return additional 'likes', 'comments', and 'tags' fields; '0' — (default)

  • :feed_type (String)

    Type of feed obtained in 'feed' field of the method.

  • :feed (Integer)

    unixtime, that can be obtained with method in date field to get all photos uploaded by the user on a specific day, or photos the user has been tagged on. Also, 'uid' parameter of the user the event happened with shall be specified.

  • :photo_sizes (Boolean)

    '1' — to return photo sizes in a

  • :offset (Integer)
  • :count (Integer)

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

Instance Method Details

#album_idString

Returns Photo album ID. To return information about photos from service albums, use the following string values: 'profile, wall, saved'.

Returns:

  • (String)

    Photo album ID. To return information about photos from service albums, use the following string values: 'profile, wall, saved'.


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

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

#countInteger


50
# File 'lib/vk/api/photos/methods/get.rb', line 50

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

#extendedBoolean

Returns '1' — to return additional 'likes', 'comments', and 'tags' fields; '0' — (default).

Returns:

  • (Boolean)

    '1' — to return additional 'likes', 'comments', and 'tags' fields; '0' — (default)


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

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

#feedInteger

Returns unixtime, that can be obtained with method in date field to get all photos uploaded by the user on a specific day, or photos the user has been tagged on. Also, 'uid' parameter of the user the event happened with shall be specified.

Returns:

  • (Integer)

    unixtime, that can be obtained with method in date field to get all photos uploaded by the user on a specific day, or photos the user has been tagged on. Also, 'uid' parameter of the user the event happened with shall be specified.


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

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

#feed_typeString

Returns Type of feed obtained in 'feed' field of the method.

Returns:

  • (String)

    Type of feed obtained in 'feed' field of the method.


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

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

#offsetInteger


48
# File 'lib/vk/api/photos/methods/get.rb', line 48

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

#owner_idInteger

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

Returns:

  • (Integer)

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


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

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

#photo_idsArray

Returns Photo IDs.

Returns:

  • (Array)

    Photo IDs.


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

attribute :photo_ids, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#photo_sizesBoolean

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

Returns:

  • (Boolean)

    '1' — to return photo sizes in a


46
# File 'lib/vk/api/photos/methods/get.rb', line 46

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

#revBoolean

Returns Sort order:; '1' — reverse chronological; '0' — chronological.

Returns:

  • (Boolean)

    Sort order:; '1' — reverse chronological; '0' — chronological


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

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