ArchFactoryPrompts()

new ArchFactoryPrompts()

A factory instance that currently provides the ability to query Architect prompts by name. If you wish to add, delete or edit prompts, we currently recommend that you use the Genesys Cloud Platform SDK to do this. Do not attempt to create an instance of this class. Architect Scripting will create the factory instance as needed.

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchFactoryPrompts'.

static, readonly isArchFactoryPrompts :boolean

Returns true indicating that this is an ArchFactoryPrompts instance.

readonly logStr :string

A logging string for the Architect Factory Task 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

getPromptByPromptNameAsync(prefixedPromptName, callbackFunction) → {Promise}

Returns the prompt for the supplied prefixed prompt name. A prefixed prompt name has either 'Prompt.' or 'PromptSystem.' in front of the name. If the prompt cannot be found, nothing is returned; The prompt name lookup is case insensitive.

Parameters:
Name Type Description
prefixedPromptName string

the prompt name prefixed by either 'Prompt.' or 'PromptSystem.' such as 'Prompt.Welcome'.
callbackFunction callbackArchBasePrompt

the function that will be called back when the prompt lookup successfully completes.
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: