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

Inherits:
Schema::Method
  • Object
show all
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 collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):


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

Instance Method Details

#keyString

Returns special string key to be sent with the request.

Returns:

  • (String)

    special string key to be sent with the request


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

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

#nameString


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

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

#separateBoolean


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

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

#textString

Returns request text.

Returns:

  • (String)

    request text


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

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

#typeString

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


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

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

#user_idInteger

Returns id of the user to send a request.

Returns:

  • (Integer)

    id of the user to send a request


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

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