Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AppServiceAction

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

actionReturnType

  • In version 7.9.0: introduced

    Returns DataType

  • In version 7.9.0: introduced

    Parameters

    Returns any

caption

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

  • Parameters

    • newValue: string

    Returns any

containerAsConsumedAppService

description

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

  • Parameters

    • newValue: string

    Returns any

image

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

  • Parameters

    • newValue: string

    Returns any

isLoaded

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

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

    Returns boolean

microflow

microflowQualifiedName

  • get (): string | null
  • Returns string | null

name

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

  • Parameters

    • newValue: string

    Returns any

parameters

qualifiedName

  • get (): string | null
  • Returns string | null

returnType

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

    In version 7.9.0: deleted

    Returns string

  • The value of this property is conceptually of type dataTypes.LegacyDataType.

    In version 7.9.0: deleted

    Parameters

    • newValue: string

    Returns any

returnTypeCanBeEmpty

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

  • Parameters

    • newValue: boolean

    Returns any

unit

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

Static createIn

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

    Parameters

    Returns AppServiceAction

Generated using TypeDoc