Navigate Parent URL

Table of Contents

Overview

This JS API task allows you to perform cross-domain navigation, which is the navigation that needs to be done to another domain from within a widget embedded in a page.

Request Details

Syntax

ZOHO.CREATOR.UTIL.navigateParentURL(config);

Syntax Details

The syntax holds:

  • <config> (object) - The configuration required for URL navigation. This configuration includes the following parameters.
NameTypeDescription
actionstring

Performs an action based on the input value.
Possible Values:

  • open loads the specified URL in a new/parent window.
  • reload opens the previously visited page.
  • back reloads the parent window.
  • close shuts the last opened parent container.
  • close all shuts all open dialog parent containers in the parent window.

Note: If the key value is given as open, the url and window parameters should also be included.

url
(Optional)		string

You can specify any URL link here.

Example: 

windowstring

Decides where the URL is opened depending on the input value.
Possible Values:

  • new (default value) opens the URL in a separate window.
  • same opens the URL in the existing current window.

Possible Errors

Refer to this page for the complete list of error codes and messages.

Sample Input

Copiedvar config = {
  action: "close"
};
ZOHO.CREATOR.UTIL.navigateParentURL(config);