Class DateTimeField

An object of alternate ids for this object, with values as [[AltId]]

Example

// 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';
Copy

An object of alternate ids for this object, with values as strings

Example

// 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';
Copy

An array of alternate ids for this object.

Example

// 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';
Copy

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]].

Example

const ids = obj.asArray().map(ob => ob);
Copy

Get the children of the object. This retrieval goes one level deep.

Example

const childrenNames = obj.children().map(child => child.displayName());
Copy

Clear the field's value.

Example

// This is a surprisingly non-trivial example.numberField.val() > 10 && numberField.clear();// There are many things going on here:
// 1) We are performing a check that a value even exists in this field. If not, nothing happens.
// 2) If the first condition is met, we then check that the value is a number or a string representing a number
//    (remember: '5'==5 in JavaScript), and that it is greater than 10. If not, nothing happens.
// 3) If the first two conditions are met, the field is then cleared of its value.
Copy

The "created at" timestamp of this object.

Example

const createdAt = `<div class="created-at">${baseObject.created()}</div>`;
Copy

The creator of this object.

Example

alert(`Guess who created this. It was ${baseObject.creator().fullName()}. They are to blame.`);
Copy

Returns a delete URL for this object, else a blank string. Following the URL will delete the object, so proceed with caution.

Example

const deleteBtn = `<button data-href="${baseObject.deleteUrl()}">Go to ${baseObject.displayName()}</button>;
Copy

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.

Example

const deleted = baseObject.deletedChildren();
Copy

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.

Example

The following assumes you have already aggregated a selection of baseObjects into an array

const displayNames = [];
for (const o of baseObjects) displayNames.push(o.displayName());
const namesList = `<ul><li>${displayNames.join('</li><li>')}</li></ul>`;
Copy

Sets the Display Name.

Returns an edit URL for this object, else a blank string.

Example

const editBtn = `<button data-href="${baseObject.editUrl()}">Go to ${baseObject}</button>`;
Copy

Returns this field's [[FormMetaData]] object.

Example

const form = firstName.form();
const fieldNames = [];
for (field in form) fieldNames.push(form[field].displayName());
Copy

Gets an array of all the object's ancestors.

Example

const numberOfAncestors = obj.getAncestors().length;
Copy

The [[Id]] of this object bounded to T.

Example

const displayDiv = `<div class="object-card" id="${baseObject.id()}">
  <div class="title">${baseObject}</div>
  <div class="body">Hello World!</div>
</div>;
Copy

Returns whether the object is locked or not.

Deprecated

Part of the [[Lock]] API.

Example

const isLocked = baseObject.isLocked();
Copy

Returns whether the object is pending a lock or not.

Deprecated

Part of the [[Lock]] API.

Example

const isPendingLock = baseObject.isPendingLock();
Copy

Returns whether the object is pending an unlock or not.

Deprecated

Part of the [[Lock]] API.

Example

const lockPendingUnlock = baseObject.isPendingUnLock();
Copy

Returns whether the field is writable

Example

const firstNameClass = firstName.isWritable() ? 'active' : 'inactive';
Copy

Returns the Local Cache object for this Thread/Base Object.

Same as calling optLock().orElse(null)

Returns the [[FieldMetaData]] object that this describes this field.

Example

const firstNameClass = firstName.metaData().styleClass();
Copy

explore example

[[FieldMetaData.styleClass]]

The modified date of this object.

Example

const isModified = baseObject.modified();
Copy

The [[User]] that last modified this object.

Example

const modifierName = baseObject.modifier().fullName();
Copy

Optional value for this field. Same as [[valOpt]]. Try to use this as often as you can over val(); Null-pointer exceptions can be a pain, and this will provide a measure of safety. Try to reserve val() for situations where a field is required and you know that the value cannot be null.

Example

const middleName = middleName.opt().orElse('No Middle Name Set!');
// or, similarly 
const middleName = middleName.val() || 'No Middle Name Set!'
Copy

explore example

[[Java.Optional.isPresent]]

A [[Java.Optional]] of the ancestor with the specific class.

Example

const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} exists'));
Copy

explore example

[[Java.Optional.ifPresent]]

Returns the [[Lock]]

Deprecated

Part of the [[Lock]] API.

Example

const lockExpire = baseObject.optLock();
Copy

A [[Java.Optional]] of the current object's parent object.

Example

const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} found'));
Copy

explore example

[[Java.Optional.ifPresent]]

Same as calling optParent(var).orElse(null)

Get the field's value, or else it will return null. This is the same as calling opt().orElse(null) without typescript complaining. In many cases, this is also the same as simply calling val(), however some field implementations wish to employ defaults, such as text fields that return an empty string if they are null.

Reset the current object so that it is cleared from the cache and looked up from the database.

The [[Id]] or [[AltId]] that the system deems most relevant.

Example

const displayDiv = `<div class="object-card" id="${baseObject.topId()}">
  <div class="title">${baseObject}</div>
  <div class="body">Hello World!</div>
</div>;
Copy

Returns the bluestep.js classpath for the current object.

Example

const isBool = testForm.fields.mysteryField.typeName().toLowerCase().includes('boolean')
Copy

Makes changes to the database for this object

Gets the field's value if there is one, and will otherwise return null. Some overrides of this method have default return-values for convenience but, that would not make sense for this: the general-use case. In situations where the value might be null (e.g. non required field), consider using optional chaining: field.val()?.toString(). The preferred method to handle nulls in bs.js is simply [[opt]]/[[valOpt]]; as the methods available off of that can handle virtually any situation.

This is identical to calling field.opt().orElse(null).

Example

// it is important to notice that, due to how JavaScript works, doubleVal will evaluate to 0 if numberField.val() is null.
const doubleVal = numberField.val() * 2;

Copy

Set the field's value.

Example

// make the field say `hello`
field.val('hello');
Copy

Optional value for this field. Alias for [[opt]].

Example

date.valOpt().map(val => `Report Date: ${val}`).orElse('No Date');
Copy

explore example

[[Java.Optional.map]], [[Java.Optional.orElse]]

The version of this object or empty string if it doesn't exist.

Example

const version = baseObject.version();
Copy

The versions of this object.

Example

const versions = baseObject.versions();
Copy

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.

Example

const viewBtn = `<button data-href="${baseObject.viewUrl()}">Go to ${baseObject.displayName()}</button>;
Copy