Class: Vk::API::Groups::Methods::GetInvitedUsers

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

Overview

Returns invited users list of a community

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Groups::Methods::GetInvitedUsers

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_id (Integer)

    Group ID to return invited users for.

  • :offset (Integer)

    Offset needed to return a specific subset of results.

  • :count (Integer)

    Number of results to return.

  • :fields (Array)

    List of additional fields to be returned. ; Available values: 'sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, lists, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters'.

  • :name_case (String)

    Case for declension of user name and surname. Possible values:; *'nom' — nominative (default);; *'gen' — genitive;; *'dat' — dative;; *'acc' — accusative; ; *'ins' — instrumental;; *'abl' — prepositional.


# File 'lib/vk/api/groups/methods/get_invited_users.rb', line 15

Instance Method Details

#countInteger

Returns Number of results to return.

Returns:

  • (Integer)

    Number of results to return.


31
# File 'lib/vk/api/groups/methods/get_invited_users.rb', line 31

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

#fieldsArray

Returns List of additional fields to be returned. ; Available values: 'sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, lists, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters'.

Returns:

  • (Array)

    List of additional fields to be returned. ; Available values: 'sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, lists, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters'.


33
# File 'lib/vk/api/groups/methods/get_invited_users.rb', line 33

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

#group_idInteger

Returns Group ID to return invited users for.

Returns:

  • (Integer)

    Group ID to return invited users for.


27
# File 'lib/vk/api/groups/methods/get_invited_users.rb', line 27

attribute :group_id, API::Types::Coercible::Int

#name_caseString

Returns Case for declension of user name and surname. Possible values:; *'nom' — nominative (default);; *'gen' — genitive;; *'dat' — dative;; *'acc' — accusative; ; *'ins' — instrumental;; *'abl' — prepositional.

Returns:

  • (String)

    Case for declension of user name and surname. Possible values:; *'nom' — nominative (default);; *'gen' — genitive;; *'dat' — dative;; *'acc' — accusative; ; *'ins' — instrumental;; *'abl' — prepositional.


35
# File 'lib/vk/api/groups/methods/get_invited_users.rb', line 35

attribute :name_case, API::Types::Coercible::String.enum("nom", "gen", "dat", "acc", "ins", "abl").optional.default(nil)

#offsetInteger

Returns Offset needed to return a specific subset of results.

Returns:

  • (Integer)

    Offset needed to return a specific subset of results.


29
# File 'lib/vk/api/groups/methods/get_invited_users.rb', line 29

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