Home > @i2analyze/i2connect > services > ISingleLineStringCondition
services.ISingleLineStringCondition interface
A condition that prompts the user for a single-line string value.
Signature:
interface ISingleLineStringCondition extends IConditionBase, ISupportsStringValidation, ISupportsMaxLength
Extends: IConditionBase, ISupportsStringValidation, ISupportsMaxLength
Introduced: API version 1.0
Properties
Property | Type | Description |
---|---|---|
defaultValue? | string | RequestSpecificValue<string> | (Optional) Gets the default value for the condition. |
description? | string | RequestSpecificValue<string> | (Optional) Gets a description of the condition, which might be displayed in the user interface. (Inherited from IConditionBase) |
hide? | HidePredicate | (Optional) Gets whether the condition should be hidden from the current user, based on information in the request. (Inherited from IConditionBase) |
isMandatory? | boolean | (Optional) Indicates whether the user must provide a value for the condition before they can use the service. (Inherited from IConditionBase) |
label | string | RequestSpecificValue<string> | Gets the label for the condition, which is displayed in the user interface. (Inherited from IConditionBase) |
logicalType | 'singleLineString' | Gets the logical type of values that fulfill the condition. |
maxStringLength? | ICharLimit | (Optional) Gets the maximum number of characters that the string can contain. (Inherited from ISupportsMaxLength) |
validation? | IStringValidator | (Optional) Gets the validator to use on the string value. (Inherited from ISupportsStringValidation) |