An object of alternate ids for this object, with values as [[AltId]]
// you've marked certain forms with the FID of deprecated and want to filter for those
const warningMessage = baseObject.altIdsObject().FID.value().includes('deprecated') && 'Please use a different form';
An object of alternate ids for this object, with values as strings
// you've marked certain forms with the FID of deprecated and want to filter for those
const warningMessage = baseObject.altIds().FID.includes('deprecated') && 'Please use a different form';
Same as calling optAncestor(var).orElse(null)
If this object is a Collection it returns it as an array. The majority of objects in the system are Collections. For most objects, this is the same as calling [[children]].
const ids = obj.asArray().map(ob => ob);
Get the children of the object. This retrieval goes one level deep.
Optional
classType: string | numberconst childrenNames = obj.children().map(child => child.displayName());
The deleted children of this object. Only looks one level deep. E.g. a form's deleted children could include fields and form entries. A folder's deleted children could include folders, forms, and formulas, but not any of those forms' entries.
const deleted = baseObject.deletedChildren();
The default display name of this object. For the most part, this is the same as calling toString()
, which is the same as inserting the object into a string.
The following assumes you have already aggregated a selection of baseObject
s into an array
const displayNames = [];
for (const o of baseObjects) displayNames.push(o.displayName());
const namesList = `<ul><li>${displayNames.join('</li><li>')}</li></ul>`;
Sets the Display Name.
Same as calling optEnd().orElse(null)
Sets the ending instant for this alert. This is a required setting on this object.
Gets an array of all the object's ancestors.
const numberOfAncestors = obj.getAncestors().length;
Returns the Local Cache object for this Thread/Base Object.
A [[Java.Optional]] of the ancestor with the specific class.
const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} exists'));
A [[Java.Optional]] of the current object's parent object.
Optional
classType: string | numberconst ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} found'));
Same as calling optParent(var).orElse(null)
Optional
classType: string | numberThis is an Integer value containing the priority of the alert.
This is an Integer value containing the priority of the alert. The priority may be set to a new value in the range 1-10 where 1 is the highest priority. If any other value is set, it will be ignored.
This is the Integer value indicating the snoozeDelay in milliseconds. Each time the user views an alert it is snoozed for the specified time period. This means that it will stop playing any sound and the blinking alert indicator will turn off.
Sets the Integer value indicating the snoozeDelay in milliseconds. Each time the user views an alert it is snoozed for the specified time period. This means that it will stop playing any sound and the blinking alert indicator will turn off.
This is a String value containing the URL of a internet-ready sound file which is played repeatedly to get the attention of the recipient of the alert.
This is a String value containing the URL of a internet-ready sound file which is played repeatedly to get the attention of the recipient of the alert.
Same as calling optStart().orElse(null)
Sets the starting instant for this alert. If left unset it will default to right now.
This is a Integer value containing the current status of the alert. It may be set to any value from 0 to 100.
This is a Integer value containing the current status of the alert. It may be set to any value from 0 to 100. Attempts to set the field to any other value will be ignored and the original value will be retained.
Returns the type of the alert. It may be either "percent", "signature", or "auto"
Sets/overrides the existing alert type. This is a read-only String value containing the type of the alert. It is one of three values: "percent", "signature" or "auto". The percent type allows the recipient to set the status of the alert to a percent value between 0 and 100 in increments of 10 percent. The signature type allows the status to be set to 100 by checking a box. The auto type does not allow the recipient to set the status.
This is a String value containing an identifying value that can be used to retrieve this alert.
This is a String value containing an identifying value that can be used to retrieve this alert. It cannot be the same as any other alert ever sent. If an attempt is made to set this value to one that is already used by another alert, any changes to this alert will fail to save, which may cause the alert to never be sent. Maximum of 200 characters.
TODO
The versions of this object.
const versions = baseObject.versions();
Returns a view URL for this object, if it has one. This value is always a relative URL, meaning it does not contain the protocol prefix or domain name such as http://xyz.bluestep.net
.
const viewBtn = `<button data-href="${baseObject.viewUrl()}">Go to ${baseObject.displayName()}</button>;
Generated using TypeDoc
TODO
Example