Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpConfiguration

Hierarchy

Implements

Index

Constructors

constructor

Properties

authenticationPassword

authenticationPassword: string

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

container

container: AbstractElement

containerAsConsumedODataService

containerAsConsumedODataService: ConsumedODataService

containerAsRestCallAction

containerAsRestCallAction: RestCallAction

containerAsWebServiceCallAction

containerAsWebServiceCallAction: WebServiceCallAction

customLocation

customLocation: string

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

customLocationModel

customLocationModel: Expression

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

In version 7.9.0: introduced

customLocationTemplate

customLocationTemplate: StringTemplate | null

In version 6.6.0: introduced

headerEntries

headerEntries: IList<HttpHeaderEntry>

httpAuthenticationUserName

httpAuthenticationUserName: string

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

httpMethod

httpMethod: HttpMethod

In version 7.7.0: deleted In version 6.6.0: introduced

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

newHttpMethod

newHttpMethod: HttpMethod

In version 7.7.0: introduced

overrideLocation

overrideLocation: boolean

password

password: Expression

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

In version 7.9.0: introduced

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

useAuthentication

useAuthentication: boolean

username

username: Expression

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

In version 7.9.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 HttpConfiguration 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 HttpConfiguration

Static createIn

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

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

    Parameters

    Returns HttpConfiguration

Static createInConsumedODataServiceUnderHttpConfiguration

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

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

    Parameters

    Returns HttpConfiguration

Static createInRestCallActionUnderHttpConfiguration

  • Creates and returns a new HttpConfiguration instance in the SDK and on the server. The new HttpConfiguration will be automatically stored in the 'httpConfiguration' property of the parent RestCallAction 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 HttpConfiguration

Static createInWebServiceCallActionUnderHttpConfiguration

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

    Parameters

    Returns HttpConfiguration

Generated using TypeDoc