Class: Vk::API::Groups::Methods::Get

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

Overview

Returns a list of the communities to which a user belongs.; ;

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :user_id (Integer)

    User ID.

  • :extended (Boolean)

    '1' — to return complete information about a user's communities; '0' — to return a list of community IDs without any additional fields (default);

  • :filter (Array)

    Types of communities to return:; 'admin' — to return communities administered by the user ; 'editor' — to return communities where the user is an administrator or editor; 'moder' — to return communities where the user is an administrator, editor, or moderator; 'groups' — to return only groups; 'publics' — to return only public pages; 'events' — to return only events

  • :fields (Array)

    Profile fields to return.;

  • :offset (Integer)

    Offset needed to return a specific subset of communities.

  • :count (Integer)

    Number of communities to return.


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

Instance Method Details

#countInteger

Returns Number of communities to return.

Returns:

  • (Integer)

    Number of communities to return.


38
# File 'lib/vk/api/groups/methods/get.rb', line 38

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

#extendedBoolean

Returns '1' — to return complete information about a user's communities; '0' — to return a list of community IDs without any additional fields (default);.

Returns:

  • (Boolean)

    '1' — to return complete information about a user's communities; '0' — to return a list of community IDs without any additional fields (default);


30
# File 'lib/vk/api/groups/methods/get.rb', line 30

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

#fieldsArray

Returns Profile fields to return.;.

Returns:

  • (Array)

    Profile fields to return.;


34
# File 'lib/vk/api/groups/methods/get.rb', line 34

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

#filterArray

Returns Types of communities to return:; 'admin' — to return communities administered by the user ; 'editor' — to return communities where the user is an administrator or editor; 'moder' — to return communities where the user is an administrator, editor, or moderator; 'groups' — to return only groups; 'publics' — to return only public pages; 'events' — to return only events.

Returns:

  • (Array)

    Types of communities to return:; 'admin' — to return communities administered by the user ; 'editor' — to return communities where the user is an administrator or editor; 'moder' — to return communities where the user is an administrator, editor, or moderator; 'groups' — to return only groups; 'publics' — to return only public pages; 'events' — to return only events


32
# File 'lib/vk/api/groups/methods/get.rb', line 32

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

#offsetInteger

Returns Offset needed to return a specific subset of communities.

Returns:

  • (Integer)

    Offset needed to return a specific subset of communities.


36
# File 'lib/vk/api/groups/methods/get.rb', line 36

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

#user_idInteger

Returns User ID.

Returns:

  • (Integer)

    User ID.


28
# File 'lib/vk/api/groups/methods/get.rb', line 28

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