Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProxyConfiguration

In version 7.15.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

container

container: AbstractElement

containerAsRestCallAction

containerAsRestCallAction: RestCallAction

containerAsWebServiceCallAction

containerAsWebServiceCallAction: WebServiceCallAction

hostExpression

hostExpression: string

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

hostExpressionModel

hostExpressionModel: Expression | null

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

model

model: IModel

passwordExpression

passwordExpression: string

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

passwordExpressionModel

passwordExpressionModel: Expression | null

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

portExpression

portExpression: string

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

portExpressionModel

portExpressionModel: Expression | null

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

useConfigurationExpression

useConfigurationExpression: string

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

useConfigurationExpressionModel

useConfigurationExpressionModel: Expression | null

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

usernameExpression

usernameExpression: string

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

usernameExpressionModel

usernameExpressionModel: Expression | null

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

allProperties

asLoaded

  • asLoaded()

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach()

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

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise

  • 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: ): void

        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

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 ProxyConfiguration 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 ProxyConfiguration

Static createInRestCallActionUnderProxyConfiguration

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

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

    Parameters

    Returns ProxyConfiguration

Static createInWebServiceCallActionUnderProxyConfiguration

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

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

    Parameters

    Returns ProxyConfiguration

Generated using TypeDoc