Class: Vk::API::Groups::Methods::GetInvites

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

Overview

Returns a list of invitations to join communities and events.; ;

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :offset (Integer) —

    Offset needed to return a specific subset of invitations.

  • :count (Integer) —

    Number of invitations to return.

  • :extended (Boolean) —

    '1' — to return additional for communities..




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

Instance Method Details

#count ⇒ Integer

Returns Number of invitations to return.

Returns:

  • (Integer) —

    Number of invitations to return.



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

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

#extended ⇒ Boolean

Returns '1' — to return additional for communities..

Returns:

  • (Boolean) —

    '1' — to return additional for communities..



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

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of invitations.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of invitations.



25
 
# File 'lib/vk/api/groups/methods/get_invites.rb', line 25

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