Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SdkLanguageOptionalParameters

List of additional applicable parameters for any given target language.

Properties

Optional allowedValues

List of allowed input values. Example: {@code [{"name": "name1", "description": "description1"}, ...]}

Optional description

description: undefined | string

Description for the parameter.

Optional displayName

displayName: undefined | string

Display name of the parameter.

Optional inputType

inputType: InputType

The input type for this param.

  • Input type is ENUM when only specific list of input strings are allowed.
  • Input type is EMAIL when input type is an email ID.
  • Input type is URI when input type is an URI.
  • Input type is STRING in all other cases.

Optional isRequired

isRequired: undefined | false | true

Information on whether the parameter is required or not.

Optional maxSize

maxSize: undefined | number

Maximum size as input value for this parameter. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

paramName

paramName: string

Name of the parameter.

Functions

getDeserializedJsonObj

getJsonObj