ImagesOperations class
Class representing a ImagesOperations.
Constructors
| Images |
Create a ImagesOperations. |
Methods
Constructor Details
ImagesOperations(ImageSearchClientContext)
Create a ImagesOperations.
new ImagesOperations(client: ImageSearchClientContext)Parameters
- client
- ImageSearchClientContext
Reference to the service client.
Method Details
details(string, ImagesDetailsOptionalParams)
function details(query: string, options?: ImagesDetailsOptionalParams): Promise<ImagesDetailsResponse>Parameters
- query
-
string
The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToken), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.
- options
- ImagesDetailsOptionalParams
The optional parameters
Returns
Promise<ImagesDetailsResponse>
Promise<Models.ImagesDetailsResponse>
details(string, ImagesDetailsOptionalParams, ServiceCallback<ImageInsights>)
function details(query: string, options: ImagesDetailsOptionalParams, callback: ServiceCallback<ImageInsights>)Parameters
- query
-
string
The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToken), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.
- options
- ImagesDetailsOptionalParams
The optional parameters
- callback
The callback
details(string, ServiceCallback<ImageInsights>)
function details(query: string, callback: ServiceCallback<ImageInsights>)Parameters
- query
-
string
The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToken), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.
- callback
The callback
search(string, ImagesSearchOptionalParams)
function search(query: string, options?: ImagesSearchOptionalParams): Promise<ImagesSearchResponse>Parameters
- query
-
string
The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToken), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.
- options
- ImagesSearchOptionalParams
The optional parameters
Returns
Promise<ImagesSearchResponse>
Promise<Models.ImagesSearchResponse>
search(string, ImagesSearchOptionalParams, ServiceCallback<Images>)
function search(query: string, options: ImagesSearchOptionalParams, callback: ServiceCallback<Images>)Parameters
- query
-
string
The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToken), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.
- options
- ImagesSearchOptionalParams
The optional parameters
- callback
The callback
search(string, ServiceCallback<Images>)
function search(query: string, callback: ServiceCallback<Images>)Parameters
- query
-
string
The user's search query term. The term cannot be empty. The term may contain Bing Advanced Operators. For example, to limit images to a specific domain, use the site: operator. To help improve relevance of an insights query (see insightsToken), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.
- callback
The callback
trending(ImagesTrendingOptionalParams)
function trending(options?: ImagesTrendingOptionalParams): Promise<ImagesTrendingResponse>Parameters
- options
- ImagesTrendingOptionalParams
The optional parameters
Returns
Promise<ImagesTrendingResponse>
Promise<Models.ImagesTrendingResponse>
trending(ImagesTrendingOptionalParams, ServiceCallback<TrendingImages>)
function trending(options: ImagesTrendingOptionalParams, callback: ServiceCallback<TrendingImages>)Parameters
- options
- ImagesTrendingOptionalParams
The optional parameters
- callback
The callback
trending(ServiceCallback<TrendingImages>)
function trending(callback: ServiceCallback<TrendingImages>)Parameters
- callback
The callback