Class: Vk::API::Polls::Methods::GetById

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

Overview

Returns detailed information about a poll by its ID.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

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.

  • :is_board (Boolean)

    '1' – poll is in a board, '0' – poll is on a wall. ; '0' by default.

  • :poll_id (Integer)

    Poll ID.


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

Instance Method Details

#is_boardBoolean

Returns '1' – poll is in a board, '0' – poll is on a wall. ; '0' by default.

Returns:

  • (Boolean)

    '1' – poll is in a board, '0' – poll is on a wall. ; '0' by default.


27
# File 'lib/vk/api/polls/methods/get_by_id.rb', line 27

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

#owner_idInteger

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.


25
# File 'lib/vk/api/polls/methods/get_by_id.rb', line 25

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

#poll_idInteger

Returns Poll ID.

Returns:

  • (Integer)

    Poll ID.


29
# File 'lib/vk/api/polls/methods/get_by_id.rb', line 29

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