ArchOrganizationInfo()

new ArchOrganizationInfo()

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchOrganizationInfo'.

static, readonly isArchOrganizationInfo :boolean

Returns true indicating that this is an ArchOrganizationInfo instance.

readonly areDivisionsAvailable :boolean

Returns whether or not divisions are available for this organization. If the Architect Scripting session is not connected, accessing this property will return false.

readonly areTtsEnginesAndVoicesAvailable :boolean

Returns whether or not text to speech engine and voice meta data is available for this organization. If the Architect Scripting session is not connected, accessing this property will return false.

readonly id :string

The organization's identifier. If the session is not connected or Scripting is unable to load organization information, this property will return nothing.

readonly logStr :string

Returns a string suitable for logging information about this organization info 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.

Overrides:

readonly name :string

The organization name for the currently connected session. If the session is not connected or Scripting is unable to load organization information, this property will return nothing.

readonly virtualAgentAvailable :boolean

Returns true indicating that virtual agent is available for this ArchOrganizationInfo instance.

readonly virtualAgentSummarizationAvailable :boolean

Returns whether Virtual Agent summarization capabilities are available for the organization.

Methods

getAllDivisions() → {Array.<ArchDivision>}

Gets all divisions for the organization. If divisions are not available for this organization, this method will return nothing.

Returns:
Array.<ArchDivision> -

Returns an array of divisions configured for the organization.

getDivisionById(divisionId) → {ArchDivision}

This looks up a division by its identifier and returns the matching division. If divisions are not available for this organization, this method will return nothing.

Parameters:
Name Type Description
divisionId string

the identifier of the division to look up.
Returns:
ArchDivision -
  • the division whose id matched the submitted divisionId. If not found, nothing is returned.

getDivisionByName(divisionName) → {ArchDivision}

This looks up a division by its name in a case insensitive manner and returns the matching division. If divisions are not available for this organization, this method will return nothing.

Parameters:
Name Type Description
divisionName string

the name of the division to look up.
Returns:
ArchDivision -
  • the division whose name matched the submitted divisionName. If not found, nothing is returned.

getHomeDivision() → {ArchDivision}

Gets the home division for the organization. If divisions are not available for this organization, this method will return nothing.

Returns:
ArchDivision -

The home division for the organization. In the event no home division can be determined, which should not happen, nothing is returned.

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
Overrides:

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.
Overrides:

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.
Overrides:

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.
Overrides:

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.
Overrides:

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.
Overrides: