Class: Vk::API::Secure::Methods::CheckToken

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Secure::Methods::CheckToken

Defined in:

lib/vk/api/secure/methods/check_token.rb

Overview

Checks the user authentification in 'IFrame' and 'Flash' apps using the 'access_token' parameter.

Arguments

• #ip ⇒ String

  User 'ip address'.

• #token ⇒ String

  Client 'access_token'.

Instance Method Summary

• #initialize(arguments) ⇒ Secure::Methods::CheckToken constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Secure::Methods::CheckToken

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :token (String) —

  client 'access_token'

• :ip (String) —

  user 'ip address'. Note that user may access using the 'ipv6' address, in this case it is required to transmit the 'ipv6' address. ; If not transmitted, the address will not be checked.

# File 'lib/vk/api/secure/methods/check_token.rb', line 15

Instance Method Details

#ip ⇒ String

Returns user 'ip address'. Note that user may access using the 'ipv6' address, in this case it is required to transmit the 'ipv6' address. ; If not transmitted, the address will not be checked.

Returns:

• (String) —

  user 'ip address'. Note that user may access using the 'ipv6' address, in this case it is required to transmit the 'ipv6' address. ; If not transmitted, the address will not be checked.

# File 'lib/vk/api/secure/methods/check_token.rb', line 26

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

#token ⇒ String

Returns client 'access_token'.

Returns:

• (String) —

  client 'access_token'

# File 'lib/vk/api/secure/methods/check_token.rb', line 24

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