Class: Vk::API::Polls::Methods::GetVoters

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

Overview

Returns a list of IDs of users who selected specific answers in the poll.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Polls::Methods::GetVoters

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the poll. Use a negative value to designate a community ID.

  • :poll_id (Integer) —

    Poll ID.

  • :answer_ids (Array) —

    Answer IDs.

  • :is_board (Boolean) —

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

  • :friends_only (Boolean) —

    '1' — to return only current user's friends; '0' — to return all users (default);

  • :offset (Integer) —

    Offset needed to return a specific subset of voters.; '0' — (default)

  • :count (Integer) —

    Number of user IDs to return (if the 'friends_only' parameter is not set, maximum '1000'; otherwise '10').; '100' — (default)

  • :fields (Array, 'sex') —

    Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate (birthdate)', 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.;

  • :name_case (String) —

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




# File 'lib/vk/api/polls/methods/get_voters.rb', line 15

Instance Method Details

#answer_ids ⇒ Array

Returns Answer IDs.

Returns:

  • (Array) —

    Answer IDs.



35
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 35

attribute :answer_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int)

#count ⇒ Integer

Returns Number of user IDs to return (if the 'friends_only' parameter is not set, maximum '1000'; otherwise '10').; '100' — (default).

Returns:

  • (Integer) —

    Number of user IDs to return (if the 'friends_only' parameter is not set, maximum '1000'; otherwise '10').; '100' — (default)



43
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 43

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

#fields ⇒ Array, 'sex'

Returns Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate (birthdate)', 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.;.

Returns:

  • (Array, 'sex') —

    Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate (birthdate)', 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.;



45
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 45

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

#friends_only ⇒ Boolean

Returns '1' — to return only current user's friends; '0' — to return all users (default);.

Returns:

  • (Boolean) —

    '1' — to return only current user's friends; '0' — to return all users (default);



39
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 39

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

#is_board ⇒ Boolean

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

Returns:



37
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 37

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

#name_case ⇒ String

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

Returns:

  • (String) —

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



47
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 47

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of voters.; '0' — (default).

Returns:

  • (Integer) —

    Offset needed to return a specific subset of voters.; '0' — (default)



41
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 41

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

#owner_id ⇒ Integer

Returns ID of the user or community that owns the poll. Use a negative value to designate a community ID.

Returns:

  • (Integer) —

    ID of the user or community that owns the poll. Use a negative value to designate a community ID.



31
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 31

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

#poll_id ⇒ Integer

Returns Poll ID.

Returns:

  • (Integer) —

    Poll ID.



33
 
# File 'lib/vk/api/polls/methods/get_voters.rb', line 33

attribute :poll_id, API::Types::Coercible::Int