Class: Vk::API::Wall::Methods::GetById

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/wall/methods/get_by_id.rb

Overview

Returns a list of posts from user or community walls by their IDs.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :posts (Array)

    User or community IDs and post IDs, separated by underscores. Use a negative value to designate a community ID. Example:; "93388_21539,93388_20904,2943_4276,-1_1"

  • :extended (Boolean)

    '1' — to return user and community objects needed to display posts; '0' — no additional fields are returned (default)

  • :copy_history_depth (Integer)

    Sets the number of parent elements to include in the array 'copy_history' that is returned if the post is a repost from another wall.

  • :fields (Array)

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

Instance Method Details

#copy_history_depthInteger

Returns Sets the number of parent elements to include in the array 'copy_history' that is returned if the post is a repost from another wall.

Returns:

  • (Integer)

    Sets the number of parent elements to include in the array 'copy_history' that is returned if the post is a repost from another wall.


30
# File 'lib/vk/api/wall/methods/get_by_id.rb', line 30

attribute :copy_history_depth, API::Types::Coercible::Int.optional.default(2)

#extendedBoolean

Returns '1' — to return user and community objects needed to display posts; '0' — no additional fields are returned (default).

Returns:

  • (Boolean)

    '1' — to return user and community objects needed to display posts; '0' — no additional fields are returned (default)


28
# File 'lib/vk/api/wall/methods/get_by_id.rb', line 28

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

#fieldsArray


32
# File 'lib/vk/api/wall/methods/get_by_id.rb', line 32

attribute :fields, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#postsArray

Returns User or community IDs and post IDs, separated by underscores. Use a negative value to designate a community ID. Example:; "93388_21539,93388_20904,2943_4276,-1_1".

Returns:

  • (Array)

    User or community IDs and post IDs, separated by underscores. Use a negative value to designate a community ID. Example:; "93388_21539,93388_20904,2943_4276,-1_1"


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

attribute :posts, API::Types::Coercible::Array.member(API::Types::Coercible::String)