VideosOperations class

Class representing a VideosOperations.

Constructors

VideosOperations(VideoSearchClientContext)

Create a VideosOperations.

Methods

details(string, ServiceCallback<VideoDetails>)
details(string, VideosDetailsOptionalParams)
details(string, VideosDetailsOptionalParams, ServiceCallback<VideoDetails>)
search(string, ServiceCallback<Videos>)
search(string, VideosSearchOptionalParams)
search(string, VideosSearchOptionalParams, ServiceCallback<Videos>)
trending(ServiceCallback<TrendingVideos>)
trending(VideosTrendingOptionalParams)
trending(VideosTrendingOptionalParams, ServiceCallback<TrendingVideos>)

Constructor Details

VideosOperations(VideoSearchClientContext)

Create a VideosOperations.

new VideosOperations(client: VideoSearchClientContext)

Parameters

client
VideoSearchClientContext

Reference to the service client.

Method Details

details(string, ServiceCallback<VideoDetails>)

function details(query: string, callback: ServiceCallback<VideoDetails>)

Parameters

query

string

The user's search query string. The query string cannot be empty. The query string may contain Bing Advanced Operators. For example, to limit videos to a specific domain, use the site: operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.

callback

ServiceCallback<VideoDetails>

The callback

details(string, VideosDetailsOptionalParams)

function details(query: string, options?: VideosDetailsOptionalParams): Promise<VideosDetailsResponse>

Parameters

query

string

The user's search query string. The query string cannot be empty. The query string may contain Bing Advanced Operators. For example, to limit videos to a specific domain, use the site: operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.

options
VideosDetailsOptionalParams

The optional parameters

Returns

Promise<Models.VideosDetailsResponse>

details(string, VideosDetailsOptionalParams, ServiceCallback<VideoDetails>)

function details(query: string, options: VideosDetailsOptionalParams, callback: ServiceCallback<VideoDetails>)

Parameters

query

string

The user's search query string. The query string cannot be empty. The query string may contain Bing Advanced Operators. For example, to limit videos to a specific domain, use the site: operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.

options
VideosDetailsOptionalParams

The optional parameters

callback

ServiceCallback<VideoDetails>

The callback

search(string, ServiceCallback<Videos>)

function search(query: string, callback: ServiceCallback<Videos>)

Parameters

query

string

The user's search query string. The query string cannot be empty. The query string may contain Bing Advanced Operators. For example, to limit videos to a specific domain, use the site: operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.

callback

ServiceCallback<Videos>

The callback

function search(query: string, options?: VideosSearchOptionalParams): Promise<VideosSearchResponse>

Parameters

query

string

The user's search query string. The query string cannot be empty. The query string may contain Bing Advanced Operators. For example, to limit videos to a specific domain, use the site: operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.

options
VideosSearchOptionalParams

The optional parameters

Returns

Promise<Models.VideosSearchResponse>

search(string, VideosSearchOptionalParams, ServiceCallback<Videos>)

function search(query: string, options: VideosSearchOptionalParams, callback: ServiceCallback<Videos>)

Parameters

query

string

The user's search query string. The query string cannot be empty. The query string may contain Bing Advanced Operators. For example, to limit videos to a specific domain, use the site: operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.

options
VideosSearchOptionalParams

The optional parameters

callback

ServiceCallback<Videos>

The callback

function trending(callback: ServiceCallback<TrendingVideos>)

Parameters

callback

ServiceCallback<TrendingVideos>

The callback

function trending(options?: VideosTrendingOptionalParams): Promise<VideosTrendingResponse>

Parameters

options
VideosTrendingOptionalParams

The optional parameters

Returns

Promise<Models.VideosTrendingResponse>

function trending(options: VideosTrendingOptionalParams, callback: ServiceCallback<TrendingVideos>)

Parameters

options
VideosTrendingOptionalParams

The optional parameters

callback

ServiceCallback<TrendingVideos>

The callback