Overview | Package | Object Type | Deprecated | Index | Help
| Oracle9iAS Portal PL/SQL API Reference - 9.0.2.6
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES
SUMMARY: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE | DETAIL: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE

## Package wwpro_api_mobile

This package contains methods for mobile portlet development.

For more information about developing mobile portlets using the Oracle Portal Developer Kit (PDK) refer to the Getting Started article on Portal Studio. For more information about the wireless gateway, Oracle9iAS Wireless XML and other wireless issues, please refer to the Oracle9iAS Wireless documentation.

Scope:
  Public

Constant Summary
`DEVICE_MESSENGER` | `varchar2(2000)`
`DEVICE_MICRO_BROWSER` | `varchar2(2000)`
`DEVICE_MICROMESSENGER` | `varchar2(2000)`
`DEVICE_PC_BROWSER` | `varchar2(2000)`
`DEVICE_PDA_BROWSER` | `varchar2(2000)`
`DEVICE_VOICE_BROWSER` | `varchar2(2000)`
`IASW_CBCKLBL_HDR_MOD` | `varchar2(50)`
`IASW_CBCKURL_HDR_MOD` | `varchar2(50)`
`IASW_DEVICECLASS_HDR_MOD` | `varchar2(50)`
`IASW_DEVICEMAXSZ_HDR_MOD` | `varchar2(50)`
`IASW_DEVICEORIEN_HDR_MOD` | `varchar2(50)`
`IASW_DEVICESECURE_HDR_INS` | `varchar2(50)`
`IASW_DEVICESECURE_HDR_MOD` | `varchar2(50)`
`IASW_DEVICESECURE_HDR_SEC` | `varchar2(50)`
`IASW_HOMEURL_HDR_MOD` | `varchar2(50)`
`IASW_ORIGACCEPT_HDR_MOD` | `varchar2(50)`
`IASW_ORIGAGENT_HDR_MOD` | `varchar2(50)`
`IASW_SVCHOMEURL_HDR_MOD` | `varchar2(50)`
`IASW_SVCPRNTURL_HDR_MOD` | `varchar2(50)`
`IASW_USERADDRLN1_HDR_MOD` | `varchar2(50)`
`IASW_USERADDRLN2_HDR_MOD` | `varchar2(50)`
`IASW_USERADDRLNZ_HDR_MOD` | `varchar2(50)`
`IASW_USERAUTHKIND_HDR_MOD` | `varchar2(50)`
`IASW_USERBLOCK_HDR_MOD` | `varchar2(50)`
`IASW_USERCITY_HDR_MOD` | `varchar2(50)`
`IASW_USERCOMPANY_HDR_MOD` | `varchar2(50)`
`IASW_USERCOUNTRY_HDR_MOD` | `varchar2(50)`
`IASW_USERCOUNTY_HDR_MOD` | `varchar2(50)`
`IASW_USERDEVICEID_HDR_MOD` | `varchar2(50)`
`IASW_USERDISPNAME_HDR_MOD` | `varchar2(50)`
`IASW_USERKIND_HDR_MOD` | `varchar2(50)`
`IASW_USERLOCALE_HDR_MOD` | `varchar2(50)`
`IASW_USERLOCX_HDR_MOD` | `varchar2(50)`
`IASW_USERLOCY_HDR_MOD` | `varchar2(50)`
`IASW_USERNAME_HDR_MOD` | `varchar2(50)`
`IASW_USERPSTCOD_HDR_MOD` | `varchar2(50)`
`IASW_USERPSTCODX_HDR_MOD` | `varchar2(50)`
`IASW_USERSTATE_HDR_MOD` | `varchar2(50)`
`IASW_USERTYPE_HDR_MOD` | `varchar2(50)`

Function/Procedure Summary
`is_mobile_request` Determines whether a Portal request is from a browser accessing Portal via Oracla9iAS Wireless. | `boolean`
`render_link_markup` Renders a SimpleHref tag which can be used for outputting the link mode response to Oracle Portal. | ``
`set_html_mimetype` Sets the mime type header of the http response to text/html. | ``
`set_mobile_mimetype` Sets the HTTP mime type header of the http response to indicate that the output will be in Oracle9iAS Wireless XML (as opposed to text/html or text/xml). | ``
`set_xml_mimetype` Sets the mime type header of the http response to text/xml. | ``

Constant Detail

### DEVICE_MESSENGER

    DEVICE_MESSENGER constant varchar2(2000) := 'messenger'

### DEVICE_MICRO_BROWSER

    DEVICE_MICRO_BROWSER constant varchar2(2000) := 'microbrowser'

### DEVICE_MICROMESSENGER

    DEVICE_MICROMESSENGER constant varchar2(2000) := 'micromessenger'

### DEVICE_PC_BROWSER

    DEVICE_PC_BROWSER constant varchar2(2000) := 'pcbrowser'

### DEVICE_PDA_BROWSER

    DEVICE_PDA_BROWSER constant varchar2(2000) := 'pdabrowser'

### DEVICE_VOICE_BROWSER

    DEVICE_VOICE_BROWSER constant varchar2(2000) := 'voice'

### IASW_CBCKLBL_HDR_MOD

    IASW_CBCKLBL_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_MODULE_CALLBACK_LABEL'

### IASW_CBCKURL_HDR_MOD

    IASW_CBCKURL_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_MODULE_CALLBACK_URL'

### IASW_DEVICECLASS_HDR_MOD

    IASW_DEVICECLASS_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_DEVICE_CLASS'

### IASW_DEVICEMAXSZ_HDR_MOD

    IASW_DEVICEMAXSZ_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_DEVICE_MAXDOCSIZE'

### IASW_DEVICEORIEN_HDR_MOD

    IASW_DEVICEORIEN_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_DEVICE_ORIENTATION'

### IASW_DEVICESECURE_HDR_INS

    IASW_DEVICESECURE_HDR_INS constant varchar2(50) := 'false'

### IASW_DEVICESECURE_HDR_MOD

    IASW_DEVICESECURE_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_DEVICE_SECURE'

### IASW_DEVICESECURE_HDR_SEC

    IASW_DEVICESECURE_HDR_SEC constant varchar2(50) := 'true'

### IASW_HOMEURL_HDR_MOD

    IASW_HOMEURL_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_HOME_URL'

### IASW_ORIGACCEPT_HDR_MOD

    IASW_ORIGACCEPT_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_ORIG_ACCEPT'

### IASW_ORIGAGENT_HDR_MOD

    IASW_ORIGAGENT_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_ORIG_USER_AGENT'

### IASW_SVCHOMEURL_HDR_MOD

    IASW_SVCHOMEURL_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_SERVICE_HOME_URL'

### IASW_SVCPRNTURL_HDR_MOD

    IASW_SVCPRNTURL_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_SERVICE_PARENT_URL'

### IASW_USERADDRLN1_HDR_MOD

    IASW_USERADDRLN1_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_ADDRESSLINE1'

### IASW_USERADDRLN2_HDR_MOD

    IASW_USERADDRLN2_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_ADDRESSLINE2'

### IASW_USERADDRLNZ_HDR_MOD

    IASW_USERADDRLNZ_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_ADDRESSLASTLINE'

### IASW_USERAUTHKIND_HDR_MOD

    IASW_USERAUTHKIND_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_AUTHKIND'

### IASW_USERBLOCK_HDR_MOD

    IASW_USERBLOCK_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_BLOCK'

### IASW_USERCITY_HDR_MOD

    IASW_USERCITY_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_CITY'

### IASW_USERCOMPANY_HDR_MOD

    IASW_USERCOMPANY_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_COMPANYNAME'

### IASW_USERCOUNTRY_HDR_MOD

    IASW_USERCOUNTRY_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_COUNTRY'

### IASW_USERCOUNTY_HDR_MOD

    IASW_USERCOUNTY_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_COUNTY'

### IASW_USERDEVICEID_HDR_MOD

    IASW_USERDEVICEID_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_DEVICEID'

### IASW_USERDISPNAME_HDR_MOD

    IASW_USERDISPNAME_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_DISPLAYNAME'

### IASW_USERKIND_HDR_MOD

    IASW_USERKIND_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_USERKIND'

### IASW_USERLOCALE_HDR_MOD

    IASW_USERLOCALE_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCALE'

### IASW_USERLOCX_HDR_MOD

    IASW_USERLOCX_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_X'

### IASW_USERLOCY_HDR_MOD

    IASW_USERLOCY_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_Y'

### IASW_USERNAME_HDR_MOD

    IASW_USERNAME_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_NAME'

### IASW_USERPSTCOD_HDR_MOD

    IASW_USERPSTCOD_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_POSTALCODE'

### IASW_USERPSTCODX_HDR_MOD

    IASW_USERPSTCODX_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_POSTALCODEEXT'

### IASW_USERSTATE_HDR_MOD

    IASW_USERSTATE_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_STATE'

### IASW_USERTYPE_HDR_MOD

    IASW_USERTYPE_HDR_MOD constant varchar2(50) := 'HTTP_X_ORACLE_USER_LOCATION_TYPE'

Function/Procedure Detail

### is_mobile_request

    function is_mobile_request
    return boolean

  Determines whether a Portal request is from a browser accessing Portal via Oracla9iAS Wireless. Returns true if the Portal request is being made by an Oracle9iAS Wireless Gateway, otherwise returns false.

  Example:

         if
           wwpro_api_mobile.is_mobile_request
         then ...

  Returns:
    true for a mobile request, false for a desktop/HTML request
  Since:
    Oracle9iAS Portal 9.0.2.5

### render_link_markup

    procedure render_link_markup(
        p_link in varchar2,
        p_title in varchar2
    )

  Renders a SimpleHref tag which can be used for outputting the link mode response to Oracle Portal. The mime type header is also set and therefore this call should be the only markup returned in link mode. This procedure:
  1. Sets the mime type header to indicate a Oracle9iAS Wireless XML response.
  2. Writes a tag with the given link and title.

  Example:

         wwpro_api_mobile.render_link_markup
         (
             p_link  => l_link,
             p_title => 'MobilePortlet'
         );

  Parameters:
    `p_link` - the URL link which navigates to the portlet content, i.e. the URL passed in via the page_link entry in the portlet record
    `p_title` - the portlet title which identifies the portlet in the menu, i.e. the customized title fetched from the portlet's preference store, or the default title for the portlet
  Since:
    Oracle9iAS Portal 9.0.2.5

### set_html_mimetype

    procedure set_html_mimetype(
        p_close_header in boolean default true
    )

  Sets the mime type header of the http response to text/html. This procedure may optionally be called for non-mobile responses to set the mime type to text/html. However, it is not mandatory as the document defaults to text/html anyway.

  Example:

         wwpro_api_mobile.set_html_mimetype;

  Parameters:
    `p_close_header` - indicates whether the header is closed. When set to true, the header is closed (default). When set to false, the header is left open.
  Since:
    Oracle9iAS Portal 9.0.2.5

### set_mobile_mimetype

    procedure set_mobile_mimetype(
        p_close_header in boolean default true
    )

  Sets the HTTP mime type header of the http response to indicate that the output will be in Oracle9iAS Wireless XML (as opposed to text/html or text/xml).

  This procedure MUST be called before the Oracle9iAS Wireless XML document is written out. If the HTTP mime type header is not set to indicate Oracle9iAS Wireless XML, Oracle Portal will reject the returned markup to prevent it from causing parse errors when building up the mobile page.

  This procedure should also be used when rendering Oracle9iAS Wireless XML for portlet content for a desktop request (which is then automatically transformed by other components of Portal into HTML by Oracle Portal before being passed onto the browser).

  Example:

         wwpro_api_mobile.set_mobile_mimetype;

  Parameters:
    `p_close_header` - indicates whether the header is closed. When set to true, the header is closed (default). When set to false, the header is left open.
  Since:
    Oracle9iAS Portal 9.0.2.5

### set_xml_mimetype

    procedure set_xml_mimetype(
        p_close_header in boolean default true
    )

  Sets the mime type header of the http response to text/xml. This procedure should be called for text/xml responses to set the mime type to text/xml.

  Example:

         wwpro_api_mobile.set_xml_mimetype;

  Parameters:
    `p_close_header` - indicates whether the header section is closed. When set to true, the header is closed (default). When set to false, the header is left open.
  Since:
    Oracle9iAS Portal 9.0.2.5

Overview | Package | Object Type | Deprecated | Index | Help
| Oracle9iAS Portal PL/SQL API Reference - 9.0.2.6
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES
SUMMARY: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE | DETAIL: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE