Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpConfiguration

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___authenticationPassword

___authenticationPassword: any

Private ___customLocation

___customLocation: any

Private ___customLocationTemplate

___customLocationTemplate: any

Private ___headerEntries

___headerEntries: any

Private ___httpAuthenticationUserName

___httpAuthenticationUserName: any

Private ___httpMethod

___httpMethod: any

Private ___overrideLocation

___overrideLocation: any

Private ___useAuthentication

___useAuthentication: any

authenticationPassword

authenticationPassword: string

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

container

container: AbstractElement

containerAsRestCallAction

containerAsRestCallAction: RestCallAction

containerAsWebServiceCallAction

containerAsWebServiceCallAction: WebServiceCallAction

customLocation

customLocation: string

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

customLocationTemplate

customLocationTemplate: StringTemplate

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

overrideLocation

overrideLocation: boolean

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

typeName

typeName: string

unit

unit: ModelUnit

useAuthentication

useAuthentication: boolean

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

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

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

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, 6.0.1, 6.1.0, 6.2.0, 6.3.0, 6.4.0, 6.4.1, 6.5.0]

    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, 6.7.0, 6.8.0, 6.9.0, 6.10.0]

    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