|
initialize Method
Description
This method initializes the state of the TruveoVideoSearch object.
Arguments
This method does not accept any arguments.
Syntax
The following code sample illustrates how this method can be invoked:
TVS = new TruveoVideoSearch(appid);
...
TVS.initialize();
Return Value
This method returns no value.
Response Data Objects
This method does not update any data objects.
Events
This method can fire the following events:
|
onload
|
This event fires when the TruveoVideoSearch object
initialization is complete. When this event fires, it will pass one argument, 'reloadStateFlag', to any handler attached to this event. The value
of 'reloadStateFlag' will be true if the TruveoVideoSearch object was just initialized following a return from the AOL account login page.
Event binding syntax: TVS.attachEvent('onload', 'myHandler(reloadStateFlag);');
|
|
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.
|
|
101
|
Invalid request: 'callback_url'
The callback_url parameter was not submitted with the request.
|
|
102
|
Invalid request: 'logout_callback_url'
The logout_callback_url parameter was not submitted with the request.
|
|
104
|
Invalid request: 'auth'
The auth parameter was not submitted with the request.
|
|
105
|
Invalid request: 'sig'
The sig parameter was not submitted with the request.
|
|
106
|
Invalid login attempt
The login attempted by the user is invalid.
|
|
107
|
Invalid request: 'token'
The token parameter was not submitted with the request.
|
|
109
|
SNS login failure.
The user could not login to SNS for some reason.
|
|
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.
|
|
100
|
Bad auth
The auth token that was supplied is invalid. The user could not be authenticated.
|
|
103
|
Signature does not match
The signature that was supplied is invalid. The user could not be authenticated.
|
|