Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
XSP (JavaScript™)
The XSP library contains classes that access the browser context.
XSPUrl (JavaScript™)
Represents a URL.
encodeParameter (XSPUrl - JavaScript™)
Encodes a parameter.

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the IBM® Domino® back-end.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.
  - DirectoryUser (JavaScript™)
    Represents a user entry in the server directory.
  - NotesXspDocument (JavaScript™)
    Represents a document associated with the XPage context in which the server script is running.
  - NotesXspViewEntry (JavaScript™)
    Represents the view entry associated with the XPage context in which the server script is running. A view entry describes a row in a view.
  - XSPContext (JavaScript™)
    Represents the context in which the server script is running.
  - XSPUrl (JavaScript™)
    Represents a URL.
    - XSPUrl (XSPUrl - JavaScript™)
      Creates an XSPUrl object.
    - decodeParameter (XSPUrl - JavaScript™)
      Decodes a parameter.
    - encodeParameter (XSPUrl - JavaScript™)
      Encodes a parameter.
    - getAddress (XSPUrl - JavaScript™)
      Gets the full address of the URL excluding the query string.
    - getFragment (XSPUrl - JavaScript™)
      Gets the fragment identifier of the URL.
    - getHost (XSPUrl - JavaScript™)
      Gets the host name or address of the URL.
    - getParameter (XSPUrl - JavaScript™)
      Gets the value of a query string parameter.
    - getParameterName (XSPUrl - JavaScript™)
      Gets the name of a query string parameter.
    - getParametersCount (XSPUrl - JavaScript™)
      Gets the number of parameters in the query string.
    - getPath (XSPUrl - JavaScript™)
      Gets the path of the URL.
    - getPort (XSPUrl - JavaScript™)
      Gets the port number of the URL.
    - getQueryString (XSPUrl - JavaScript™)
      Gets the full query string (including the leading question mark) of the URL.
    - getScheme (XSPUrl - JavaScript™)
      Gets the scheme (protocol) of the URL.
    - getSiteRelativeAddress (XSPUrl - JavaScript™)
      Gets the address of a site starting with the root directory (omitting the scheme, host, port, and fragment).
    - hasParameter (XSPUrl - JavaScript™)
      Checks if a query string parameter exists.
    - removeAllParameters (XSPUrl - JavaScript™)
      Removes all query string parameters.
    - removeParameter (XSPUrl - JavaScript™)
      Removes a query string parameter.
    - setAddress (XSPUrl - JavaScript™)
      Sets the full address of the URL.
    - setFragment (XSPUrl - JavaScript™)
      Sets the fragment identifier of the URL.
    - setHost (XSPUrl - JavaScript™)
      Sets the host name or address of the URL.
    - setParameter (XSPUrl - JavaScript™)
      Sets the value of a query string parameter.
    - setPath (XSPUrl - JavaScript™)
      Sets the path of the URL.
    - setPort (XSPUrl - JavaScript™)
      Sets the port number of the URL.
    - setScheme (XSPUrl - JavaScript™)
      Sets the scheme (protocol) of the URL.
    - toSiteRelativeString (XSPUrl - JavaScript™)
      Gets the URL as a string in site-relative form.
    - toString (XSPUrl - JavaScript™)
      Gets the URL as a string.
  - XSPUserAgent (JavaScript™)
    Represents the User-Agent request header field of the HTTP request sent from the browser.

encodeParameter (XSPUrl - JavaScript™)

Encodes a parameter.

Defined in

Syntax

encodeParameter(param:string) : string

encodeParameter(param:string, enc:string) : string


Parameters	Description
`param`	A string.
`enc`	The name of the encoding scheme.


Return value	Description
`string`	The parameter encoded in `application/w-www-form-urlencoded` format.

Usage

The encoding determines what characters are represented by consecutive sequences of the form %xy.