$Client

Members

#

userAgent

client userAgent information

string
Examples

SampleCopycopied

$Client.userAgent;

Output

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.88 Safari/537.36

#

isOnline

client online status

boolean
Examples

SampleCopycopied

$Client.isOnline;

Output

true

#

platform

client platform information

string
Examples

SampleCopycopied

$Client.platform;

Output

web

#

url

client url

string
Examples

SampleCopycopied

$Client.url;

Output

https://crm.zoho.com/crm/org77591XXXX/tab/Leads/create?layoutId=527627200000009XXXX

#

geoLocation

current client location information (the user is asked for permission to report location information)

object
Examples

SampleCopycopied

$Client.geoLocation;

Output

{
"latitude":8.894601,
"longitude":77.343917,
"altitude":null,
"accuracy":1255.3807245270482,
"altitudeAccuracy":null,
"heading":null,
"speed":null
}

#

selectedValue

Text selected by the user on the current page.

object
Examples

SampleCopycopied

$Client.selectedValue;

Output

{
"value":"Selected Text"
}

Functions

#

refresh(config)

Soft-refresh the client

Parameters:
Name Type Attributes Default Description
config Object

configuration
triggerOnLoad Boolean <optional>
 false

to trigger onLoad event of that page
Examples

Sample 1Copycopied

$Client.refresh();

Sample 2Copycopied

$Client.refresh({triggerOnLoad: true});

#

openURL(url)

opens a new browser tab/window

Parameters:
Name Type Attributes Description
url String <optional>

url of the page to be openend
Example

SampleCopycopied

$Client.openURL("https://www.zylker.com")

#

copyToClipboard(text)

Copies the text to the clipboard

Parameters:
Name Type Description
text string

Text to copy
Example

Copy textCopycopied

$Client.copyToClipboard('1234567890');