Class: Vk::API::Status::Methods::Get

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Status::Methods::Get

Defined in:

lib/vk/api/status/methods/get.rb

Overview

Returns data required to show the status of a user or community.

Arguments

• #group_id ⇒ Integer
• #user_id ⇒ Integer

  User ID or community ID.

Instance Method Summary

• #initialize(arguments) ⇒ Status::Methods::Get constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Status::Methods::Get

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :user_id (Integer) —

  User ID or community ID. Use a negative value to designate a community ID.

• :group_id (Integer) —

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

# File 'lib/vk/api/status/methods/get.rb', line 15

Instance Method Details

#group_id ⇒ Integer

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

Returns:

• (Integer) —

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

# File 'lib/vk/api/status/methods/get.rb', line 26

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

#user_id ⇒ Integer

Returns User ID or community ID. Use a negative value to designate a community ID.

Returns:

• (Integer) —

  User ID or community ID. Use a negative value to designate a community ID.

# File 'lib/vk/api/status/methods/get.rb', line 24

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