Class: Vk::API::Groups::Methods::GetBanned

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Groups::Methods::GetBanned

Defined in:

lib/vk/api/groups/methods/get_banned.rb

Overview

Returns a list of users on a community blacklist.

Arguments

• #count ⇒ Integer

  Number of users to return.

• #fields ⇒ Array
• #group_id ⇒ Integer

  Community ID.

• #offset ⇒ Integer

  Offset needed to return a specific subset of users.

• #user_id ⇒ Integer

Instance Method Summary

• #initialize(arguments) ⇒ Groups::Methods::GetBanned constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :group_id (Integer) —

  Community ID.

• :offset (Integer) —

  Offset needed to return a specific subset of users.

• :count (Integer) —

  Number of users to return.

• :fields (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

• :user_id (Integer) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

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

Instance Method Details

#count ⇒ Integer

Returns Number of users to return.

Returns:

• (Integer) —

  Number of users to return.

# File 'lib/vk/api/groups/methods/get_banned.rb', line 31

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

#fields ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/groups/methods/get_banned.rb', line 33

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

#group_id ⇒ Integer

Returns Community ID.

Returns:

• (Integer) —

  Community ID.

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

attribute :group_id, API::Types::Coercible::Int

#offset ⇒ Integer

Returns Offset needed to return a specific subset of users.

Returns:

• (Integer) —

  Offset needed to return a specific subset of users.

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

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

#user_id ⇒ Integer

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Integer) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/groups/methods/get_banned.rb', line 35

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