Class: Vk::API::Apps::Methods::GetCatalog

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

Overview

Returns a list of applications (apps) available to users in the App Catalog.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Apps::Methods::GetCatalog

Parameters:

  • arguments (Hash)

Options Hash (arguments):




# File 'lib/vk/api/apps/methods/get_catalog.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns Number of apps to return.

Returns:

  • (Integer) —

    Number of apps to return.



37
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 37

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

#extended ⇒ Boolean

Returns '1' — to return additional fields 'screenshots', 'MAU', 'catalog_position', and 'international'. If set, 'count' must be less than or equal to '100'. ; '0' — not to return additional fields (default).

Returns:

  • (Boolean) —

    '1' — to return additional fields 'screenshots', 'MAU', 'catalog_position', and 'international'. If set, 'count' must be less than or equal to '100'. ; '0' — not to return additional fields (default).



41
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 41

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

#fields ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



45
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 45

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

#filter ⇒ String

Returns 'installed' — to return list of installed apps (only for mobile platform).

Returns:

  • (String) —

    'installed' — to return list of installed apps (only for mobile platform).



53
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 53

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

#genre_id ⇒ Integer

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



51
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 51

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

#name_case ⇒ String

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



47
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 47

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

#offset ⇒ Integer

Returns Offset required to return a specific subset of apps.

Returns:

  • (Integer) —

    Offset required to return a specific subset of apps.



35
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 35

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

#platform ⇒ String

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



39
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 39

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

#q ⇒ String

Returns Search query string.

Returns:

  • (String) —

    Search query string.



49
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 49

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

#return_friends ⇒ Boolean

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



43
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 43

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

#sort ⇒ String

Returns Sort order:; 'popular_today' — popular for one day (default); 'visitors' — by visitors number ; 'create_date' — by creation date; 'growth_rate' — by growth rate; 'popular_week' — popular for one week.

Returns:

  • (String) —

    Sort order:; 'popular_today' — popular for one day (default); 'visitors' — by visitors number ; 'create_date' — by creation date; 'growth_rate' — by growth rate; 'popular_week' — popular for one week



33
 
# File 'lib/vk/api/apps/methods/get_catalog.rb', line 33

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