Class: Vk::API::Auth::Methods::CheckPhone

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

Overview

Checks a user's phone number for correctness.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Auth::Methods::CheckPhone

Parameters:

  • arguments (Hash)

Options Hash (arguments):




# File 'lib/vk/api/auth/methods/check_phone.rb', line 15

Instance Method Details

#auth_by_phone ⇒ Boolean

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

Returns:



32
 
# File 'lib/vk/api/auth/methods/check_phone.rb', line 32

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

#client_id ⇒ Integer

Returns User ID.

Returns:

  • (Integer) —

    User ID.



28
 
# File 'lib/vk/api/auth/methods/check_phone.rb', line 28

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

#client_secret ⇒ String

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

Returns:



30
 
# File 'lib/vk/api/auth/methods/check_phone.rb', line 30

attribute :client_secret, API::Types::Coercible::String

#phone ⇒ String

Returns Phone number.

Returns:

  • (String) —

    Phone number.



26
 
# File 'lib/vk/api/auth/methods/check_phone.rb', line 26

attribute :phone, API::Types::Coercible::String