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';
An array of alternate ids for this object.
// 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);
The [[BaseRecord]] (also known as the Record or Entity) that contains this entry.
Optional
writable: booleanconst record = entry.baseRecord();
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.
The [[FormMetaData]] object that represents this entry.
const formName = entry.form().displayName();
The [[FormEntry]] object that contains information about this entry and the form.
Optional
writable: booleanYou need to change two entries, making one as present=false
and one as attitude=positive
// destructure the field you want out of the fields object
const {present} = entry1.formEntry().fields;
present.val(false);
const {attitude} = entry2.formEntry().fields;
attitude.val('positive');
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 | numberThe [[Id]] or [[AltId]] that the system deems most relevant.
const displayDiv = `<div class="object-card" id="${baseObject.topId()}">
<div class="title">${baseObject}</div>
<div class="body">Hello World!</div>
</div>;
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
A Relate entry.
If your form is single-entry (e.g. profile info), it can only hold one set of data for each of its fields. If you have a [[MultiFormEntry]] called Attendance and add data for today's attendance, that set of data is stored as an Entry.
To take it further, imagine you have fields
present: bool
,minutesLate: number
, andattitude:
[[SingleSelectField]]. If you only fill outpresent
and hit save, that constitutes an Entry.An Entry can be modified later. You might want to go back in the evening and add
attitude
to the Entry, or you realize you erroneously marked someone present. See [[FormEntry]] for an example of how to do this.