Page

Functions

# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)

getField(api_name) → {Field}

Get the Field by api name

Parameters:
Name Type Description
api_name String

Api Name of field

Field object

Field
Examples

SampleCopycopied

const field = ZDK.Page.getField('Last_Name');    // field => { getApiName: ƒ }
field.getApiName();

Output

Last_Name

# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)

getFields() → {Array.<Field>}

Get the list of fields in the Page as an array

Field object array

Array.<Field>
Examples

SampleCopycopied

let fields = ZDK.Page.getFields();      //  fields=> { getApiName: ƒ }
fields[0].getApiName();

Output

Annual_Revenue

# Create / Edit / Clone Pages

getSubform(api_name) → {Subform}

Get the Subform by api name

Parameters:
Name Type Description
api_name String

Api Name of subform

Subform object

Subform
Example

SampleCopycopied

ZDK.Page.getSubform('CFSubform');

# List Page (Standard) Wizard

getComponent(name) → {Component}

Get the Pages' Component by name

Parameters:
Name Type Description
name String

Name of the component
  list-custom-view  - custom view drop down component in list view
  list-view-type  - view select drop down component in list view
  record-create-wizard  - wizard component in create/edit/draft page

Component object

Component
Example

SampleCopycopied

ZDK.Page.getComponent('list-custom-view');

# List Page (Standard) Wizard

getComponents() → {array}

Get the list of components in the Page as an array

Component object array

array
Example

SampleCopycopied

ZDK.Page.getComponents();

# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)

getForm() → {Form}

Get the form object

Form object

Form
Example

SampleCopycopied

ZDK.Page.getForm();

# List Page (Standard)

getList() → {List}

Get the List View Object

List object

List
Example

SampleCopycopied

ZDK.Page.getList();

#

getButtonByID(id) → {Button}

Get the Pages' Button by ID

Parameters:
Name Type Description
id String

id of the button

Button object

Button
Example

SampleCopycopied

ZDK.Page.getButtonByID('118881188181');

#

getButton(api_name) → {Button}

Get the Pages' Button by api name

Parameters:
Name Type Description
api_name String

API Name of the button

Button object

Button
Examples

SampleCopycopied

let button = ZDK.Page.getButton('record_save'); // button => {getId: ƒ, getApiName: ƒ, getType: ƒ}
button.getApiName();

Output

record_save

#

getButtons() → {Array.<Button>}

Get the list of buttons in the Page as an array

Button object array

Array.<Button>
Examples

SampleCopycopied

let buttons = ZDK.Page.getButtons();      //  btns=> {getId: ƒ, getApiName: ƒ, getType: ƒ}
buttons[0].getApiName();

Output

page_back

# Detail Page (Canvas) Detail Page (Standard)

getLinkByID(id) → {Link}

Get the link in the page by id

Parameters:
Name Type Description
id String

ID of the link

Link object

Link
Example

SampleCopycopied

ZDK.Page.getLinkByID('11011323443');

Get the list of links in the Page as an array

Link object array

Array.<Link>
Example

SampleCopycopied

ZDK.Page.getLinks();

# Detail Page (Canvas) Detail Page (Standard)

getBlueprintTransitionByID() → {BlueprintTransition}

get blueprint transition by id

Example

SampleCopycopied

ZDK.Page.getBlueprintTransitionByID('104567100090');

# Detail Page (Canvas) Detail Page (Standard)

getBlueprintTransitions() → {Array.<BlueprintTransition>}

get blueprint transitions in page

Example

SampleCopycopied

ZDK.Page.getBlueprintTransitions();

# Detail Page (Canvas) Detail Page (Standard)

addTag(…tag_names)

Add tags in the page

Parameters:
Name Type Attributes Description
tag_names String <repeatable>

Name of the tag
Examples

Add a tagCopycopied

ZDK.Page.addTag('tagname');

Add multiple tagsCopycopied

ZDK.Page.addTag('tagname1', 'tagname2', 'tagname3');

# Detail Page (Canvas) Detail Page (Standard)

removeTag(…tag_names)

Remove tags in the page

Parameters:
Name Type Attributes Description
tag_names String <repeatable>

Name of the tag
Examples

Remove a tagCopycopied

ZDK.Page.removeTag('tagname');

Remove multiple tagsCopycopied

ZDK.Page.removeTag('tagname1', 'tagname2', 'tagname3');

# Detail Page (Canvas) Detail Page (Standard)

getTags() → {Array.<object>}

Get the list of tags in the Page as array of objects

object array

Array.<object>
Examples

SampleCopycopied

ZDK.Page.getTags();

Output

[{ name: 'tag1' }, { name : 'atom' }, { name : 'busy' }]