Class: Vk::API::Newsfeed::Methods::Search

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

Overview

Returns search results by statuses.;

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :q (String)

    Search query string (e.g., 'New Year').

  • :extended (Boolean)

    '1' — to return additional information about the user or community that placed the post.

  • :count (Integer)

    Number of posts to return.

  • :latitude (Number)

    Geographical latitude point (in degrees, -90 to 90) within which to search.;

  • :longitude (Number)

    Geographical longitude point (in degrees, -180 to 180) within which to search.;

  • :start_time (Integer)

    Earliest timestamp (in Unix time) of a news item to return. By default, 24 hours ago.

  • :end_time (Integer)

    Latest timestamp (in Unix time) of a news item to return. By default, the current time.

  • :start_from (String)
  • :fields (Array)

    Additional fields of and to return.


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

Instance Method Details

#countInteger

Returns Number of posts to return.

Returns:

  • (Integer)

    Number of posts to return.


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

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

#end_timeInteger

Returns Latest timestamp (in Unix time) of a news item to return. By default, the current time.

Returns:

  • (Integer)

    Latest timestamp (in Unix time) of a news item to return. By default, the current time.


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

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

#extendedBoolean

Returns '1' — to return additional information about the user or community that placed the post.

Returns:

  • (Boolean)

    '1' — to return additional information about the user or community that placed the post.


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

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

#fieldsArray

Returns Additional fields of and to return.

Returns:

  • (Array)

    Additional fields of and to return.


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

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

#latitudeNumber

Returns Geographical latitude point (in degrees, -90 to 90) within which to search.;.

Returns:

  • (Number)

    Geographical latitude point (in degrees, -90 to 90) within which to search.;


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

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

#longitudeNumber

Returns Geographical longitude point (in degrees, -180 to 180) within which to search.;.

Returns:

  • (Number)

    Geographical longitude point (in degrees, -180 to 180) within which to search.;


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

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

#qString

Returns Search query string (e.g., 'New Year').

Returns:

  • (String)

    Search query string (e.g., 'New Year').


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

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

#start_fromString


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

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

#start_timeInteger

Returns Earliest timestamp (in Unix time) of a news item to return. By default, 24 hours ago.

Returns:

  • (Integer)

    Earliest timestamp (in Unix time) of a news item to return. By default, 24 hours ago.


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

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