Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RestCallAction

In version 6.6.0: introduced

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

containerAsActionActivity

containerAsActionActivity: ActionActivity

errorHandlingType

errorHandlingType: ErrorHandlingType

errorResultHandlingType

errorResultHandlingType: ErrorResultHandlingType

In version 7.0.2: introduced

httpConfiguration

httpConfiguration: HttpConfiguration

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

proxyConfiguration

proxyConfiguration: ProxyConfiguration | null

In version 7.15.0: introduced

requestHandling

requestHandling: RequestHandling

requestHandlingType

requestHandlingType: RequestHandlingType

In version 6.9.0: introduced

requestProxyType

requestProxyType: RequestProxyType

In version 7.15.0: introduced

resultHandling

resultHandling: ResultHandling

resultHandlingType

resultHandlingType: ResultHandlingType

In version 6.9.0: introduced

structureTypeName

structureTypeName: string

timeOut

timeOut: number

In version 7.15.0: deleted In version 7.1.0: introduced

timeOutExpression

timeOutExpression: string

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

In version 7.15.0: introduced

timeOutModel

timeOutModel: Expression

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

In version 7.15.0: introduced

unit

unit: ModelUnit

useRequestTimeOut

useRequestTimeOut: boolean

In version 7.1.0: introduced

Static structureTypeName

structureTypeName: string

Static versionInfo

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

Static createIn

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

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

    Parameters

    Returns RestCallAction

Generated using TypeDoc