An object of alternate ids for this object, with values as [[AltId]]
An array of alternate ids for this object.
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]].
Get the children of the object. This retrieval goes one level deep.
OptionalclassType: string | numberClear the field's value.
// 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.
The "created at" timestamp of this object.
The creator of this object.
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.
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.
Sets the Display Name.
Returns this field's [[FormMetaData]] object.
Gets an array of all the object's ancestors.
HmacSHA256 base64-encoded string of the secret stored in the field. The system adds several "salt" values while computing the hash. This causes the hash to be unique to both the current user account and the actual secret value. Thus, it is not possible to compare hashed secrets between users, but for any paricular user the same secret will always result in the same hash value.
A utility function to generate a hash of a secret. This is useful for generating a hash of a secret that is passed in using the current entry as the salt and can be compared with another hash generated the same way.
This does not use the stored secret for calculating a hash.
If this field has a SID then this method is restricted to frozen formulas.
The Secret to get a salted hash of
The [[Id]] of this object bounded to T.
Returns the Local Cache object for this Thread/Base Object.
Same as calling optLock().orElse(null)
Optionaloptions: stringReturns the [[FieldMetaData]] object that this describes this field.
The [[User]] that last modified this object.
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.
A [[Java.Optional]] of the ancestor with the specific class.
A [[Java.Optional]] of the current object's parent object.
OptionalclassType: string | numberSame as calling optParent(var).orElse(null)
OptionalclassType: string | numberReset the current object so that it is cleared from the cache and looked up from the database.
Calculates the bit strength, a measure of how easily a secret can be cracked by random guessing. It goes through a formula consisting of a dictionary word check, a repeated/adjacent letters check, and a character complexity check. This includes upper and lowercase letters, numbers, punctuation, space, ASCII, and Unicode.
BlueStep recommends a minimum bit strength of 50, but the minimum-allowable bit strength (MABS) is customizable to each organization.
NOTE Setting the MABS only affects future secret. Forcing existing users to change weak secrets is currently a process only available to BlueStep employees.
The [[Id]] or [[AltId]] that the system deems most relevant.
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).
Optional value for this field. Alias for [[opt]].
The versions of this object.
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.
Secrets cannot be set via formula. Calling
secret.toString()will return thehashvalue.Example: ```javascript
const allUsers = B.queries.byName['All Users'].require('allUsers'); const user = allUsers.byId[userId]; const profile = user.forms.byName['Online Profile'].require('profile'); const secret = profile.fields.secret;