Class: Vk::API::Groups::Methods::GetById

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

Overview

Returns information about communities by their IDs.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_ids (Array)

    IDs or screen names of communities.

  • :group_id (String)

    ID or screen name of the community.

  • :fields (Array)

    Group fields to return.;


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

Instance Method Details

#fieldsArray

Returns Group fields to return.;.

Returns:

  • (Array)

    Group fields to return.;


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

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

#group_idString

Returns ID or screen name of the community.

Returns:

  • (String)

    ID or screen name of the community.


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

attribute :group_id, API::Types::Coercible::String.optional.default(nil)

#group_idsArray

Returns IDs or screen names of communities.

Returns:

  • (Array)

    IDs or screen names of communities.


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

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