This section provides an overview of updates made to this version of the Oracle Application Express API Reference.
See Also:
For an overview of new features in Oracle Application Express, release 4.1, see "What's New" in Oracle Application Express Application Builder User's Guide.The following APIs have been updated or added to the Oracle Application Express API Reference for Oracle Application Express, release 4.1:
APEX_APPLICATION
The APEX_APPLICATION package is a PL/SQL package that implements the Oracle Application Express rendering engine. See "APEX_APPLICATION".
The following procedure has been added to this API:
STOP_APEX_ENGINE Procedure
This procedure signals the APEX engine to stop further processing and immediately exit to avoid adding additional HTML code to the HTTP buffer. See "STOP_APEX_ENGINE Procedure".
APEX_ERROR
The new APEX_ERROR package provides the interface declarations and some utility functions for an error handling function and includes procedures and functions to raise errors in an Application Express application. See "APEX_ERROR".
APEX_INSTANCE_ADMIN The APEX_INSTANCE_ADMIN package provides utilities for managing an Oracle Application Express runtime environment. See "APEX_INSTANCE_ADMIN".
The following procedures, functions, and parameters have been added to this API:
REMOVE_APPLICATION Procedure added
This procedure removes the application specified from the Application Express instance. See "REMOVE_APPLICATION Procedure".
Available Parameters for Instance Admin
Additional parameters added for APEX_INSTANCE_ADMIN.GET_PARAMETER and APEX_INSTANCE_ADMIN.SET_PARAMETER. Parameters also added for the following new fields In Instance Admin, under Instance Settings: SMTP Authentication USername, SMTP Authentication Password, Use SSL/TLS.
APEX_UTIL
The APEX_UTIL package provides utilities you can use when programming in the Oracle Application Express environment. See "APEX_UTIL".
The following procedures and functions have been added to this API:
DELETE_USER_GROUP Procedure Signature 1
This procedure deletes a user group by providing the primary key of the group. See "DELETE_USER_GROUP Procedure Signature 1".
DELETE_USER_GROUP Procedure Signature 2
This procedure deletes a user group by providing the name of the group. See "DELETE_USER_GROUP Procedure Signature 2".
GET_HIGH_CONTRAST_MODE_TOGGLE Function
This function returns a link to the current page that allows you to turn on or off, toggle, the mode. For example, if you are in standard mode, this function displays a link that when clicked switches high contrast mode on. See "GET_HIGH_CONTRAST_MODE_TOGGLE Function"
HOST_URL Function
This function returns the URL to the Application Express instance, depending on the option passed. See "HOST_URL Function".
IS_HIGH_CONTRAST_SESSION Function
This function returns a boolean true if the session is in high contrast mode and returns a boolean false if not in high contrast mode. See "IS_HIGH_CONTRAST_SESSION Function".
IS_HIGH_CONTRAST_SESSION_YN Function
This function returns Y if the session is in high contrast mode and N if not in high contrast mode. See "IS_SCREEN_READER_SESSION_YN Function".
REDIRECT_URL Procedure
This procedure redirects the browser to a new URL. See "REDIRECT_URL Procedure".
SET_SESSION_HIGH_CONTRAST_OFF Procedure
This procedure switches off high contrast mode for the current session. See "SET_SESSION_HIGH_CONTRAST_OFF Procedure".
SET_SESSION_HIGH_CONTRAST_ON Procedure
This procedure switches on high contrast mode for the current session. See "SET_SESSION_HIGH_CONTRAST_ON Procedure".
SHOW_HIGH_CONTRAST_MODE_TOGGLE Procedure
This procedure displays a link to the current page to turn on or off, toggle, the mode. For example, if you are in standard mode, this function displays a link that when clicked switches the high contrast mode on. See "SHOW_HIGH_CONTRAST_MODE_TOGGLE Procedure".
SET_COMPATIBILITY_MODE Procedure
This procedure controls the compatibility mode of the Application Express runtime engine. Certain runtime behaviors are changed from release to release and if you desire a certain behavior in your application, you can control this via the compatibility mode attribute of an application. See "SET_COMPATIBILITY_MODE Procedure".
APEX_JAVASCRIPT
The APEX_JAVASCRIPT functions and objects are used to provide client-side functionality, such as showing and hiding page elements, or making XML HTTP Asynchronous JavaScript and XML (AJAX) requests. See "JavaScript APIs".
The following procedure has been updated:
ADD_LIBRARY Procedure
A new p_key parameter has been added to this procedure. See "ADD_LIBRARY Procedure"
APEX_PLUGIN
The APEX_PLUGIN package provides the interface declarations and some utility functions to work with plug-ins. See "APEX_PLUGIN".
The following data type has been updated:
t_region
New parameters have been added to this data type. See "Data Types".
APEX_PLUGIN_UTIL
The APEX_PLUGIN_UTIL package provides utility functions that solve common problems when writing a plug-in. See "APEX_PLUGIN_UTIL".
The following procedure has been updated:
PRINT_LOV_AS_JSON Procedure
A new p_replace_substitutions parameter has been added to this procedure. See "PRINT_LOV_AS_JSON Procedure".
APEX_WEB_SERVICE
The APEX_WEB_SERVICE API allows you to integrate other systems with Application Express by allowing you to interact with Web services anywhere you can utilize PL/SQL in your application. See "APEX_WEB_SERVICE".
The following procedures and functions have been updated:
MAKE_REQUEST Procedure
A new p_transfer_timeout parameter has been added to this procedure. See "MAKE_REQUEST Procedure".
MAKE_REQUEST Function
A new p_transfer_timeout parameter has been added to this function. See "MAKE_REQUEST Function".
MAKE_REQUEST_REQUEST Function
A new p_transfer_timeout parameter has been added to this function. See "MAKE_REQUEST Function".