Class DocumentVersions

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

Returns the content as a string after applying the [[ExistingContentSettings]. Same as calling existingContent().apply(settings).toReaderContent().apply(settings).content().

Returns the content as a string using the default [[ExistingContentSettings]. Will use 'UTF-8' as the encoding. Same as calling existingContent().toReaderContent().content().

TODO

Returns the file size of the current document.

TODO

Returns the Content Type of the current document.

Sets the Content Type of the current document.

The "created at" timestamp of this object.

Example

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

Returns the user and timestamp relating to the upload of this document.

Returns the timestamp of when the current document was uploaded.

The creator of this object.

Example

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

Returns a [[Java.IO.DataHandler]] for this document

Returns a [[Java.IO.DataSource]] for this document

Returns a webdav URL for the current document.

TODO

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

TODO

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

TODO

Returns the filename of the current document.

Returns the parent [[Folder]] of the current document.

Provides an Inputstream after applying the [[ExistingContentSettings]. Same as calling existingContent().apply(settings).forInputStream(input => {}).

Provides an Inputstream with default [[ExistingContentSettings]]. Same as calling existingContent().forInputStream(input => {}).

Provides a reader after applying the [[ExistingContentSettings]. Same as calling existingContent().apply(settings).toReaderContent().apply(settings).forReader(reader => {}).

Provides a reader with default [[ExistingContentSettings]]. Will use 'UTF-8' for enconding. Same as calling existingContent().toReaderContent().forReader(reader => {}).

TODO

Set new content using JavaByteArray. Same as calling fromBytes(newContent().apply(settings), bytes)

Set new content using JavaByteArray. Same as calling fromBytes(newContent(), bytes)

Set new content using string. Same as calling fromString(newContent().apply(settings), content)

Set new content using string. Same as calling fromString(newContent(), content)

Returns the path to the current document.

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

TODO

TODO

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 true if an Admin uploaded the document

Returns a true if the document is not uploaded yet

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

Same as calling optLock().orElse(null)

The modified date of this object.

Example

const isModified = baseObject.modified();
Copy

Returns the timestamp of the last modified action of the current document.

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

Example

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

TODO

TODO

Returns the notes(descripton) set for the current document.

Sets the notes(description) for the current document.

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

Example

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

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

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

Returns the path to the current document relative to it's Document Library.

Returns a URL to access the current document.

TODO

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

Returns a URL to access the current document that relies on the id of the field, rather than the name of the document.

Creates the "thumbnail" builder object with which you can build an image stored in a document field, or provide a link to download the contents. Minimum width/height is 56. If you do not pass a value, it will default still to 56.

Example

// passing an image to the the page
B.out += documentField.thumbnail()
.height(200)
.width(200)
.html(true) // If unspecified or this value is false, the result will be the relative link.
.build(); // build must be called if you want any output of this

Copy

This is simply a shorthand method for when you are extracting images from document fields.for display on merge reports. Any value of either parameter less than 56 will default to 56.

Example

The Following techniques will create the same result

documentField.thumbnailHtml(10,15);
documentField.thumbnailUrl({height: 10, width: 15, html: true});
documentField.thumbnail().width(10).height(15).html(true).build();

Copy

Just like thumbnail() but with the secondary methods built in; you simply pass the parametersas an object and .build() is called for you. Click DocumentThumbnailSettings type parameter below to see the list of available parameter values. Note that if you provide a height or a width, but not both, then the missing of those two will default to the value of the other; I.E. it will create a square image

Example

This result is equivalent to the example provided for the thumbnail() method

B.out += documentField.thumbnailUrl({height: 200, width: 200, html: true})

Copy

Returns the current document as a byte array after applying the [[ExistingContentSettings]. Same as calling existingContent().apply(settings).toBytes().

Returns the current document as a byte array using default [[ExistingContentSettings]. Same as calling existingContent().toBytes().

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

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

Set new content using a [[Java.IO.DataHandler]]