Class: Vk::API::Storage

Inherits:

Schema::Namespace

• Object
• Schema::Namespace
• Vk::API::Storage

Defined in:

lib/vk/api/methods.rb,
lib/vk/api/responses.rb,
lib/vk/api/storage/methods/get.rb,
lib/vk/api/storage/methods/set.rb,
lib/vk/api/storage/methods/get_keys.rb,
lib/vk/api/storage/responses/get_response.rb,
lib/vk/api/storage/responses/set_response.rb,
lib/vk/api/storage/responses/get_keys_response.rb

Defined Under Namespace

Modules: Methods, Responses

Instance Attribute Summary

Attributes inherited from Schema::Namespace

#client

DSL

• #get(arguments = {}) ⇒ Vk::API::Storage::Responses::GetResponse

  Returns a value of variable with the name set by key parameter.

• #get_keys(arguments = {}) ⇒ Vk::API::Storage::Responses::GetKeysResponse

  Returns the names of all variables.

• #set(arguments = {}) ⇒ Vk::API::Storage::Responses::SetResponse

  Saves a value of variable with the name set by 'key' parameter.

Methods inherited from Schema::Namespace

#call, #initialize

Constructor Details

This class inherits a constructor from Vk::Schema::Namespace

Instance Method Details

#get(arguments = {}) ⇒ Vk::API::Storage::Responses::GetResponse

Returns a value of variable with the name set by key parameter.

Parameters:

• arguments (Hash) (defaults to: {})

Options Hash (arguments):

• :key (String) —

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

• :keys (Array) —

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

• :user_id (Integer) —

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

Returns:

• (Vk::API::Storage::Responses::GetResponse) —

  Returns a value of variable with the name set by key parameter.

See Also:

• Vk::API::Storage::Methods::Get

# File 'lib/vk/api/methods.rb', line 1666

def get(arguments = {})
  require "vk/api/storage/methods/get"
  method = Methods::Get.new(arguments)
  response = method.call(@client)
  require "vk/api/storage/responses/get_response"
  Responses::GetResponse.new(response.deep_symbolize_keys)
end

#get_keys(arguments = {}) ⇒ Vk::API::Storage::Responses::GetKeysResponse

Returns the names of all variables.

Parameters:

• arguments (Hash) (defaults to: {})

Options Hash (arguments):

• :user_id (Integer) —

  user id, whose variables names are returned if they were requested with a server method.

• :count (Integer) — default: 100 —

  amount of variable names the info needs to be collected from.

Returns:

• (Vk::API::Storage::Responses::GetKeysResponse) —

  Returns the names of all variables.

See Also:

• Vk::API::Storage::Methods::GetKeys

# File 'lib/vk/api/methods.rb', line 1691

def get_keys(arguments = {})
  require "vk/api/storage/methods/get_keys"
  method = Methods::GetKeys.new(arguments)
  response = method.call(@client)
  require "vk/api/storage/responses/get_keys_response"
  Responses::GetKeysResponse.new(response.deep_symbolize_keys)
end

#set(arguments = {}) ⇒ Vk::API::Storage::Responses::SetResponse

Returns Saves a value of variable with the name set by 'key' parameter.

Parameters:

• arguments (Hash) (defaults to: {})

Options Hash (arguments):

• :key (String) —

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

• :value (String) —

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

• :user_id (Integer) —

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

Returns:

• (Vk::API::Storage::Responses::SetResponse) —

  Saves a value of variable with the name set by 'key' parameter.

See Also:

• Vk::API::Storage::Methods::Set

# File 'lib/vk/api/methods.rb', line 1679

def set(arguments = {})
  require "vk/api/storage/methods/set"
  method = Methods::Set.new(arguments)
  response = method.call(@client)
  require "vk/api/storage/responses/set_response"
  Responses::SetResponse.new(response.deep_symbolize_keys)
end