Class: Vk::API::Groups::Methods::Search
- Inherits:
-
Schema::Method
- Object
- Dry::Struct
- Schema::Method
- Vk::API::Groups::Methods::Search
- Defined in:
- lib/vk/api/groups/methods/search.rb
Overview
Returns a list of communities matching the search criteria.
Arguments collapse
-
#city_id ⇒ Integer
City ID.
-
#count ⇒ Integer
Number of communities to return.; "Note that you can not receive more than first thousand of results, regardless of 'count' and 'offset' values.".
-
#country_id ⇒ Integer
Country ID.
-
#future ⇒ Boolean
'1' — to return only upcoming events.
-
#market ⇒ Boolean
'1' — to return communities with enabled market only.
-
#offset ⇒ Integer
Offset needed to return a specific subset of results.
-
#q ⇒ String
Search query string.
-
#sort ⇒ Integer
Sort order.
-
#type ⇒ String
Community type.
Instance Method Summary collapse
- #initialize(arguments) ⇒ Groups::Methods::Search constructor
Methods inherited from Schema::Method
Constructor Details
#initialize(arguments) ⇒ Groups::Methods::Search
|
# File 'lib/vk/api/groups/methods/search.rb', line 15
|
Instance Method Details
#city_id ⇒ Integer
Returns City ID. If this parameter is transmitted, country_id is ignored.
37 |
# File 'lib/vk/api/groups/methods/search.rb', line 37 attribute :city_id, API::Types::Coercible::Int.optional.default(nil) |
#count ⇒ Integer
Returns Number of communities to return.; "Note that you can not receive more than first thousand of results, regardless of 'count' and 'offset' values.".
47 |
# File 'lib/vk/api/groups/methods/search.rb', line 47 attribute :count, API::Types::Coercible::Int.optional.default(20) |
#country_id ⇒ Integer
Returns Country ID.
35 |
# File 'lib/vk/api/groups/methods/search.rb', line 35 attribute :country_id, API::Types::Coercible::Int.optional.default(nil) |
#future ⇒ Boolean
Returns '1' — to return only upcoming events. Works with the 'type' = 'event' only.
39 |
# File 'lib/vk/api/groups/methods/search.rb', line 39 attribute :future, API::Types::Form::Bool.optional.default(nil) |
#market ⇒ Boolean
Returns '1' — to return communities with enabled market only.
41 |
# File 'lib/vk/api/groups/methods/search.rb', line 41 attribute :market, API::Types::Form::Bool.optional.default(nil) |
#offset ⇒ Integer
Returns Offset needed to return a specific subset of results.
45 |
# File 'lib/vk/api/groups/methods/search.rb', line 45 attribute :offset, API::Types::Coercible::Int.optional.default(nil) |
#q ⇒ String
Returns Search query string.
31 |
# File 'lib/vk/api/groups/methods/search.rb', line 31 attribute :q, API::Types::Coercible::String |
#sort ⇒ Integer
Returns Sort order. Possible values:; *'0' — default sorting (similar the full version of the site);; *'1' — by growth speed;; *'2'— by the "day attendance/members number" ratio;; *'3' — by the "Likes number/members number" ratio;; *'4' — by the "comments number/members number" ratio;; *'5' — by the "boards entries number/members number" ratio.; ;.
43 |
# File 'lib/vk/api/groups/methods/search.rb', line 43 attribute :sort, API::Types::Coercible::Int.optional.default(nil) |