Class: Vk::API::Video::Methods::Save

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

Overview

Returns a server address (required for upload) and video data.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :name (String) —

    Name of the video.

  • :description (String) —

    Description of the video.

  • :is_private (Boolean) —

    '1' — to designate the video as private (send it via a private message); the video will not appear on the user's video list and will not be available by ID for other users; '0' — not to designate the video as private

  • :wallpost (Boolean) —

    '1' — to post the saved video on a user's wall; '0' — not to post the saved video on a user's wall

  • :link (String) —

    URL for embedding the video from an external website.

  • :group_id (Integer) —

    ID of the community in which the video will be saved. By default, the current user's page.

  • :album_id (Integer) —

    ID of the album to which the saved video will be added.

  • :privacy_view (Array) —

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

  • :privacy_comment (Array) —

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

  • :no_comments (Boolean) —

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

  • :repeat (Boolean) —

    '1' — to repeat the playback of the video; '0' — to play the video once;




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

Instance Method Details

#album_id ⇒ Integer

Returns ID of the album to which the saved video will be added.

Returns:

  • (Integer) —

    ID of the album to which the saved video will be added.



45
 
# File 'lib/vk/api/video/methods/save.rb', line 45

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

#description ⇒ String

Returns Description of the video.

Returns:

  • (String) —

    Description of the video.



35
 
# File 'lib/vk/api/video/methods/save.rb', line 35

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

#group_id ⇒ Integer

Returns ID of the community in which the video will be saved. By default, the current user's page.

Returns:

  • (Integer) —

    ID of the community in which the video will be saved. By default, the current user's page.



43
 
# File 'lib/vk/api/video/methods/save.rb', line 43

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

#is_private ⇒ Boolean

Returns '1' — to designate the video as private (send it via a private message); the video will not appear on the user's video list and will not be available by ID for other users; '0' — not to designate the video as private.

Returns:

  • (Boolean) —

    '1' — to designate the video as private (send it via a private message); the video will not appear on the user's video list and will not be available by ID for other users; '0' — not to designate the video as private



37
 
# File 'lib/vk/api/video/methods/save.rb', line 37

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

#link ⇒ String

Returns URL for embedding the video from an external website.

Returns:

  • (String) —

    URL for embedding the video from an external website.



41
 
# File 'lib/vk/api/video/methods/save.rb', line 41

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

#name ⇒ String

Returns Name of the video.

Returns:

  • (String) —

    Name of the video.



33
 
# File 'lib/vk/api/video/methods/save.rb', line 33

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

#no_comments ⇒ Boolean

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

Returns:



51
 
# File 'lib/vk/api/video/methods/save.rb', line 51

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

#privacy_comment ⇒ Array

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

Returns:



49
 
# File 'lib/vk/api/video/methods/save.rb', line 49

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

#privacy_view ⇒ Array

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

Returns:



47
 
# File 'lib/vk/api/video/methods/save.rb', line 47

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

#repeat ⇒ Boolean

Returns '1' — to repeat the playback of the video; '0' — to play the video once;.

Returns:

  • (Boolean) —

    '1' — to repeat the playback of the video; '0' — to play the video once;



53
 
# File 'lib/vk/api/video/methods/save.rb', line 53

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

#wallpost ⇒ Boolean

Returns '1' — to post the saved video on a user's wall; '0' — not to post the saved video on a user's wall.

Returns:

  • (Boolean) —

    '1' — to post the saved video on a user's wall; '0' — not to post the saved video on a user's wall



39
 
# File 'lib/vk/api/video/methods/save.rb', line 39

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