Class: Vk::API::Wall::Methods::Pin

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Wall::Methods::Pin

Defined in:

lib/vk/api/wall/methods/pin.rb

Overview

Pins the post on wall.

Arguments

• #owner_id ⇒ Integer

  ID of the user or community that owns the wall.

• #post_id ⇒ Integer

  Post ID.

Instance Method Summary

• #initialize(arguments) ⇒ Wall::Methods::Pin constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Wall::Methods::Pin

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.

• :post_id (Integer) —

  Post ID.

# File 'lib/vk/api/wall/methods/pin.rb', line 15

Instance Method Details

#owner_id ⇒ Integer

Returns ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.

Returns:

• (Integer) —

  ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.

# File 'lib/vk/api/wall/methods/pin.rb', line 24

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

#post_id ⇒ Integer

Returns Post ID.

Returns:

• (Integer) —

  Post ID.

# File 'lib/vk/api/wall/methods/pin.rb', line 26

attribute :post_id, API::Types::Coercible::Int