ArchAsyncTracker()

new ArchAsyncTracker()

The Architect Scripting class that is used to track promises during scripting execution. Promises need to be resolved prior to creating, saving, checking in or publishing flows. Instances of this class will be created automatically by Architect Scripting as needed.

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchAsyncTracker'.

static, readonly isArchAsyncTracker :boolean

Returns true indicating that this is an ArchAsyncTracker instance.

readonly logStr :string

A logging string for the Async Tracker instance.

Overrides:

readonly logStrTypeOnly :string

This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.

Inherited From:

Methods

addPromise(promise) → {Promise}

Adds a promise to be tracked to prevent operations like save from starting till its resolved.

Parameters:
Name Type Description
promise Promise

the JavaScript promise to track. Promises are returned from async Architect Scripting operations.
Returns:
Promise

allSettled() → {Promise}

Returns a promise for all asynchronous operations currently being tracked.

Returns:
Promise

isFilterMatch(archFilterObject) → {boolean}

Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.

Parameters:
Name Type Description
archFilterObject ArchFilterObject

the object filter to use to determine if it's a match.
Returns:
boolean
Inherited From:

logError(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true.

Parameters:
Name Type Description
errorStr string

the error string to log.
Inherited From:

logErrorAndThrow(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true and then throws the string in the errorStr parameter.

Parameters:
Name Type Description
errorStr string

the error string to log. This should be a non-blank string.
Throws:
  • Throws the submitted error string.
Inherited From:

logNote(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotes is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.
Inherited From:

logNoteVerbose(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotesVerbose is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.
Inherited From:

logWarning(warningStr)

Logs a warning to the logging service with a log header from this object's logStr property value when ArchLogging#logWarnings is true.

Parameters:
Name Type Description
warningStr string

the warning string to log. This should be a non-blank string.
Inherited From: