Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProxyConfiguration

In version 7.15.0: introduced

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

id

id: string

model

model: IModel

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

containerAsRestCallAction

containerAsWebServiceCallAction

hostExpression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Returns string

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

    Parameters

    • newValue: string

    Returns any

hostExpressionModel

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

    Returns Expression | null

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

    Parameters

    Returns any

isLoaded

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

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

    Returns boolean

passwordExpression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Returns string

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

    Parameters

    • newValue: string

    Returns any

passwordExpressionModel

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

    Returns Expression | null

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

    Parameters

    Returns any

portExpression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Returns string

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

    Parameters

    • newValue: string

    Returns any

portExpressionModel

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

    Returns Expression | null

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

    Parameters

    Returns any

unit

useConfigurationExpression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Returns string

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

    Parameters

    • newValue: string

    Returns any

useConfigurationExpressionModel

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

    Returns Expression | null

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

    Parameters

    Returns any

usernameExpression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Returns string

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

    Parameters

    • newValue: string

    Returns any

usernameExpressionModel

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

    Returns Expression | null

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

    Parameters

    Returns any

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