Child pages
  • TraceRequest
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

Refresh page Apr 20, 2024 02:11

Supported Clients
SmartClient WebClient NGClient

Methods Summary
Boolean addHeader(headerName, value) Add a header to the request.
void executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod) Execute the request method asynchronous using windows authentication.
void executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod) Execute the request method asynchronous.
void executeAsyncRequest(successCallbackMethod, errorCallbackMethod) Execute the request method asynchronous.
Response executeRequest() Execute the request method.
Response executeRequest(userName, password) Execute the request method.
Response executeRequest(userName, password, workstation, domain) Execute a request method using windows authentication.

Methods Details

addHeader(headerName, value)

Add a header to the request.

Parameters

String headerName ;
String value ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

method.addHeader('Content-type','text/xml; charset=ISO-8859-1')

executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)

Execute the request method asynchronous using windows authentication. Success callback method will be called when response is received. Response is sent as parameter in callback. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.

Parameters

String username the user name
String password the password
String workstation The workstation the authentication request is originating from.
String domain The domain to authenticate within.
Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out

Supported Clients

SmartClient,WebClient,NGClient

Sample

method.executeAsyncRequest('username','password','mycomputername','domain',globals.successCallback,globals.errorCallback)

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)

Execute the request method asynchronous. Success callback method will be called when response is received. Response is sent as parameter in callback. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.

Parameters

String username the user name
String password the password
Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out

Supported Clients

SmartClient,WebClient,NGClient

Sample

method.executeAsyncRequest(globals.successCallback,globals.errorCallback)

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)

Execute the request method asynchronous. Success callback method will be called when response is received. Response is sent as parameter in callback. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.

Parameters

Function successCallbackMethod callbackMethod to be called after response is received
Function errorCallbackMethod callbackMethod to be called if request errors out

Supported Clients

SmartClient,WebClient,NGClient

Sample

method.executeAsyncRequest(globals.successCallback,globals.errorCallback)

executeRequest()

Execute the request method.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var response = method.executeRequest()

To be able to reuse the client, the response must be
closed if the content is not read via getResponseBody
 or getMediaData:

response.close()

executeRequest(userName, password)

Execute the request method.

Parameters

String userName the user name
String password the password

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var response = method.executeRequest()

To be able to reuse the client, the response must be
closed if the content is not read via getResponseBody
 or getMediaData:

response.close()

executeRequest(userName, password, workstation, domain)

Execute a request method using windows authentication.

Parameters

String userName the user name
String password the password
String workstation The workstation the authentication request is originating from.
String domain The domain to authenticate within.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var response = method.executeRequest('username','password','mycomputername','domain');

  • No labels