Class: Vk::API::Wall::Methods::Search

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

Overview

Allows to search posts on user or community walls.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    user or community id. ; "Remember that for a community 'owner_id' must be negative."

  • :domain (String)

    user or community screen name.

  • :query (String)

    search query string.

  • :owners_only (Boolean)

    '1' – returns only page owner's posts.

  • :count (Integer)

    count of posts to return.

  • :extended (Boolean)

    show extended post info.

  • :fields (Array)

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

Instance Method Details

#countInteger

Returns count of posts to return.

Returns:

  • (Integer)

    count of posts to return.


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

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

#domainString

Returns user or community screen name.

Returns:

  • (String)

    user or community screen name.


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

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

#extendedBoolean

Returns show extended post info.

Returns:

  • (Boolean)

    show extended post info.


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

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

#fieldsArray


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

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

#owner_idInteger

Returns user or community id. ; "Remember that for a community 'owner_id' must be negative.".

Returns:

  • (Integer)

    user or community id. ; "Remember that for a community 'owner_id' must be negative."


29
# File 'lib/vk/api/wall/methods/search.rb', line 29

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

#owners_onlyBoolean

Returns '1' – returns only page owner's posts.

Returns:

  • (Boolean)

    '1' – returns only page owner's posts.


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

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

#queryString

Returns search query string.

Returns:

  • (String)

    search query string.


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

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