Initializing help system before first use

AttachmentTag

Information about an attachment tag

Method summary

name description
getDescription Returns the attachment tag's description.
getName Returns the attachment tag's name.
getUsage Returns the attachment tag's usage.
isMandatory Returns true if the attachment tag is mandatory

Methods

method
getDescription ( ) → {string}

Returns the attachment tag's description.

details
Returns:
returns table
Type Description
type
string
The attachment tag's description
Example
examples
var description = attachmentTag.getDescription();
Back to Top
method
getName ( ) → {string}

Returns the attachment tag's name.

details
Returns:
returns table
Type Description
type
string
The attachment tag's name
Example
examples
var name = attachmentTag.getName();
Back to Top
method
getUsage ( ) → {insight.enums.AttachmentTagUsage}

Returns the attachment tag's usage.

details
Returns:
returns table
Type Description
type
insight.enums.AttachmentTagUsage
The attachment tag's usage
Example
examples
var usage = attachmentTag.getUsage();
Back to Top
method
isMandatory ( ) → {boolean}

Returns true if the attachment tag is mandatory. A mandatory tag is required to be assigned to an attachment before the scenario can be executed.

details
Returns:
returns table
Type Description
type
boolean
true if this attachment tag is mandatory, otherwise false
Example
examples
var isMandatory = attachmentTag.isMandatory();
Back to Top

© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.