Class: Vk::API::Fave::Methods::GetUsers

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Fave::Methods::GetUsers

Defined in:

lib/vk/api/fave/methods/get_users.rb

Overview

Returns a list of users whom the current user has bookmarked.; ;

Arguments

• #count ⇒ Integer

  Number of users to return.

• #offset ⇒ Integer

  Offset needed to return a specific subset of users.

Instance Method Summary

• #initialize(arguments) ⇒ Fave::Methods::GetUsers constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Fave::Methods::GetUsers

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :offset (Integer) —

  Offset needed to return a specific subset of users.

• :count (Integer) —

  Number of users to return.

# File 'lib/vk/api/fave/methods/get_users.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/fave/methods/get_users.rb', line 26

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

#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/fave/methods/get_users.rb', line 24

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