Class: Vk::API::Apps::Methods::SendRequest

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Apps::Methods::SendRequest

Defined in:

lib/vk/api/apps/methods/send_request.rb

Overview

Sends a request to another user in an app that uses VK authorization.

Arguments

• #key ⇒ String

  Special string key to be sent with the request.

• #name ⇒ String
• #separate ⇒ Boolean
• #text ⇒ String

  Request text.

• #type ⇒ String

  Request type.

• #user_id ⇒ Integer

  Id of the user to send a request.

Instance Method Summary

• #initialize(arguments) ⇒ Apps::Methods::SendRequest constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Apps::Methods::SendRequest

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :user_id (Integer) —

  id of the user to send a request

• :text (String) —

  request text

• :type (String) —

  request type. Values:; 'invite' – if the request is sent to a user who does not have the app installed;; 'request' – if a user has already installed the app

• :name (String) —

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

• :key (String) —

  special string key to be sent with the request

• :separate (Boolean) —

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

# File 'lib/vk/api/apps/methods/send_request.rb', line 15

Instance Method Details

#key ⇒ String

Returns special string key to be sent with the request.

Returns:

• (String) —

  special string key to be sent with the request

# File 'lib/vk/api/apps/methods/send_request.rb', line 36

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

#name ⇒ String

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

Returns:

• (String) —

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

# File 'lib/vk/api/apps/methods/send_request.rb', line 34

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

#separate ⇒ Boolean

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

Returns:

• (Boolean) —

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

# File 'lib/vk/api/apps/methods/send_request.rb', line 38

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

#text ⇒ String

Returns request text.

Returns:

• (String) —

  request text

# File 'lib/vk/api/apps/methods/send_request.rb', line 30

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

#type ⇒ String

Returns request type. Values:; 'invite' – if the request is sent to a user who does not have the app installed;; 'request' – if a user has already installed the app.

Returns:

• (String) —

  request type. Values:; 'invite' – if the request is sent to a user who does not have the app installed;; 'request' – if a user has already installed the app

# File 'lib/vk/api/apps/methods/send_request.rb', line 32

attribute :type, API::Types::Coercible::String.enum("request", "invite").optional.default("request")

#user_id ⇒ Integer

Returns id of the user to send a request.

Returns:

• (Integer) —

  id of the user to send a request

# File 'lib/vk/api/apps/methods/send_request.rb', line 28

attribute :user_id, API::Types::Coercible::Int