ssCore.HTTP.autoEncodeResource

Canonicalizes the resource, which includes converting unsafe characters in the resource into escape sequences.


Availability:

First available in version 3.5 build 331.


Input Parameters:

flag - [Optional] - When set to "true", extended/accented characters in the resource name will be converted into escape sequences. Valid values include: false,true. Default value is false.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.HTTP.autoEncodeResource( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.HTTP.autoEncodeResource( paramsObject );


Notes:

Setting this flag to true indicates that the resource specified in the HTTP.resource command should be canonicalized before use. This process converts unsafe characters in the resource name, such as spaces and percent signs, to escape sequences that the http server can accept. This flag must not be set if the resource is already canonicalized, as the re-encoding process may create an incorrect resource name.

                

Examples:

ssCore.HTTP.autoEncodeResource({flag: true});