Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpConfiguration

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

authenticationPassword

  • 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

containerAsConsumedODataService

containerAsRestCallAction

containerAsWebServiceCallAction

customLocation

  • 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

customLocationModel

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

    In version 7.9.0: introduced

    Returns Expression

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

    In version 7.9.0: introduced

    Parameters

    Returns any

customLocationTemplate

  • In version 6.6.0: introduced

    Returns StringTemplate | null

  • In version 6.6.0: introduced

    Parameters

    Returns any

headerEntries

httpAuthenticationUserName

  • 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

httpMethod

  • In version 7.7.0: deleted In version 6.6.0: introduced

    Returns HttpMethod

  • In version 7.7.0: deleted In version 6.6.0: introduced

    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

newHttpMethod

  • In version 7.7.0: introduced

    Returns HttpMethod

  • In version 7.7.0: introduced

    Parameters

    Returns any

overrideLocation

  • get (): boolean
  • set (newValue: boolean): any
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

password

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

    In version 7.9.0: introduced

    Returns Expression

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

    In version 7.9.0: introduced

    Parameters

    Returns any

unit

useAuthentication

  • get (): boolean
  • set (newValue: boolean): any
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

username

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

    In version 7.9.0: introduced

    Returns Expression

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

    In version 7.9.0: introduced

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