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

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

Overview

Returns a list of users on a community blacklist.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):


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

Instance Method Details

#countInteger

Returns Number of users to return.

Returns:

  • (Integer)

    Number of users to return.


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

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

#fieldsArray


33
# 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_idInteger

Returns Community ID.

Returns:

  • (Integer)

    Community ID.


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

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

#offsetInteger

Returns Offset needed to return a specific subset of users.

Returns:

  • (Integer)

    Offset needed to return a specific subset of users.


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

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

#user_idInteger


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

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