Class: Vk::API::Video::Methods::Search

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Video::Methods::Search

Defined in:

lib/vk/api/video/methods/search.rb

Overview

Returns a list of videos under the set search criterion.

Arguments

• #adult ⇒ Boolean

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

• #count ⇒ Integer

  Number of videos to return.

• #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.

• #hd ⇒ Integer

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

• #longer ⇒ Integer
• #offset ⇒ Integer

  Offset needed to return a specific subset of videos.

• #q ⇒ String

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

• #search_own ⇒ Boolean
• #shorter ⇒ Integer
• #sort ⇒ Integer

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

Instance Method Summary

• #initialize(arguments) ⇒ Video::Methods::Search constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

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) —

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

• :shorter (Integer) —

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

• :count (Integer) —

  Number of videos to return.

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

Instance Method Details

#adult ⇒ Boolean

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

Returns:

• (Boolean) —

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

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

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

#count ⇒ Integer

Returns Number of videos to return.

Returns:

• (Integer) —

  Number of videos to return.

# File 'lib/vk/api/video/methods/search.rb', line 50

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

#filters ⇒ Array

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

Returns:

• (Array) —

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

# File 'lib/vk/api/video/methods/search.rb', line 40

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

#hd ⇒ Integer

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

Returns:

• (Integer) —

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

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

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

#longer ⇒ Integer

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

Returns:

• (Integer) —

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

# File 'lib/vk/api/video/methods/search.rb', line 46

attribute :longer, API::Types::Coercible::Int.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.

# File 'lib/vk/api/video/methods/search.rb', line 44

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

#q ⇒ String

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

Returns:

• (String) —

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

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

attribute :q, API::Types::Coercible::String

#search_own ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/vk/api/video/methods/search.rb', line 42

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

#shorter ⇒ Integer

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

Returns:

• (Integer) —

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

# File 'lib/vk/api/video/methods/search.rb', line 48

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

#sort ⇒ Integer

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

Returns:

• (Integer) —

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

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

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