Functions

#

showMessage(message, options)

Show a toast message in Page with following markdown support.

Italics       - _text_

Bold        - *text*

Underline   - __text__

Strikeout   - ~text~

Code        - `text`

Heading1    - # text

Heading3    - ### text

Blockquote  - !text

Hyperlink   - [click here](https://www.zoho.com)

Parameters:

Example

Warning with boldCopycopied

ZDK.Client.showMessage('This is an *important* warning.', { type: 'warning' });

#

showAlert(message, heading, accept_message)

Show Alert message with markdown support.

Parameters:

Examples

Simple AlertCopycopied

ZDK.Client.showAlert('First Name will be mandatory from next week');

Customised Alert with link, heading and button messageCopycopied

ZDK.Client.showAlert('You can [click here](https://www.zylker.com) to visit the page.', 'Notice', 'Got it!');

Alert with bold, break and underlineCopycopied

ZDK.Client.showAlert('This is an __important__ message\n This is an *important* message');

Alert with imageCopycopied

ZDK.Client.showAlert('![alt text](https://link-to/sample.png)');

#

showConfirmation(message, accept_message, reject_message) → {Boolean}

Show confirmation box with markdown support and accept/reject message.

Parameters:

Examples

Simple Confirmation BoxCopycopied

ZDK.Client.showConfirmation('Are you sure?');

Customised Confirmation BoxCopycopied

ZDK.Client.showConfirmation('Are you *sure*?', 'Yes. Got it!', 'Nope');

Output

true | false

#

getInput(options, heading, accept_message, reject_message) → {Object}

Get one or more input.

Parameters:

Examples

Text InputCopycopied

ZDK.Client.getInput([{ type: 'number', label: 'Enter No. of employees' }, { type: 'text', label: 'Enter batch name' }], 'Employees', 'OK', 'Cancel');

Output

['120', 'Batch A']

Default value sampleCopycopied

ZDK.Client.getInput([{ type: 'textarea', label: 'Enter batch name', default_value:'sample' }], 'Employees', 'OK', 'Cancel');

Output

['sample']

For picklist,Copycopied

ZDK.Client.getInput([{ type: 'picklist', label: 'Enter branch', list_options: [{ actual_value: "Sales", display_value: "Sales Department" }, { actual_value: "HR", display_value: "HR Department" }], default_value:"HR" }], 'Employees', 'OK', 'Cancel');

Output

['HR']

# Detail Page (Canvas) Detail Page (Standard)

openMailer(mail_config)

Open Mailer component.

Parameters:

Example

SampleCopycopied

ZDK.Client.openMailer({from: 'example@zoho.com', to: [{email: 'zylker@zyldomain.com', label: 'Zylker'}], cc: [{email: 'info@zyldomain.com', label: 'Zylker Info'}], subject: 'Welcome to Client Script', body: 'Hi Zylker!!', templateId:"1776121000000732265"});

#

navigateTo(page, params, data, target)

Navigate to record's detail page, create page, list view etc.,

Parameters:

Examples

Widget based web tab with PageLoad dataCopycopied

ZDK.Client.navigateTo('tab', { module: 'WebTab1' }, '_blank', { data: 'sample' })

Leads record list page in new tabCopycopied

ZDK.Client.navigateTo('tab', { module: 'Leads' }, '_blank');

Leads record list page with custom viewCopycopied

ZDK.Client.navigateTo('record_list', { module: 'Leads', custom_view_id: '111111000000046317' });

Leads record detail pageCopycopied

ZDK.Client.navigateTo('record_detail', { module: 'Leads', record_id: '11111023162335' });

Custom data to be passed and the data can be accessed from $Page.navigation_dataCopycopied

ZDK.Client.navigateTo('record_list', { module: 'Leads', custom_view_id: '111111000000046541', custom_data: [{ key: "value"}] },'_self',);

Leads record create page with layoutCopycopied

ZDK.Client.navigateTo('record_create', { module: 'Leads', layout_id: "111111000000069302"});

#

openPopup(config, data) → {object|string|number|boolean}

Open popup widget and await a response from the widget's $Client.close(). Moreover, custom data can be passed to widget's 'PageLoad' event. Supported Widget SDK version >= 1.2.

Parameters:

Example

SampleCopycopied

ZDK.Client.openPopup({ api_name: 'sample_widget', type: 'widget', header: 'Sample Widget', animation_type: 4, height: '450px', width: '450px', left: '10px' }, { data: 'sample data to be passed to "PageLoad" event of widget' });

#

openCallout(config, target, data) → {object|string|number|boolean}

Open callout widget and await a response from the widget's $Client.close(). Moreover, custom data can be passed to widget's 'PageLoad' event. Similar to [ZDK.Client.openPopup](ZDK.Client.html#.openPopup) but, opens as a callout to the target component(Eg., Field in form) and by default, widget closes when out of focus. Supported Widget SDK version >= 1.2.

Parameters:

Example

SampleCopycopied

ZDK.Client.openCallout({ api_name: 'sample_widget', type: 'widget', header: "Sample Widget", height: '450px', width: '450px' }, { type: 'field', api_name: 'State' }, { data: 'sample' });

#

createFlyout(name, config) → {Flyout}

Parameters:

Example

SampleCopycopied

ZDK.Client.createFlyout('myFlyout', { header: 'Sample Flyout', animation_type: 4 });

#

getFlyout(name) → {Flyout}

Get a Flyout with name

Parameters:

Example

SampleCopycopied

ZDK.Client.getFlyout('myFlyout');

#

showLoader(config)

Display the loader with message.

Parameters:

Example

SampleCopycopied

ZDK.Client.showLoader({type: 'page', template:'vertical-bar', message: 'Loading ...'});

#

hideLoader()

Hides the Loader

Example

SampleCopycopied

ZDK.Client.hideLoader();