true), or not (false).
* @methodOf WLAuthorizationManager#
*/
function isAuthorizationRequired(responseStatus: number, responseHeaders: Object): boolean;
/**
* @description Checks whether the provided response status and headers represent a protected resource that requires authorization.
* @param {Integer} responseStatus Mandatory. Specifies the response status code.
* @param {String} responseHeaders Mandatory. A String representation of the response headers separated by CRLF, as returned from XMLHttpRequest.getAllResponseHeaders().
* @returns A boolean value, indicating whether authorization is required (true), or not (false).
* @methodOf WLAuthorizationManager#
*/
function clearAccessToken(accessToken: Object): WLPromise;
/**
* @description Returns the scope of the protected resource for the provided response headers.
* When you create a SecurityCheckChallengeHandler, you must implement the following methods:
*
* - handleChallenge() - The MobileFirst framework calls this method only for the relevant challenge. This function is used to perform required actions,
* such as hiding the application screen, displaying the login screen, or other actions required to pass the challenge successfully.
* - handleSuccess() - This method is called when the MobileFirst Server reports an authentication success.
* - handleFailure() - This method is called when the MobileFirst Server reports an authentication failure.
*
*
* The following APIs are available on the generated GatewayCheckChallengeHandler:
*
* - cancel() - Notifies the MobileFirst framework that the authentication process needs to be canceled.
* The MobileFirst framework then disposes of the original request that triggered the authentication.
* - submitChallengeAnswer(answer) - Call this method to send an answer back to the security check that triggered this challenge. The answer should be in a JSON format.
*
* @param securityCheckName security check name that represents the challenge,
* Used to identify which security check requires authentication.
*
* @methodOf WL.Client#
*
*/
function createSecurityCheckChallengeHandler(securityCheckName: string): WL.Client.SecurityCheckChallengeHandler;
class AbstractChallengeHandler {
isWLHandler: boolean;
activeRequest: Object;
requestWaitingList: Object[];
/**
* This function is called whenever the response is considered relevant to this challenge. This function is used to perform required actions,
* such as hiding the application screen, displaying the login screen, or other actions required to pass the challenge successfully.
* @param challenge Challenge to handle
* @methodOf WL.Client.AbstractChallengeHandler#
* @name WL.Client.AbstractChallengeHandler#handleChallenge
*/
handleChallenge(challenge: Object): void;
/**
* Notifies the MobileFirst framework that the authentication process needs to be canceled.
* The MobileFirst framework then disposes of the original request that triggered the authentication
* @param err Error message if available
* @methodOf WL.Client.AbstractChallengeHandler#
* @name WL.Client.AbstractChallengeHandler#cancel
*/
cancel(): void;
}
class SecurityCheckChallengeHandler extends AbstractChallengeHandler{
MAX_NUMBER_OF_FAILURES: number;
numOfFailures: number;
/**
* This method is called when the MobileFirst Server reports an authentication success.
**/
handleSuccess(identity?: any): void;
/**
* This method is called when the MobileFirst Server reports an authentication failure.
**/
handleFailure(err?: any): void;
/**
* Call this method to send an answer back to the security check that triggered this challenge. The answer should be in a JSON format.
**/
submitChallengeAnswer(answer: Object): void;
}
class GatewayChallengeHandler extends AbstractChallengeHandler{
/**
* User calls this function when the the challenge was handled successfully.
* When a success is submitted, the state of successes is checked for all challenges issued per original request.
* What this means is that, if all challenges are successfully met, the original message would be resent automatically.
*/
submitSuccess(): void;
/**
* Must be implemented by developer.
*
* This method will be invoked by the IBM MobileFirst Platform for every server response.
* It is responsible to detect whether server response contains data
* that should be processed by this challenge handler.
* @param transport Response that arrived from the server
* @return true if the response is a challenge that this handler handles
*/
canHandleResponse(transport: any): boolean;
/**
* Used to send collected credentials to a specific URL. The developer can also specify request parameters, headers, and callback.
* @param reqURL URL to send data to
* @param options Other options like timeout, extra headers
* @param submitLoginFormCallback Callback method when operation is done
*/
submitLoginForm(reqURL: string, options: Object, submitLoginFormCallback: Function): void;
}
/**
* Gets the display name of the device. The display name is retrieved from the MobileFirst Server registration data.
* Note: Remote disable and active notifying customizations, if any, will be ignored when this API call is made. The default UI will be displayed instead. This limitation is applicable to iOS & Windows only.
*
* @param {Object} options An object that contains onSucess and onFailure completion callback functions.
* The onSuccess function receives a JSON object parameter that contains the server's response, which includes the
* display name of the the device or null if no display name was set. For example:
*
onSucess and onFailure completion callback functions.
*
* @methodOf WL.Client#
*/
function setDeviceDisplayName(deviceDisplayName: string, options: Object): void;
}
/**
* =================================================================
* Source file taken from :: wlgap.d.ts
* =================================================================
*/
declare module WL.App {
/**
* supported only on Android environment
* returns the screen height
* @returns {number} screen height
*/
function getScreenHeight(): number;
/**
* supported only on Android environment
* returns the screen width
* @returns {number} screen width
*/
function getScreenWidth(): number;
/**
* supported only on Android environment
* retrieving screen size
* @param {Function} callback Mandatory function. The callback function that is invoked when the size is received.
*/
function getScreenSize(callback: Function): void;
/**
* supported only on Android, Windows Phone and iOS environments
* reset server context
*/
function resetServerContext(): void;
/**
* supported only on Android, Windows Phone and iOS environments
* returns user preference value for the given key
* @param {string} key
* @param {Object} options
* @param {Function} options.onSuccess
* @param {Function} options.onFailure
*/
function readUserPref(key: string, options: Object): void;
/**
* supported only on Android, Windows Phone and iOS environments
* writes user preference with the give key,value pair
* @param {string} key
* @param {Object} value
*/
function writeUserPref(key: string, value: Object): void;
/**
* supported only on Android, Windows Phone and iOS environments
* get init parameters
* @param {string} parameters
* @param {Function} successCallback Mandatory function.
* @param {Function} failCallback Mandatory function.
*/
function getInitParameters(parameters: string, successCallback: Function, failCallback: Function): void;
/**
* supported only on Android, Windows Phone and iOS environments
* Send an action to the native code. The action will be processed immediately, if the target receiver has been registered.
* Otherwise, the action will be stored in the cache and processed as soon as the target receiver becomes available (registered).
* @param {string} action - a string that identifies target receivers; all receivers registered with the specified action will receive the message.
* @param {Object} data - an optional data object to be passed to target receivers along with action;
* @param {string} tag
*/
function sendActionToNative(action: string, data?: Object, tag?: string): void;
/**
* supported only on Android, Windows Phone and iOS environments
* Registers an action receiver. In JavaScript a receiver should be implemented as a callback that can receive an object.
* @param {string} id - a string that identifies the receiver. This string will be specified in the native code when sending notifications to JavaScript.
* @param {Function} callback - implementation of receiver. This callback will be called when an action identified by "id" is sent from the native code.
* @param {string} tag
*/
function addActionReceiver(id: string, callback: Function, tag?: string): void;
/**
* supported only on Android, Windows Phone and iOS environments
* Removes (unregisters) an action receiver. All further messages addressed to this receiver will be placed to the cache. The pending
* messages will be delivered as soon as the receiver is registered again with the same id.
* @param id - a string that identifies the receiver to be unregistered.
*/
function removeActionReceiver(id: string): void;
}
declare module WL.Badge {
/**
* Sets the application badge to the number provided.
* @description Sets the application badge to the number provided.
* @note {Note} This object is only applicable to iOS and Windows Phone 8 applications.
*
*
* @param number Mandatory. Integer. An integer that is displayed as a badge over the application icon.
* For iOS, a value lesser than or equal to 0 removes the application badge. Values that are too long (5 digits, or more) to be entirely displayed in an iPhone device are truncated with ellipsis.
* For Windows Phone 8, a value lesser than or equal to 0 removes the application badge. A number greater than 99 sets the tile count to 99.
*
* @methodOf WL.Badge#
*/
function setNumber(num: number): void;
}
/**
* =================================================================
* Source file taken from :: wllogger.d.ts
* =================================================================
*/
declare module WL.Logger {
/**
*
* Configures the logger globally. This means every logger instance created using WL.Logger.create, all uses of the global
* WL.Logger functions and any native API calls to the MobileFirst logger API are affected.
*
* @example
* WL.Logger.config()
*
* Merge the passed object parameter with the current configuration, which can be retrieved using WL.Logger.status()
*
* @param {object} [options] Defines the logger's behavior.
* @param {boolean} [options.stringify] Turns arguments to strings and concatenates them (true) or leaves arguments as an array (false). Default is true.
* @param {boolean} [options.pretty] Turn JSON into a human readable format. Default is false.
* @param {boolean} [options.stacktrace] Enable/disable printing the stacktrace from an error message. Default is false.
* @param {function} [options.callback] Called after a log message is sent to the console with the following parameters:
*
* message: (string or array) The log message. String if stringify is true, array otherwise.
* level: (string) Log level.
* package: (string) Package that is associated with the log or empty string.
*
* @param {string} [options.pkg] Associates log messages with a package. By default does not associate (includes an empty string).
* @param {object} [options.tag] Contains keys: level and tag.
* @param {boolean} [options.tag.level] Appends log level tag to the string log message (true) or does nothing (false). Default is false.
* @param {boolean} [options.tag.pkg] Appends package name string message (true) or does nothing (false). Default is false.
* @param {object} [options.filters] Object with key/value pairs like {'package': 'LEVEL'} for packages to log. This is treated as a whitelist; only log
* calls for instances matching pkg will be logged. Default is to log all messages (empty object). Explicitly pass an empty object or null (not undefined) to remove filters.
* @param {boolean} [options.capture] Turn log capture on or off. This is meaningful in hybrid environments only.
* @param {integer} [options.maxFileSize] Maximum amount of data (in bytes) to store in the file when capture is on. This is meaningful in hybrid environments only. Default is true.
* @param {boolean} [options.autoSendLogs] Turn auto send Logs on or off.
* @param {string[]|string|number} [options.level] A list of one or more of the following items:
*
* An array of the log levels to show. In JavaScript, only log calls at the listed levels are shown. In native code in a hybrid app, log output at and above the most verbose of the levels listed in the array are shown.
* The name of the log level at which to set the logger. Output will be printed for log API calls at and above the configured level.
* The Numeric Priority Level at which to set the logger. Output will be printed for log API calls at and above the configured level.
*
* Default: Show all logs at all levels (empty array).
*
* @returns {this} Returns the current instance.
*
* @methodOf WL.Logger#
*/
function config(options: Object): WL.LogInstance;
/**
* Shows the status (current configuration) of the logger.
*
* @example
* WL.Logger.status()
*
* .then(function (state) {
* //{ enabled : true, stringify: true, filters : {},
* // level : 'info', pkg : '', tag: {level: false, pkg: true} }
* })
*
* .fail(function (errMsg) {
* //errMsg = error message
* });
*
* @returns {Promise} Resolved with current status, rejected with an error message.
*
* @methodOf WL.Logger#
*/
function status(): WLPromise;
/**
* Updates the state (also called context or status) of the logger.
*
* @example
* WL.Logger.debug('Hello world'); //No context passed
* //Hello world
*
* WL.Logger.ctx({pkg: 'hello'}).debug('Hello world'); //Package name context passed
* //[hello] Hello world
*
* Caution: filters, maxFileSize, capture, and level returned from this call may not accurately reflect the current behavior
* in hybrid applications if the native codebase has modified these settings in the native application layer.
*
* @param {object} [options] See arguments defined for WL.Logger.config for information about the object that can be passed.
*
* @returns {this} Returns the current instance.
*
* @methodOf WL.Logger#
*/
function ctx(options: Object): WL.LogInstance;
/**
* Prints arguments to the console. Has a priority of 600 and a level of TRACE.
*
* @example
* WL.Logger.trace('Hello world');
* //Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf WL.Logger#
* @name WL.Logger#trace
*/
function trace(message: any): void;
/**
* Prints arguments to the console. Has a priority of 500 and a level of DEBUG.
*
* @example
* WL.Logger.debug('Hello world');
* //Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf WL.Logger#
* @name WL.Logger#debug
*/
function debug(message: any): void;
/**
* Prints arguments to the console. Has a priority of 400 and a level of LOG.
*
* @example
* WL.Logger.log('Hello world');
* //Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf WL.Logger#
* @name WL.Logger#log
*/
function log(message: any): void;
/**
* Prints arguments to the console. Has a priority of 300 and a level of INFO.
*
* @example
* WL.Logger.info('Hello world');
* //Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf WL.Logger#
* @name WL.Logger#info
*/
function info(message: any): void;
/**
* Prints arguments to the console. Has a priority of 200 and a level of WARN.
*
* @example
* WL.Logger.warn('Hello world');
* //Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf WL.Logger#
* @name WL.Logger#warn
*/
function warn(message: any): void;
/**
* Prints arguments to the console. Has a priority of 100 and a level of ERROR.
*
* @example
* WL.Logger.error('Hello world');
* //Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf WL.Logger#
* @name WL.Logger#error
*/
function error(message: any): void;
/**
* Prints arguments to the console. Has a priority of 50 and a level of FATAL. Only use this function for events that
* are unrecoverable and completely break the application such that the user must force close their application.
*
* @example
* WL.Logger.fatal('Hello world');
* //Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf WL.Logger#
* @name WL.Logger#fatal
*/
function fatal(message: any): void;
/**
* Creates an instance of a logger with its own context (also called status or state).
*
* @example
* var logger = WL.Logger.create({pkg: 'mypackage'});
*
* logger.trace('Hello world');
* //[mypackage] Hello world
*
* logger.debug('Hello world');
* //[mypackage] Hello world
*
* logger.log('Hello world');
* //[mypackage] Hello world
*
* logger.info('Hello world');
* //[mypackage] Hello world
*
* logger.warn('Hello world');
* //[mypackage] Hello world
*
* logger.error('Hello world');
* //[mypackage] Hello world
*
* logger.fatal('Hello world');
* //[mypackage] Hello world
*
* @param {Object} [options] See arguments defined for WL.Logger.config for information about the object that can be passed.
*
* @returns {LogInstance} Has the following methods from WL.Logger: .trace, .debug, .log,
* .info, .warn, .error, and .fatal.
* @methodOf WL.Logger#
*/
function create(options: Object): WL.LogInstance;
/**
* Attach additional metadata to the next logger instance call.
*
* @example
* WL.Logger.metadata(
* {
* userRealName : 'Robert Paulson'
* }
* );
*
* @example
* WL.Logger.metadata( { hi : 'world' } ).info('hello');
*
* @param {Object} [options] an object to attach to the next logger instance call
*
* @methodOf WL.Logger#
* @name WL.Logger#metadata
*/
function metadata(options: Object): WL.LogInstance;
/**
*
* Send any logs collected up to this point to the IBM MobileFirst server.
*
* @returns {Promise} Resolved with success status, rejected with an error message.
*
* @methodOf WL.Logger#
* @name WL.Logger#send
*/
function send(): WLPromise;
/**
* Retrieves and applies any matching configuration profile from the IBM MobileFirst Server.
* A matching configuration profile acts as an override of the local configuration.
* Configuration profiles are defined by the IBM Worklight administrator in the MobileFirst
* admin console. Restores to original settings when the server indicates that no
* matching configuration profile exists.
*
* This API call is only applicable in Android and IOS environments. It is a safe, but no-op,
* call in other environments.
*
* @methodOf WL.Logger#
* @return promise
*/
function updateConfigFromServer(): WLPromise;
}
declare module WL{
class LogInstance {
/**
* Prints arguments to the console. Has a priority of 600 and a level of TRACE.
*
* @example
* var logger = WL.Logger.create({pkg: 'myapp'});
* logger.trace('Hello world');
* //[myapp] Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf LogInstance#
* @name LogInstance#trace
*/
trace(message: any): void;
/**
* Prints arguments to the console. Has a priority of 500 and a level of DEBUG.
*
* @example
* var logger = WL.Logger.create({pkg: 'myapp'});
* logger.debug('Hello world');
* //[myapp] Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf LogInstance#
* @name LogInstance#debug
*/
debug(message: any): void;
/**
* Prints arguments to the console. Has a priority of 400 and a level of LOG.
*
* @example
* var logger = WL.Logger.create({pkg: 'myapp'});
* logger.log('Hello world');
* //[myapp] Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf LogInstance#
*/
log(message: any): void;
/**
* Prints arguments to the console. Has a priority of 300 and a level of INFO.
*
* @example
* var logger = WL.Logger.create({pkg: 'myapp'});
* logger.info('Hello world');
* //[myapp] Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf LogInstance#
* @name LogInstance#info
*/
info(message: any): void;
/**
* Prints arguments to the console. Has a priority of 200 and a level of WARN.
*
* @example
* var logger = WL.Logger.create({pkg: 'myapp'});
* logger.warn('Hello world');
* //[myapp] Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf LogInstance#
* @name LogInstance#warn
*/
warn(message: any): void;
/**
* Prints arguments to the console. Has a priority of 100 and a level of ERROR.
*
* @example
* var logger = WL.Logger.create({pkg: 'myapp'});
* logger.error('Hello world');
* //[myapp] Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf LogInstance#
* @name LogInstance#error
*/
error(message: any): void;
/**
* Prints arguments to the console. Has a priority of 50 and a level of FATAL.
*
* @example
* var logger = WL.Logger.create({pkg: 'myapp'});
* logger.fatal('Hello world');
* //[myapp] Hello world
*
* @param message One or more messages of any data type.
*
* @methodOf LogInstance#
* @name LogInstance#fatal
*/
fatal(message: any): void;
}
}
/**
* =================================================================
* Source file taken from :: wlproperties.d.ts
* =================================================================
*/
declare module WL{
var AppProperty : {
DOWNLOAD_APP_LINK: string,
ENVIRONMENT: string,
APP_DISPLAY_NAME: string,
APP_LOGIN_TYPE: string,
APP_VERSION: string,
HEIGHT: string,
IID: string,
LATEST_VERSION: string,
LOGIN_DISPLAY_TYPE: string,
LOGIN_REALM: string,
MAIN_FILE_PATH: string,
SHOW_IN_TASKBAR: string,
THUMBNAIL_IMAGE_URL: string,
WELCOME_PAGE_URL: string,
WIDTH: string,
WORKLIGHT_ROOT_URL: string,
WORKLIGHT_RELATIVE_URL: string,
APP_SERVICES_URL: string,
APP_SERVICES_RELATIVE_URL: string,
WLCLIENT_TIMEOUT_IN_MILLIS: string
};
var AppLoginType : {
LOGIN_ON_STARTUP: string,
LOGIN_ON_DEMAND: string,
NO_LOGIN: string
};
var UserInfo : {
IS_USER_AUTHENTICATED: string,
USER_NAME: string,
LOGIN_NAME: string,
USER_ID: string
};
var Orientation : {
AUTO: number,
LANDSCAPE: number,
PORTRAIT: number
};
var FixedViewType : {
TOP: string,
BOTTOM: string
};
var Language : {
DIRECTION_LTR: number,
DIRECTION_RTL: number,
LANGUAGES_RTL: string[]
};
var WLErrorCode : {
UNEXPECTED_ERROR: string,
API_INVOCATION_FAILURE: string,
USER_INSTANCE_ACCESS_VIOLATION: string,
AUTHENTICATION_REQUIRED: string,
DOMAIN_ACCESS_FORBIDDEN: string,
// Client Side Errors
UNRESPONSIVE_HOST: string,
LOGIN_FAILURE: string,
REQUEST_TIMEOUT: string,
PROCEDURE_ERROR: string,
UNSUPPORTED_VERSION: string,
UNSUPPORTED_BROWSER: string,
DISABLED_COOKIES: string,
CONNECTION_IN_PROGRESS: string,
AUTHORIZATION_FAILURE: string,
CHALLENGE_HANDLING_CANCELED: string
};
var FBRealmPopupOptions : {
width: number,
height: number
};
var EPField : {
// NOTICE - value must be equal to the field name!!!
SUPPORT_COOKIES: string,
DESKTOP: string,
WEB: string,
MOBILE: string,
USES_AUTHENTICATOR: string,
SAVES_USERNAME: string,
HAS_NATIVE_LOGGER: string,
USES_NATIVE_TOOLBAR: string,
USES_CORDOVA: string,
SUPPORT_DIRECT_UPDATE_FROM_SERVER: string,
SUPPORT_DIAGNOSTIC: string,
ISIOS: string,
WEB_BROWSER_ONLY: string,
SUPPORT_CHALLENGE: string,
SUPPORT_SHELL: string,
SUPPORT_DEVICE_AUTH: string,
SERVER_ADDRESS_CONFIGURABLE: string,
SUPPORT_WL_USER_PREF: string,
SUPPORT_WL_NATIVE_XHR: string,
SUPPORT_WL_SERVER_CHANGE: string,
SUPPORT_OAUTH: string
};
var BaseProfileData : {
SUPPORT_COOKIES: boolean,
SUPPORT_DIRECT_UPDATE_FROM_SERVER: boolean,
SUPPORT_DIAGNOSTIC: boolean,
SUPPORT_DEVICE_AUTH: boolean,
SERVER_ADDRESS_CONFIGURABLE: boolean,
SUPPORT_WL_USER_PREF: boolean
};
var WebProfileData : {
WEB: boolean
};
var DesktopProfileData : {
DESKTOP: boolean,
USES_AUTHENTICATOR: boolean,
SAVES_USERNAME: boolean
};
var MobileProfileData : {
USES_AUTHENTICATOR: boolean,
SAVES_USERNAME: boolean
};
}
/**
* =================================================================
* Source file taken from :: wlresourcerequest.d.ts
* =================================================================
*/
declare class WLResourceRequest {
/**
* @class
* The WLResourceRequest object is used to send a request to any protected or unprotected resource using an absolute or relative URL.
* It exposes a set of methods that allow you to set up and configure the requested object.
*
* If a request is sent to a protected resource, the WLResourceRequest object automatically handles the MobileFirst OAuth-based security model
* protocol and invokes the required challenges.
* The WLAuthorizationManager and WLResourceRequest classes are supported for the following environments only:
* Android, iOS, Windows 8.1, Window 10 UWP and Web.
*
* @param {string} url Mandatory. Specifies absolute or relative URL. If you send a request to an adapter, you must add the /adapters path element.
* For example: /adapters/myAdapterName/myMethodName
* @param {string} method Mandatory. Request method, usually WLResourceRequest.GET or WLResourceRequest.POST
* @param {object} options Optional. An object containing the following properties:
*
* options.timeout: (integer) Optional. Request timeout, in milliseconds.
* options.scope: (string) Optional. Protecting scope of the requested resource.
* options.backendServiceName: (string) Optional. Name of the backend service configured on server to fetch data from. For example :resorts
*
*
* @example
* var request = new WLResourceRequest('/adapters/sampleAdapter/multiplyNumbers', WLResourceRequest.GET);
* request.setQueryParameter('params', [5, 6]);
* request.send().then(
* function(response) {
* // success flow, the result can be found in response.responseJSON
* },
* function(error) {
* // failure flow
* // the error code and description can be found in error.errorCode and error.errorMsg fields respectively
* }
* );
* @example
* To access a microservice URL such as "http://mybluemix.net/resorts/cities" and the Mobile Foundation runtime backend service is configured as follows
*{"service": "resorts",
* "baseUrl":"http://mybluemix.net/resorts"}
*
* var options = { timeout : 30000, backendServiceName : "resorts"}
* var request = new WLResourceRequest('/cities', WLResourceRequest.GET,options);
* request.send().then(
* function(response) {
* // success flow, the result can be found in response.responseJSON
* },
* function(error) {
* // failure flow
* // the error code and description can be found in error.errorCode and error.errorMsg fields respectively
* }
* );
* @name WLResourceRequest
*/
constructor(_url: string, _method: string, _options?: Object);
/**
* @description Returns request URL. The URL must have been passed to the constructor.
* @methodOf WLResourceRequest#
*/
getUrl(): string;
/**
* @description Returns current request method. A valid request method must have been passed to constructor.
* @methodOf WLResourceRequest#
*/
getMethod(): string;
/**
* @description Returns query parameters as a JSON object with key-value pairs.
* @methodOf WLResourceRequest#
*/
getQueryParameters(): Object;
/**
* @description Sets query parameters.
* @param {object} parameters Optional. A JSON object with key-value pairs.
* If this parameter is null, or undefined, the query parameters are cleared.
* @methodOf WLResourceRequest#
*/
setQueryParameters(parameters?: Object): void;
/**
* @description Sets a new query parameter. If a parameter with the same name already exists, it will be replaced.
* @param {String} name Mandatory. Parameter name.
* @param value Mandatory. Parameter value. Should be string, number or boolean.
* @methodOf WLResourceRequest#
*/
setQueryParameter(name: string, value: string|number|boolean): void;
/**
* @description Returns array of header values.
* @param {string} name Optional. Header name. If header name is specified, this function returns an array of header values
* stored with this header, or undefined, if the specified header name is not found. If name is null, or undefined,
* this function returns all headers.
* @methodOf WLResourceRequest#
*/
getHeaders(name?: string): Object[];
/**
* @description Returns array of header names. It can be empty, if no headers have been added.
* @methodOf WLResourceRequest#
*/
getHeaderNames(): string[];
/**
* @description Returns a first header value stored with the specified header name. The value is returned as a string.
* Can be undefined if a header with the specified name does not exist.
* @param {String} name Mandatory. Header name.
* @methodOf WLResourceRequest#
*/
getHeader(name: string): string;
/**
* @description Sets request headers. The existing headers are replaced.
* @param {Object} requestHeaders Optional. JSON object with request headers. Each header value should be either string, or array of strings. This function
* throws an error if one of the specified header values is not valid. If this parameter is not specified, all headers will be removed.
* @methodOf WLResourceRequest#
*/
setHeaders(requestHeaders?: Object): void;
/**
* @description Sets a new header or replaces an existing header with the same name.
* @param {String} name Mandatory. Header name.
* @param value Mandatory. Header value. The value must be of a simple type (string, boolean or value).
* @methodOf WLResourceRequest#
*/
setHeader(name: string, value: string|number|boolean): void;
/**
* @description Adds a new header. If a header with the same name already exists, the header value will be added to the existing header. The name is
* case insensitive.
* @param {String} name Mandatory. Header name.
* @param value Mandatory. Header value. The value must be of a simple type (string, number or boolean).
* @methodOf WLResourceRequest#
*/
addHeader(name: string, value: string|number|boolean): void;
/**
* @description Returns request timeout, in milliseconds.
* @methodOf WLResourceRequest#
*/
getTimeout(): number;
/**
* @description Sets request timeout. If timeout is not specified, then a default timeout will be used.
* @param {Integer} requestTimeout Mandatory. Request timeout, in milliseconds.
* @methodOf WLResourceRequest#
*/
setTimeout(requestTimeout: number): void;
/**
* @description Sends the request to a server.
* @param content Optional. Body content. It can be of a simple type (like string), object, or undefined.
* @returns Promise
* @example
* var request = WLResourceRequest(url, method, timeout);
* request.send(content).then(
* function(response) {
* // success flow
* },
* function(error) {
* // fail flow
* }
* );
*
* @methodOf WLResourceRequest#
*/
send(content?: any): WLPromise;
/**
* @description Sends the request to a server with URL encoded form parameters.
* @param {Object} json Mandatory. Body content as JSON object or string as form data. The JSON object values must be a simple type.
* The content type will be set to application/x-www-form-urlencoded.
* @returns Promise
* @example
* var request = WLResourceRequest(url, method, options);
* request.send(json).then(
* function(response) {
* // success flow
* },
* function(error) {
* // fail flow
* }
* );
*
* @methodOf WLResourceRequest#
*/
sendFormParameters(json: Object): WLPromise;
static GET: string;
static POST: string;
static PUT: string;
static DELETE: string;
static HEAD: string;
static OPTIONS: string;
static TRACE: string;
static CONNECT: string;
}
/**
* =================================================================
* Source file taken from :: worklight.d.ts
* =================================================================
*/
declare module WL.Events {
var WORKLIGHT_IS_CONNECTED: string;
var WORKLIGHT_IS_DISCONNECTED: string;
}
declare module WL.Environment {
var PREVIEW: string;
var IPHONE: string;
var IPAD: string;
var DESKTOPBROWSER: string;
var ANDROID: string;
var WINDOWS_PHONE_8: string;
var WINDOWS8: string;
var MOBILE_WEB: string;
}
declare class WLPromise{
state():string;
always():Object;
then(onSuccess?:Function, onFailure?:Function, onProgress?:Function):WLPromise;
promise(obj?:Object):Object;
fail(failCallbacks:Function|Function[], additionalFailCallbacks?:Function|Function[]):WLPromise;
done(doneCallbacks:Function|Function[], additionalDoneCallbacks?:Function|Function[]):WLPromise;
progress(progressCallbacks:Function|Function[], additionalProgressCallbacks?:Function|Function[]):WLPromise;
}