Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StringType

In version 7.9.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

container

containerAsAppServiceAction

containerAsAppServiceActionParameter

containerAsConstant

containerAsCreateVariableAction

containerAsDataSetColumn

containerAsDataSetParameter

containerAsDocumentTemplateParameter

containerAsImportMapping

containerAsMLModelCallParameterMapping

containerAsMicroflowBase

containerAsMicroflowParameterBase

containerAsMicroflowParameterObject

containerAsPageParameter

containerAsPublishedOperation

containerAsPublishedParameter

containerAsRestOperationParameter

containerAsResultHandling

containerAsValueMappingElement

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

model

unit

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: function
        • (elem: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new StringType instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns StringType

Static createInAppServiceActionParameterUnderParameterType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'parameterType' property of the parent appservices.AppServiceActionParameter element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 to 9.0.1

    Parameters

    Returns StringType

Static createInAppServiceActionUnderActionReturnType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'actionReturnType' property of the parent appservices.AppServiceAction element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 to 9.0.1

    Parameters

    Returns StringType

Static createInConstantUnderType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'type' property of the parent constants.Constant element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInCreateVariableActionUnderVariableType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'variableType' property of the parent microflows.CreateVariableAction element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInDataSetColumnUnderColumnType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'columnType' property of the parent datasets.DataSetColumn element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInDataSetParameterUnderParameterType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'parameterType' property of the parent datasets.DataSetParameter element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInDocumentTemplateParameterUnderParameterType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'parameterType' property of the parent documenttemplates.DocumentTemplateParameter element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInImportMappingUnderParameterType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'parameterType' property of the parent importmappings.ImportMapping element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.16.0 and higher

    Parameters

    Returns StringType

Static createInMLModelCallParameterMappingUnderParameterType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'parameterType' property of the parent microflows.MLModelCallParameterMapping element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 9.10.0 and higher

    Parameters

    Returns StringType

Static createInMicroflowBaseUnderMicroflowReturnType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'microflowReturnType' property of the parent microflows.MicroflowBase element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInMicroflowParameterBaseUnderParameterType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'parameterType' property of the parent microflows.MicroflowParameterBase element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInMicroflowParameterObjectUnderVariableType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'variableType' property of the parent microflows.MicroflowParameterObject element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInPageParameterUnderParameterType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'parameterType' property of the parent pages.PageParameter element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 9.4.0 and higher

    Parameters

    Returns StringType

Static createInPublishedOperationUnderOperationReturnType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'operationReturnType' property of the parent webservices.PublishedOperation element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInPublishedParameterUnderParameterType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'parameterType' property of the parent webservices.PublishedParameter element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInRestOperationParameterUnderType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'type' property of the parent rest.RestOperationParameter element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.17.0 and higher

    Parameters

    Returns StringType

Static createInResultHandlingUnderVariableType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'variableType' property of the parent microflows.ResultHandling element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Static createInValueMappingElementUnderType

  • Creates and returns a new StringType instance in the SDK and on the server. The new StringType will be automatically stored in the 'type' property of the parent mappings.ValueMappingElement element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.9.0 and higher

    Parameters

    Returns StringType

Generated using TypeDoc