Options
All
  • Public
  • Public/Protected
  • All
Menu

In version 10.7.0: removed experimental In version 10.1.0: introduced

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Rest$StringValue"
versionInfo: StructureVersionInfo = ...

Accessors

  • get container(): TContainer
  • Returns TContainer

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

  • get model(): TModel
  • Returns TModel

  • get value(): string
  • set value(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

Methods

  • 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 StringValue

  • delete(): void
  • Deletes this element from the model.

    Returns void

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

    Returns StringValue

  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: StringValue) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<StringValue>
  • 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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<StringValue>

  • toJSON(): IStructureJSON
  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

  • traverse(visit: (structure: IStructure) => void): void
  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new StringValue 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

    • model: IModel

    Returns StringValue

  • Creates and returns a new StringValue instance in the SDK and on the server. The new StringValue will be automatically stored in the 'testValue' property of the parent OperationParameter element passed as argument.

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

    Parameters

    Returns StringValue

  • Creates and returns a new StringValue instance in the SDK and on the server. The new StringValue will be automatically stored in the 'password' property of the parent BasicAuthenticationScheme element passed as argument.

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

    Parameters

    Returns StringValue

  • Creates and returns a new StringValue instance in the SDK and on the server. The new StringValue will be automatically stored in the 'username' property of the parent BasicAuthenticationScheme element passed as argument.

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

    Parameters

    Returns StringValue

  • Creates and returns a new StringValue instance in the SDK and on the server. The new StringValue will be automatically stored in the 'testValue' property of the parent ImplicitMappingBody element passed as argument.

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

    Parameters

    Returns StringValue

  • Creates and returns a new StringValue instance in the SDK and on the server. The new StringValue will be automatically stored in the 'testValue' property of the parent OperationParameter element passed as argument.

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

    Parameters

    Returns StringValue

  • Creates and returns a new StringValue instance in the SDK and on the server. The new StringValue will be automatically stored in the 'testValue' property of the parent RestParameter element passed as argument.

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

    Parameters

    Returns StringValue

Generated using TypeDoc