Class: Vk::API::Video

Inherits:
Schema::Namespace show all
Defined in:
lib/vk/api/methods.rb,
lib/vk/api/objects.rb,
lib/vk/api/responses.rb,
lib/vk/api/video/video.rb,
lib/vk/api/video/cat_block.rb,
lib/vk/api/video/video_tag.rb,
lib/vk/api/video/video_full.rb,
lib/vk/api/video/cat_element.rb,
lib/vk/api/video/methods/add.rb,
lib/vk/api/video/methods/get.rb,
lib/vk/api/video/save_result.rb,
lib/vk/api/video/video_album.rb,
lib/vk/api/video/methods/edit.rb,
lib/vk/api/video/methods/save.rb,
lib/vk/api/video/methods/delete.rb,
lib/vk/api/video/methods/report.rb,
lib/vk/api/video/methods/search.rb,
lib/vk/api/video/video_tag_info.rb,
lib/vk/api/video/methods/put_tag.rb,
lib/vk/api/video/methods/restore.rb,
lib/vk/api/video/upload_response.rb,
lib/vk/api/video/methods/get_tags.rb,
lib/vk/api/video/video_album_full.rb,
lib/vk/api/video/methods/add_album.rb,
lib/vk/api/video/methods/edit_album.rb,
lib/vk/api/video/methods/get_albums.rb,
lib/vk/api/video/methods/remove_tag.rb,
lib/vk/api/video/methods/get_catalog.rb,
lib/vk/api/video/methods/add_to_album.rb,
lib/vk/api/video/methods/delete_album.rb,
lib/vk/api/video/methods/edit_comment.rb,
lib/vk/api/video/methods/get_comments.rb,
lib/vk/api/video/methods/get_new_tags.rb,
lib/vk/api/video/methods/create_comment.rb,
lib/vk/api/video/methods/delete_comment.rb,
lib/vk/api/video/methods/reorder_albums.rb,
lib/vk/api/video/methods/reorder_videos.rb,
lib/vk/api/video/methods/report_comment.rb,
lib/vk/api/video/responses/add_response.rb,
lib/vk/api/video/responses/get_response.rb,
lib/vk/api/video/methods/get_album_by_id.rb,
lib/vk/api/video/methods/get_user_videos.rb,
lib/vk/api/video/methods/restore_comment.rb,
lib/vk/api/video/responses/edit_response.rb,
lib/vk/api/video/responses/save_response.rb,
lib/vk/api/video/methods/remove_from_album.rb,
lib/vk/api/video/responses/delete_response.rb,
lib/vk/api/video/responses/report_response.rb,
lib/vk/api/video/responses/search_response.rb,
lib/vk/api/video/responses/put_tag_response.rb,
lib/vk/api/video/responses/restore_response.rb,
lib/vk/api/video/methods/get_albums_by_video.rb,
lib/vk/api/video/methods/get_catalog_section.rb,
lib/vk/api/video/responses/get_tags_response.rb,
lib/vk/api/video/methods/hide_catalog_section.rb,
lib/vk/api/video/responses/add_album_response.rb,
lib/vk/api/video/responses/edit_album_response.rb,
lib/vk/api/video/responses/get_albums_response.rb,
lib/vk/api/video/responses/remove_tag_response.rb,
lib/vk/api/video/responses/get_catalog_response.rb,
lib/vk/api/video/responses/add_to_album_response.rb,
lib/vk/api/video/responses/delete_album_response.rb,
lib/vk/api/video/responses/edit_comment_response.rb,
lib/vk/api/video/responses/get_comments_response.rb,
lib/vk/api/video/responses/get_new_tags_response.rb,
lib/vk/api/video/responses/create_comment_response.rb,
lib/vk/api/video/responses/delete_comment_response.rb,
lib/vk/api/video/responses/reorder_albums_response.rb,
lib/vk/api/video/responses/reorder_videos_response.rb,
lib/vk/api/video/responses/report_comment_response.rb,
lib/vk/api/video/responses/get_album_by_id_response.rb,
lib/vk/api/video/responses/get_user_videos_response.rb,
lib/vk/api/video/responses/restore_comment_response.rb,
lib/vk/api/video/responses/remove_from_album_response.rb,
lib/vk/api/video/responses/get_albums_by_video_response.rb,
lib/vk/api/video/responses/get_catalog_section_response.rb,
lib/vk/api/video/responses/hide_catalog_section_response.rb

Defined Under Namespace

Modules: Methods, Responses Classes: CatBlock, CatElement, SaveResult, UploadResponse, Video, VideoAlbum, VideoAlbumFull, VideoFull, VideoTag, VideoTagInfo

Instance Attribute Summary

Attributes inherited from Schema::Namespace

#client

DSL collapse

Methods inherited from Schema::Namespace

#call, #initialize

Constructor Details

This class inherits a constructor from Vk::Schema::Namespace

Instance Method Details

#add(arguments = {}) ⇒ Vk::API::Video::Responses::AddResponse

Returns Adds a video to a user or community page.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :target_id (Integer)

    identifier of a user or community to add a video to.; Use a negative value to designate a community ID.

  • :video_id (Integer)

    Video ID.

  • :owner_id (Integer)

    ID of the user or community that owns the video.; Use a negative value to designate a community ID.

Returns:

See Also:


3123
3124
3125
3126
3127
3128
3129
# File 'lib/vk/api/methods.rb', line 3123

def add(arguments = {})
  require "vk/api/video/methods/add"
  method = Methods::Add.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/add_response"
  Responses::AddResponse.new(response.deep_symbolize_keys)
end

#add_album(arguments = {}) ⇒ Vk::API::Video::Responses::AddAlbumResponse

Returns Creates an empty album for videos.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :group_id (Integer)

    Community ID (if the album will be created in a community).

  • :title (String)

    Album title.

  • :privacy (Array)

    new access permissions for the album.; Possible values: ; *'0' – all users;; *'1' – friends only;; *'2' – friends and friends of friends;; *'3' – "only me".

Returns:

See Also:


3241
3242
3243
3244
3245
3246
3247
# File 'lib/vk/api/methods.rb', line 3241

def add_album(arguments = {})
  require "vk/api/video/methods/add_album"
  method = Methods::AddAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/add_album_response"
  Responses::AddAlbumResponse.new(response.deep_symbolize_keys)
end

#add_to_album(arguments = {}) ⇒ Vk::API::Video::Responses::AddToAlbumResponse


3314
3315
3316
3317
3318
3319
3320
# File 'lib/vk/api/methods.rb', line 3314

def add_to_album(arguments = {})
  require "vk/api/video/methods/add_to_album"
  method = Methods::AddToAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/add_to_album_response"
  Responses::AddToAlbumResponse.new(response.deep_symbolize_keys)
end

#create_comment(arguments = {}) ⇒ Vk::API::Video::Responses::CreateCommentResponse

Returns Adds a new comment on a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :video_id (Integer)

    Video ID.

  • :message (String)

    New comment text.

  • :attachments (Array)

    List of objects attached to the comment, in the following format:; ","; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '' — ID of the media attachment owner.; '' — Media attachment ID. ; ; Example:; "photo100172_166443618,photo66748_265827614"

  • :from_group (Boolean)

    '1' — to post the comment from a community name (only if 'owner_id'<0)

  • :reply_to_comment (Integer)
  • :sticker_id (Integer)
  • :guid (String)

Returns:

See Also:


3378
3379
3380
3381
3382
3383
3384
# File 'lib/vk/api/methods.rb', line 3378

def create_comment(arguments = {})
  require "vk/api/video/methods/create_comment"
  method = Methods::CreateComment.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/create_comment_response"
  Responses::CreateCommentResponse.new(response.deep_symbolize_keys)
end

#delete(arguments = {}) ⇒ Vk::API::Video::Responses::DeleteResponse

Returns Deletes a video from a user or community page.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

Returns:

See Also:


3157
3158
3159
3160
3161
3162
3163
# File 'lib/vk/api/methods.rb', line 3157

def delete(arguments = {})
  require "vk/api/video/methods/delete"
  method = Methods::Delete.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/delete_response"
  Responses::DeleteResponse.new(response.deep_symbolize_keys)
end

#delete_album(arguments = {}) ⇒ Vk::API::Video::Responses::DeleteAlbumResponse

Returns Deletes a video album.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :group_id (Integer)

    Community ID (if the album is owned by a community).

  • :album_id (Integer)

    Album ID.

Returns:

See Also:


3267
3268
3269
3270
3271
3272
3273
# File 'lib/vk/api/methods.rb', line 3267

def delete_album(arguments = {})
  require "vk/api/video/methods/delete_album"
  method = Methods::DeleteAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/delete_album_response"
  Responses::DeleteAlbumResponse.new(response.deep_symbolize_keys)
end

#delete_comment(arguments = {}) ⇒ Vk::API::Video::Responses::DeleteCommentResponse

Returns Deletes a comment on a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :comment_id (Integer)

    ID of the comment to be deleted.

Returns:

See Also:


3390
3391
3392
3393
3394
3395
3396
# File 'lib/vk/api/methods.rb', line 3390

def delete_comment(arguments = {})
  require "vk/api/video/methods/delete_comment"
  method = Methods::DeleteComment.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/delete_comment_response"
  Responses::DeleteCommentResponse.new(response.deep_symbolize_keys)
end

#edit(arguments = {}) ⇒ Vk::API::Video::Responses::EditResponse

Returns Edits information about a video on a user or community page.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :video_id (Integer)

    Video ID.

  • :name (String)

    New video title.

  • :desc (String)

    New video description.

  • :privacy_view (Array)

    Privacy settings in a .; Privacy setting is available for videos uploaded to own profile by user.

  • :privacy_comment (Array)

    Privacy settings for comments in a .

  • :no_comments (Boolean)

    Disable comments for the group video.

  • :repeat (Boolean)

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

Returns:

See Also:


3110
3111
3112
3113
3114
3115
3116
# File 'lib/vk/api/methods.rb', line 3110

def edit(arguments = {})
  require "vk/api/video/methods/edit"
  method = Methods::Edit.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/edit_response"
  Responses::EditResponse.new(response.deep_symbolize_keys)
end

#edit_album(arguments = {}) ⇒ Vk::API::Video::Responses::EditAlbumResponse

Returns Edits the title of a video album.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :group_id (Integer)

    Community ID (if the album edited is owned by a community).

  • :album_id (Integer)

    Album ID.

  • :title (String)

    New album title.

  • :privacy (Array)

    new access permissions for the album.; Possible values: ; *'0' – all users;; *'1' – friends only;; *'2' – friends and friends of friends;; *'3' – "only me".

Returns:

See Also:


3255
3256
3257
3258
3259
3260
3261
# File 'lib/vk/api/methods.rb', line 3255

def edit_album(arguments = {})
  require "vk/api/video/methods/edit_album"
  method = Methods::EditAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/edit_album_response"
  Responses::EditAlbumResponse.new(response.deep_symbolize_keys)
end

#edit_comment(arguments = {}) ⇒ Vk::API::Video::Responses::EditCommentResponse

Returns Edits the text of a comment on a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :comment_id (Integer)

    Comment ID.

  • :message (String)

    New comment text.

  • :attachments (Array)

    List of objects attached to the comment, in the following format:; ","; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '' — ID of the media attachment owner.; '' — Media attachment ID. ; ; Example:; "photo100172_166443618,photo66748_265827614"

Returns:

See Also:


3416
3417
3418
3419
3420
3421
3422
# File 'lib/vk/api/methods.rb', line 3416

def edit_comment(arguments = {})
  require "vk/api/video/methods/edit_comment"
  method = Methods::EditComment.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/edit_comment_response"
  Responses::EditCommentResponse.new(response.deep_symbolize_keys)
end

#get(arguments = {}) ⇒ Vk::API::Video::Responses::GetResponse

Returns detailed information about videos.

Parameters:

  • arguments (Hash) (defaults to: {})

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) — default: 100

    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

Returns:

See Also:


3092
3093
3094
3095
3096
3097
3098
# File 'lib/vk/api/methods.rb', line 3092

def get(arguments = {})
  require "vk/api/video/methods/get"
  method = Methods::Get.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_response"
  Responses::GetResponse.new(response.deep_symbolize_keys)
end

#get_album_by_id(arguments = {}) ⇒ Vk::API::Video::Responses::GetAlbumByIdResponse

Returns video album info

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    identifier of a user or community to add a video to. ; Use a negative value to designate a community ID.

  • :album_id (Integer)

    album ID.

Returns:

See Also:


3228
3229
3230
3231
3232
3233
3234
# File 'lib/vk/api/methods.rb', line 3228

def get_album_by_id(arguments = {})
  require "vk/api/video/methods/get_album_by_id"
  method = Methods::GetAlbumById.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_album_by_id_response"
  Responses::GetAlbumByIdResponse.new(response.deep_symbolize_keys)
end

#get_albums(arguments = {}) ⇒ Vk::API::Video::Responses::GetAlbumsResponse

Returns a list of video albums owned by a user or community.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

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

  • :offset (Integer)

    Offset needed to return a specific subset of video albums.

  • :count (Integer) — default: 50

    Number of video albums to return.

  • :extended (Boolean)

    '1' — to return additional information about album privacy settings for the current user

Returns:

See Also:


3216
3217
3218
3219
3220
3221
3222
# File 'lib/vk/api/methods.rb', line 3216

def get_albums(arguments = {})
  require "vk/api/video/methods/get_albums"
  method = Methods::GetAlbums.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_albums_response"
  Responses::GetAlbumsResponse.new(response.deep_symbolize_keys)
end

#get_albums_by_video(arguments = {}) ⇒ Vk::API::Video::Responses::GetAlbumsByVideoResponse


3342
3343
3344
3345
3346
3347
3348
# File 'lib/vk/api/methods.rb', line 3342

def get_albums_by_video(arguments = {})
  require "vk/api/video/methods/get_albums_by_video"
  method = Methods::GetAlbumsByVideo.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_albums_by_video_response"
  Responses::GetAlbumsByVideoResponse.new(response.deep_symbolize_keys)
end

#get_catalog(arguments = {}) ⇒ Vk::API::Video::Responses::GetCatalogResponse

Returns video catalog

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :count (Integer) — default: 10

    number of catalog blocks to return.

  • :items_count (Integer) — default: 10

    number of videos in each block.

  • :from (String)

    parameter for requesting the next results page. Value for transmitting here is returned in the 'next' field in a reply.

  • :filters (Array) — default: []

    list of requested catalog sections

Returns:

See Also:


3509
3510
3511
3512
3513
3514
3515
# File 'lib/vk/api/methods.rb', line 3509

def get_catalog(arguments = {})
  require "vk/api/video/methods/get_catalog"
  method = Methods::GetCatalog.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_catalog_response"
  Responses::GetCatalogResponse.new(response.deep_symbolize_keys)
end

#get_catalog_section(arguments = {}) ⇒ Vk::API::Video::Responses::GetCatalogSectionResponse

Returns a separate catalog section

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :section_id (String)

    'id' value returned with a block by the '' method.

  • :from (String)

    'next' value returned with a block by the '' method.

  • :count (Integer) — default: 10

    number of blocks to return.

Returns:

See Also:


3522
3523
3524
3525
3526
3527
3528
# File 'lib/vk/api/methods.rb', line 3522

def get_catalog_section(arguments = {})
  require "vk/api/video/methods/get_catalog_section"
  method = Methods::GetCatalogSection.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_catalog_section_response"
  Responses::GetCatalogSectionResponse.new(response.deep_symbolize_keys)
end

#get_comments(arguments = {}) ⇒ Vk::API::Video::Responses::GetCommentsResponse

Returns a list of comments on a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

Returns:

See Also:


3360
3361
3362
3363
3364
3365
3366
# File 'lib/vk/api/methods.rb', line 3360

def get_comments(arguments = {})
  require "vk/api/video/methods/get_comments"
  method = Methods::GetComments.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_comments_response"
  Responses::GetCommentsResponse.new(response.deep_symbolize_keys)
end

#get_new_tags(arguments = {}) ⇒ Vk::API::Video::Responses::GetNewTagsResponse

Returns a list of videos with tags that have not been viewed.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :offset (Integer)

    Offset needed to return a specific subset of videos.

  • :count (Integer) — default: 20

    Number of videos to return.

Returns:

See Also:


3467
3468
3469
3470
3471
3472
3473
# File 'lib/vk/api/methods.rb', line 3467

def get_new_tags(arguments = {})
  require "vk/api/video/methods/get_new_tags"
  method = Methods::GetNewTags.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_new_tags_response"
  Responses::GetNewTagsResponse.new(response.deep_symbolize_keys)
end

#get_tags(arguments = {}) ⇒ Vk::API::Video::Responses::GetTagsResponse

Returns a list of tags on a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :video_id (Integer)

    Video ID.

Returns:

See Also:


3428
3429
3430
3431
3432
3433
3434
# File 'lib/vk/api/methods.rb', line 3428

def get_tags(arguments = {})
  require "vk/api/video/methods/get_tags"
  method = Methods::GetTags.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_tags_response"
  Responses::GetTagsResponse.new(response.deep_symbolize_keys)
end

#get_user_videos(arguments = {}) ⇒ Vk::API::Video::Responses::GetUserVideosResponse

Returns list of videos in which the user is tagged.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :user_id (Integer)

    User ID.

  • :offset (Integer)

    Offset needed to return a specific subset of videos.

  • :count (Integer) — default: 20

    Number of videos to return.

Returns:

See Also:


3202
3203
3204
3205
3206
3207
3208
# File 'lib/vk/api/methods.rb', line 3202

def get_user_videos(arguments = {})
  require "vk/api/video/methods/get_user_videos"
  method = Methods::GetUserVideos.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/get_user_videos_response"
  Responses::GetUserVideosResponse.new(response.deep_symbolize_keys)
end

#hide_catalog_section(arguments = {}) ⇒ Vk::API::Video::Responses::HideCatalogSectionResponse

Returns Hides a video catalog section from a user.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :section_id (Integer)

    'id' value returned with a block to hide by the '' method.

Returns:

See Also:


3533
3534
3535
3536
3537
3538
3539
# File 'lib/vk/api/methods.rb', line 3533

def hide_catalog_section(arguments = {})
  require "vk/api/video/methods/hide_catalog_section"
  method = Methods::HideCatalogSection.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/hide_catalog_section_response"
  Responses::HideCatalogSectionResponse.new(response.deep_symbolize_keys)
end

#put_tag(arguments = {}) ⇒ Vk::API::Video::Responses::PutTagResponse

Returns Adds a tag on a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :user_id (Integer)

    ID of the user to be tagged.

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :video_id (Integer)

    Video ID.

  • :tagged_name (String)

    Tag text.

Returns:

See Also:


3442
3443
3444
3445
3446
3447
3448
# File 'lib/vk/api/methods.rb', line 3442

def put_tag(arguments = {})
  require "vk/api/video/methods/put_tag"
  method = Methods::PutTag.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/put_tag_response"
  Responses::PutTagResponse.new(response.deep_symbolize_keys)
end

#remove_from_album(arguments = {}) ⇒ Vk::API::Video::Responses::RemoveFromAlbumResponse


3329
3330
3331
3332
3333
3334
3335
# File 'lib/vk/api/methods.rb', line 3329

def remove_from_album(arguments = {})
  require "vk/api/video/methods/remove_from_album"
  method = Methods::RemoveFromAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/remove_from_album_response"
  Responses::RemoveFromAlbumResponse.new(response.deep_symbolize_keys)
end

#remove_tag(arguments = {}) ⇒ Vk::API::Video::Responses::RemoveTagResponse

Returns Removes a tag from a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :tag_id (Integer)

    Tag ID.

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :video_id (Integer)

    Video ID.

Returns:

See Also:


3455
3456
3457
3458
3459
3460
3461
# File 'lib/vk/api/methods.rb', line 3455

def remove_tag(arguments = {})
  require "vk/api/video/methods/remove_tag"
  method = Methods::RemoveTag.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/remove_tag_response"
  Responses::RemoveTagResponse.new(response.deep_symbolize_keys)
end

#reorder_albums(arguments = {}) ⇒ Vk::API::Video::Responses::ReorderAlbumsResponse

Returns Reorders the album in the list of user video albums.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the albums..

  • :album_id (Integer)

    Album ID.

  • :before (Integer)

    ID of the album before which the album in question shall be placed.

  • :after (Integer)

    ID of the album after which the album in question shall be placed.

Returns:

See Also:


3281
3282
3283
3284
3285
3286
3287
# File 'lib/vk/api/methods.rb', line 3281

def reorder_albums(arguments = {})
  require "vk/api/video/methods/reorder_albums"
  method = Methods::ReorderAlbums.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/reorder_albums_response"
  Responses::ReorderAlbumsResponse.new(response.deep_symbolize_keys)
end

#reorder_videos(arguments = {}) ⇒ Vk::API::Video::Responses::ReorderVideosResponse

Returns Reorders the video in the video album.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :target_id (Integer)

    ID of the user or community that owns the album with videos.

  • :album_id (Integer)

    ID of the video album.

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :video_id (Integer)

    ID of the video.

  • :before_owner_id (Integer)

    ID of the user or community that owns the video before which the video in question shall be placed.

  • :before_video_id (Integer)

    ID of the video before which the video in question shall be placed.

  • :after_owner_id (Integer)

    ID of the user or community that owns the video after which the photo in question shall be placed.

  • :after_video_id (Integer)

    ID of the video after which the photo in question shall be placed.

Returns:

See Also:


3299
3300
3301
3302
3303
3304
3305
# File 'lib/vk/api/methods.rb', line 3299

def reorder_videos(arguments = {})
  require "vk/api/video/methods/reorder_videos"
  method = Methods::ReorderVideos.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/reorder_videos_response"
  Responses::ReorderVideosResponse.new(response.deep_symbolize_keys)
end

#report(arguments = {}) ⇒ Vk::API::Video::Responses::ReportResponse

Returns Reports (submits a complaint about) a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :video_id (Integer)

    Video ID.

  • :reason (Integer)

    Reason for the complaint:; '0' – spam; '1' – child pornography; '2' – extremism; '3' – violence; '4' – drug propaganda; '5' – adult material; '6' – insult; abuse

  • :comment (String)

    Comment describing the complaint.

  • :search_query (String) — default: If the video was found in search results.

    Search query string.

Returns:

See Also:


3482
3483
3484
3485
3486
3487
3488
# File 'lib/vk/api/methods.rb', line 3482

def report(arguments = {})
  require "vk/api/video/methods/report"
  method = Methods::Report.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/report_response"
  Responses::ReportResponse.new(response.deep_symbolize_keys)
end

#report_comment(arguments = {}) ⇒ Vk::API::Video::Responses::ReportCommentResponse

Returns Reports (submits a complaint about) a comment on a video.;.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :comment_id (Integer)

    ID of the comment being reported.

  • :reason (Integer)

    Reason for the complaint: ; 0 – spam ; 1 – child pornography ; 2 – extremism ; 3 – violence ; 4 – drug propaganda ; 5 – adult material ; 6 – insult; abuse

Returns:

See Also:


3495
3496
3497
3498
3499
3500
3501
# File 'lib/vk/api/methods.rb', line 3495

def report_comment(arguments = {})
  require "vk/api/video/methods/report_comment"
  method = Methods::ReportComment.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/report_comment_response"
  Responses::ReportCommentResponse.new(response.deep_symbolize_keys)
end

#restore(arguments = {}) ⇒ Vk::API::Video::Responses::RestoreResponse

Returns Restores a previously deleted video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :video_id (Integer)

    Video ID.

  • :owner_id (Integer)

    ID of the user or community that owns the video.

Returns:

See Also:


3169
3170
3171
3172
3173
3174
3175
# File 'lib/vk/api/methods.rb', line 3169

def restore(arguments = {})
  require "vk/api/video/methods/restore"
  method = Methods::Restore.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/restore_response"
  Responses::RestoreResponse.new(response.deep_symbolize_keys)
end

#restore_comment(arguments = {}) ⇒ Vk::API::Video::Responses::RestoreCommentResponse

Returns Restores a previously deleted comment on a video.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :comment_id (Integer)

    ID of the deleted comment.

Returns:

See Also:


3402
3403
3404
3405
3406
3407
3408
# File 'lib/vk/api/methods.rb', line 3402

def restore_comment(arguments = {})
  require "vk/api/video/methods/restore_comment"
  method = Methods::RestoreComment.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/restore_comment_response"
  Responses::RestoreCommentResponse.new(response.deep_symbolize_keys)
end

#save(arguments = {}) ⇒ Vk::API::Video::Responses::SaveResponse

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

Parameters:

  • arguments (Hash) (defaults to: {})

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)
  • :privacy_comment (Array)
  • :no_comments (Boolean)
  • :repeat (Boolean)

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

Returns:

See Also:


3144
3145
3146
3147
3148
3149
3150
# File 'lib/vk/api/methods.rb', line 3144

def save(arguments = {})
  require "vk/api/video/methods/save"
  method = Methods::Save.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/save_response"
  Responses::SaveResponse.new(response.deep_symbolize_keys)
end

#search(arguments = {}) ⇒ Vk::API::Video::Responses::SearchResponse

Returns a list of videos under the set search criterion.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :q (String)

    Search query string (e.g., 'The Beatles').

  • :sort (Integer)

    Sort order:; '1' — by duration; '2' — by relevance; '0' — by date added

  • :hd (Integer)

    If not null, only searches for high-definition videos.

  • :adult (Boolean)

    '1' — to disable the Safe Search filter; '0' — to enable the Safe Search filter

  • :filters (Array)

    Filters to apply:; 'youtube' — return YouTube videos only; 'vimeo' — return Vimeo videos only; 'short' — return short videos only; 'long' — return long videos only

  • :search_own (Boolean)
  • :offset (Integer)

    Offset needed to return a specific subset of videos.

  • :longer (Integer)
  • :shorter (Integer)
  • :count (Integer) — default: 20

    Number of videos to return.

Returns:

See Also:


3189
3190
3191
3192
3193
3194
3195
# File 'lib/vk/api/methods.rb', line 3189

def search(arguments = {})
  require "vk/api/video/methods/search"
  method = Methods::Search.new(arguments)
  response = method.call(@client)
  require "vk/api/video/responses/search_response"
  Responses::SearchResponse.new(response.deep_symbolize_keys)
end