Class: Vk::API::Leads::Methods::CheckUser

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

Overview

Checks if the user can start the lead.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Leads::Methods::CheckUser

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :lead_id (Integer)

    Lead ID.

  • :test_result (Integer)

    Value to be return in 'result' field when test mode is used.

  • :age (Integer)

    User age.

  • :country (String)

    User country code.


# File 'lib/vk/api/leads/methods/check_user.rb', line 15

Instance Method Details

#ageInteger

Returns User age.

Returns:

  • (Integer)

    User age.


30
# File 'lib/vk/api/leads/methods/check_user.rb', line 30

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

#countryString

Returns User country code.

Returns:

  • (String)

    User country code.


32
# File 'lib/vk/api/leads/methods/check_user.rb', line 32

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

#lead_idInteger

Returns Lead ID.

Returns:

  • (Integer)

    Lead ID.


26
# File 'lib/vk/api/leads/methods/check_user.rb', line 26

attribute :lead_id, API::Types::Coercible::Int

#test_resultInteger

Returns Value to be return in 'result' field when test mode is used.

Returns:

  • (Integer)

    Value to be return in 'result' field when test mode is used.


28
# File 'lib/vk/api/leads/methods/check_user.rb', line 28

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