Class: Vk::API::Groups::Methods::IsMember

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

Overview

Returns information specifying whether a user is a member of a community.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_id (String)

    ID or screen name of the community.

  • :user_id (Integer)

    User ID.

  • :user_ids (Array)

    User IDs.

  • :extended (Boolean)

    '1' — to return an extended response with additional fields.; By default: '0'.


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

Instance Method Details

#extendedBoolean

Returns '1' — to return an extended response with additional fields.; By default: '0'.

Returns:

  • (Boolean)

    '1' — to return an extended response with additional fields.; By default: '0'.


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

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

#group_idString

Returns ID or screen name of the community.

Returns:

  • (String)

    ID or screen name of the community.


26
# File 'lib/vk/api/groups/methods/is_member.rb', line 26

attribute :group_id, API::Types::Coercible::String

#user_idInteger

Returns User ID.

Returns:

  • (Integer)

    User ID.


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

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

#user_idsArray

Returns User IDs.

Returns:

  • (Array)

    User IDs.


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

attribute :user_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int).optional.default(nil)