|
getRelatedCategories Method
Description
This method returns the set of categories that are associated with the videos that match the submitted query.
Arguments
This method accepts the following arguments:
|
query
|
String value. Optional. Default value of ' '.
The query string that will be submitted to the Truveo video search engine. This string contains your search terms and can also include Boolean operators, modifiers, filters and sorters. For a complete listing of the supported functionality, see the documentation on search query syntax. If no query string or a blank query string is provided, this method will return the top videos ordered by vrank.
|
|
start
|
Integer not less than zero, not greater than 1000. Optional. Default value of 0.
The starting position of the first result, out of the entire set of matching results, that should be returned in response to your request.
|
|
results
|
Integer between 1 and 50. Optional. Default value of 10.
The number of results the search engine should attempt to return in response to your request.
|
Syntax
The following code sample illustrates how this method can be invoked:
TVS = new TruveoVideoSearch(appid);
...
TVS.getRelatedCategories(query, start, results);
Return Value
This method returns 'true' if the AJAX request was sent successfully.
Response Data Objects
The response returned by this method can update the following data objects:
|
method
|
A string containing the name of the API method used to retrieve the response. In this case, this field would return the string 'getRelatedCategories'.
Usage syntax: myVar = TVS.method;
|
|
query
|
A string containing the original submitted query associated with this response.
Usage syntax: myVar = TVS.query;
|
|
querySuggestion
|
A string containing a suggested query, if available, for the original submitted query associated with this response.
Usage syntax: myVar = TVS.querySuggestion;
|
|
CategorySet
|
The container for all of the categories associated with the entire set of matching videos. The CategorySet is returned only if the parameter 'showRelatedItems' is set to 1.
More details on the structure and attributes of this data object can be found here.
Usage syntax: myVar = TVS.CategorySet;
|
Events
This method can fire the following events:
|
onupdate
|
This event fires when a response to an AJAX request
is received by the TruveoVideoSearch object. When this event fires, it will pass one argument, 'methodName', to any handler attached to this event. The value
of 'methodName' will be set to the name of the method that issued the original AJAX request associated with this onupdate event.
Event binding syntax: TVS.attachEvent('onupdate', 'myHandler(methodName);');
|
|
onerror
|
This event fires when an error occurs.
When this event fires, it will pass two arguments, 'errorCode' and 'errorMessage', to any handler attached to this event. The value
of 'errorCode' will be the numerical code assigned to the error and 'errorMessage' will be a text message that describes the error.
Event binding syntax: TVS.attachEvent('onerror', 'myHandler(errorCode, errorMessage);');
|
Errors
If execution of this method is not successful, the errors with the following error codes can be thrown:
|
1
|
Invalid request: 'appid'
An application ID was not submitted with the request.
|
|
2
|
Invalid request: 'method'
A method was not submitted with the request.
|
|
5
|
Invalid request: 'query'
The query parameter was not submitted with the request.
|
|
3
|
Invalid request: 'start'
The start parameter must be a non-negative integer.
|
|
4
|
Invalid request: 'results'
The results parameter must be an integer between 1 and 50.
|
|
7
|
Invalid request: 'showAdult'
The showAdult parameter must be 0 or 1.
|
|
12
|
Service Unavailable
Truveo Video Search API service unavailable.
|
|
13
|
Method not found.
The method you submitted with the request was not valid.
|
|
14
|
Access Denied: invalid appid.
The application ID submitted with the request is invalid.
|
|
15
|
Access Denied: appid over limit.
The application ID submitted with the request is over the daily request limit.
|
|
501
|
Error connecting to XMLHTTP AJAX service
The Truveo video search AJAX service could not be reached.
|
|