Class: Vk::API::Photos::Methods::GetUserPhotos

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

Overview

Returns a list of photos in which a user is tagged.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :user_id (Integer) —

    User ID.

  • :offset (Integer) —

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

  • :count (Integer) —

    Number of photos to return. Maximum value is 100.

  • :extended (Boolean) —

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

  • :sort (String) —

    Sort order:; '1' — by date the tag was added in ascending order; '0' — by date the tag was added in descending order




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

Instance Method Details

#count ⇒ Integer

Returns Number of photos to return. Maximum value is 100.

Returns:

  • (Integer) —

    Number of photos to return. Maximum value is 100.



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

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

#extended ⇒ Boolean

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

Returns:

  • (Boolean) —

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



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

attribute :extended, 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'.



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

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

#sort ⇒ String

Returns Sort order:; '1' — by date the tag was added in ascending order; '0' — by date the tag was added in descending order.

Returns:

  • (String) —

    Sort order:; '1' — by date the tag was added in ascending order; '0' — by date the tag was added in descending order



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

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

#user_id ⇒ Integer

Returns User ID.

Returns:

  • (Integer) —

    User ID.



27
 
# File 'lib/vk/api/photos/methods/get_user_photos.rb', line 27

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