Class: Vk::API::Photos::Methods::Search

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

Overview

Returns a list of photos.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :q (String)

    Search query string.

  • :lat (Number)

    Geographical latitude, in degrees (from '-90' to '90').

  • :long (Number)

    Geographical longitude, in degrees (from '-180' to '180').;

  • :start_time (Integer)
  • :end_time (Integer)
  • :sort (Integer)

    Sort order:

  • :offset (Integer)

    Offset needed to return a specific subset of photos.

  • :count (Integer)

    Number of photos to return.

  • :radius (Integer)

    Radius of search in meters (works very approximately). Available values: '10', '100', '800', '6000', '50000'.


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

Instance Method Details

#countInteger

Returns Number of photos to return.

Returns:

  • (Integer)

    Number of photos to return.


45
# File 'lib/vk/api/photos/methods/search.rb', line 45

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

#end_timeInteger

Returns:

  • (Integer)

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

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

#latNumber

Returns Geographical latitude, in degrees (from '-90' to '90').

Returns:

  • (Number)

    Geographical latitude, in degrees (from '-90' to '90').


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

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

#longNumber

Returns Geographical longitude, in degrees (from '-180' to '180').;.

Returns:

  • (Number)

    Geographical longitude, in degrees (from '-180' to '180').;


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

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

#offsetInteger

Returns Offset needed to return a specific subset of photos.

Returns:

  • (Integer)

    Offset needed to return a specific subset of photos.


43
# File 'lib/vk/api/photos/methods/search.rb', line 43

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

#qString

Returns Search query string.

Returns:

  • (String)

    Search query string.


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

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

#radiusInteger

Returns Radius of search in meters (works very approximately). Available values: '10', '100', '800', '6000', '50000'.

Returns:

  • (Integer)

    Radius of search in meters (works very approximately). Available values: '10', '100', '800', '6000', '50000'.


47
# File 'lib/vk/api/photos/methods/search.rb', line 47

attribute :radius, API::Types::Coercible::Int.optional.default(5000)

#sortInteger

Returns Sort order:.

Returns:

  • (Integer)

    Sort order:


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

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

#start_timeInteger

Returns:

  • (Integer)

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

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