Class: Vk::API::Video::Methods::Get

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/video/methods/get.rb

Overview

Returns detailed information about videos.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the video(s).

  • :videos (Array) —

    Video IDs, in the following format:; ","; Use a negative value to designate a community ID.; ; Example:; "-4363_136089719,13245770_137352259"

  • :album_id (Integer) —

    ID of the album containing the video(s).

  • :count (Integer) —

    Number of videos to return.

  • :offset (Integer) —

    Offset needed to return a specific subset of videos.

  • :extended (Boolean) —

    '1' — to return an extended response with additional fields




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

Instance Method Details

#album_id ⇒ Integer

Returns ID of the album containing the video(s).

Returns:

  • (Integer) —

    ID of the album containing the video(s).



32
 
# File 'lib/vk/api/video/methods/get.rb', line 32

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

#count ⇒ Integer

Returns Number of videos to return.

Returns:

  • (Integer) —

    Number of videos to return.



34
 
# File 'lib/vk/api/video/methods/get.rb', line 34

attribute :count, API::Types::Coercible::Int.optional.default(100)

#extended ⇒ Boolean

Returns '1' — to return an extended response with additional fields.

Returns:

  • (Boolean) —

    '1' — to return an extended response with additional fields



38
 
# File 'lib/vk/api/video/methods/get.rb', line 38

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of videos.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of videos.



36
 
# File 'lib/vk/api/video/methods/get.rb', line 36

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

#owner_id ⇒ Integer

Returns ID of the user or community that owns the video(s).

Returns:

  • (Integer) —

    ID of the user or community that owns the video(s).



28
 
# File 'lib/vk/api/video/methods/get.rb', line 28

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

#videos ⇒ Array

Returns Video IDs, in the following format:; ","; Use a negative value to designate a community ID.; ; Example:; "-4363_136089719,13245770_137352259".

Returns:

  • (Array) —

    Video IDs, in the following format:; ","; Use a negative value to designate a community ID.; ; Example:; "-4363_136089719,13245770_137352259"



30
 
# File 'lib/vk/api/video/methods/get.rb', line 30

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