---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# cabrillo.nowapp - Client

# cabrillo.nowapp - Client {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read

The name space for Cabrillo Now App functions. This enables you to interact with screens inside of ServiceNow AI Platform® native mobile apps.

## cabrillo.nowapp - openLauncherScreen(String launcherScreenId) {#ariaid-title2}

Opens a mobile launcher native screen.
{#CNA-openLauncherScreen_S__table_pqc_55j_kxb__entry__3}

| Name | Type | Description |
|-|-|-|
| launcherScreenId | String | Sys_id of the launcher screen from the Applet launcher \[sys_sg_applet_launcher\] table. |
[Table 1. Parameters]

{#CNA-openLauncherScreen_S__table_pqc_55j_kxb} {#CNA-openLauncherScreen_S__table_qqc_55j_kxb__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the method is available on the native side. Valid values: * true: the method is available on the native side * false: the method is not available on the native side. {#CNA-openLauncherScreen_S__ul_jvs_4m5_qxb} |
[Table 2. Returns]

{#CNA-openLauncherScreen_S__table_qqc_55j_kxb}  

    const launcherScreenId = 'a9e30c7dc61122760116894de7bcc7bd'; 
    const result = cabrillo.nowapp.openLauncherScreen(launcherScreenId); 
    If (result === false) {  
        console.log("method is not available")  
    } 

Output:

    true

## cabrillo.nowapp - openScreen(String screenId) {#ariaid-title3}

Opens a mobile native screen.
{#CNA-openscreen_S__table_xsl_grj_kxb__entry__3}

| Name | Type | Description |
|-|-|-|
| screenId | String | The sys_id of the screen record to open from the Screen \[sys_sg_screen\] table. |
[Table 3. Parameters]

{#CNA-openscreen_S__table_xsl_grj_kxb} {#CNA-openscreen_S__table_ysl_grj_kxb__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the method is available on the native side. Valid values: * true: the method is available on the native side * false: the method is not available on the native side. {#CNA-openscreen_S__ul_jvs_4m5_qxb} |
[Table 4. Returns]

{#CNA-openscreen_S__table_ysl_grj_kxb}  

    const screenId = 'a9e30c7dc61122760116894de7bcc7bd'; 
    cabrillo.nowapp.openScreen(screenId); 
    If (result === false) {  
        console.log("method is not available")  
    }

Output:

    true

## cabrillo.nowapp - openScreenWithRecordContext(String screenId, String table, String recordId) {#ariaid-title4}

Opens a mobile native screen with a record context.
{#CNA-openScreenWithRecrdContext_S_S_S__table_cvx_xsj_kxb__entry__3}

| Name | Type | Description |
|-|-|-|
| ScreenId | string | Sys_id of the screen record to open from the Screen \[sys_sg_screen\] table. |
| table | string | The record table. |
| record | string | The record sys_id. |
[Table 5. Parameters]

{#CNA-openScreenWithRecrdContext_S_S_S__table_cvx_xsj_kxb} {#CNA-openScreenWithRecrdContext_S_S_S__table_dvx_xsj_kxb__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the method is available on the native side. Valid values: * true: the method is available on the native side * false: the method is not available on the native side. {#CNA-openScreenWithRecrdContext_S_S_S__ul_jvs_4m5_qxb} |
[Table 6. Returns]

{#CNA-openScreenWithRecrdContext_S_S_S__table_dvx_xsj_kxb}  

    const screenId = 'a9e30c7dc61122760116894de7bcc7bd'; 
    const recordId= '8e99daa3ff133100ba13757574847f2d'; 
    const table= 'sys_users'; 
    const result = cabrillo.nowapp.openScreenWithRecordContext(screenId, table, recordId); 
    If (result === false) {  
        console.log("method is not available")  
    } 

Output:

    true

## cabrillo.nowapp - performFunction(String functionId, String table, String recordId) {#ariaid-title5}

Executes a native mobile function.
Note:  
Only Action functions are supported for the Vancouver release. For more information, see [Action functions](https://www.servicenow.com/docs/access?context=mobile-actions&version=xanadu&pubname=xanadu-mobile&ft:locale=en-US).
{#CNA-performFunction_S_S_S__table_tjf_5vj_kxb__entry__3}

| Name | Type | Description |
|-|-|-|
| functionId | string | Sys_id of the target function from the Button \[sys_sg_button\] table. |
| table | string | The record table. Optional for Global Action items. For more information about mobile function, see [Action functions](https://www.servicenow.com/docs/access?context=mobile-actions&version=xanadu&pubname=xanadu-mobile&ft:locale=en-US). Note: Differences between Global and Record actions: * Record: Applies an action at the record level. For example, use this option to create a button that changes the state of a record. You can set the context to Record for actions on a particular field, a particular record, or swipe actions. If the action function includes a UI parameter with the Input source field set to Auto fill, you must specify the table in the Table field. * Global: Applies an action at the global, or list level. For example, use this option to add a button that creates a record. Do not use the Global setting for actions that are in the context of a record, or actions that include a UI parameter with the Input source field set to Auto fill. {#CNA-performFunction_S_S_S__ul_l51_bzj_kxb} |
| recordId | string | The record sys_id. Optional for Global Action Items. For more information about mobile function, see [Action functions](https://www.servicenow.com/docs/access?context=mobile-actions&version=xanadu&pubname=xanadu-mobile&ft:locale=en-US). Note: Differences between Global and Record action items: * Record: Applies an action at the record level. For example, use this option to create a button that changes the state of a record. You can set the context to Record for actions on a particular field, a particular record, or swipe actions. If the action function includes a UI parameter with the Input source field set to Auto fill, you must specify the table in the Table field. * Global: Applies an action at the global, or list level. For example, use this option to add a button that creates a record. Do not use the Global setting for actions that are in the context of a record, or actions that include a UI parameter with the Input source field set to Auto fill. {#CNA-performFunction_S_S_S__ul_rhp_mgw_4xb} |
[Table 7. Parameters]

{#CNA-performFunction_S_S_S__table_tjf_5vj_kxb} {#CNA-performFunction_S_S_S__table_ujf_5vj_kxb__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the method is available on the native side. Valid values: * true: the method is available on the native side * false: the method is not available on the native side. {#CNA-performFunction_S_S_S__ul_jvs_4m5_qxb} |
[Table 8. Returns]

{#CNA-performFunction_S_S_S__table_ujf_5vj_kxb}  

    const functionId= 'a9e30c7dc61122760116894de7bcc7bd'; 
    const recordId= '8e99daa3ff133100ba13757574847f2d'; 
    const table= 'sys_users'; 
    const result = cabrillo.nowapp.performFunction(functionId, table, recordId); 
    If (result === false) {  
        console.log("method is not available")  
    } 

Output:

    true

## cabrillo.nowapp - refresh() {#ariaid-title6}

Refresh the UI stack in the event a table update is made in the web view that may affect a previous screen.
{#CNA-refresh__table_j4s_wzj_kxb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 9. Parameters]

{#CNA-refresh__table_j4s_wzj_kxb} {#CNA-refresh__table_k4s_wzj_kxb__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the method is available on the native side. Valid values: * true: the method is available on the native side * false: the method is not available on the native side. {#CNA-refresh__ul_jvs_4m5_qxb} |
[Table 10. Returns]

{#CNA-refresh__table_k4s_wzj_kxb}  

    const result = cabrillo.nowapp.refresh(); 
    If (result === false) {  
        console.log("method is not available")  

Output:

    true