Class ItemScriptCall

constructor

• new ItemScriptCall(data: any, options: any): ItemScriptCall

• Parameters

  • data: any
  • options: any

  Returns ItemScriptCall

Optional_id

category

Optionalhidden

Optionalimg

Optionalname

type

value

data

• get data(): this

• Returns this

  Deprecated

hide

• get hide(): boolean

• Returns boolean

id

• get id(): string

• Returns string

StaticdefaultData

• get defaultData(): any

• Returns any

  Deprecated

edit

• edit(__namedParameters?: { editable?: boolean }): Promise<any>

• Parameters

  • __namedParameters: { editable?: boolean } = {}

  Returns Promise<any>

execute

• execute(shared: object, extraParams?: object): any

• Executes the script.

  Parameters

  • shared: object

    An object passed between script calls, and which is passed back as a result of ItemPF.executeScriptCalls.
  • extraParams: object = {}

    A dictionary containing extra parameters to pass on to the call.

  Returns any

  • Script return value if any

getDelegate

• getDelegate(): Macro

• Get macro delegate for executing this script call with.

  Returns Macro

  • Actual macro or its delegate

prepareData

• prepareData(): void

• Returns void

update

• update(data: any, options?: {}): Promise<any>

• Parameters

  • data: any
  • options: {} = {}

  Returns Promise<any>

Staticcreate

• create(data: object[], context: { parent?: ItemPF }): ItemScriptCall[]

• Creates a script call.

  Parameters

  • data: object[]

    Data to initialize the script call(s) with.
  • context: { parent?: ItemPF }

    An object containing context information.

    • Optionalparent?: ItemPF

      The parent entity to create the script call within.

  Returns ItemScriptCall[]

  • The resulting script calls, or an empty array if nothing was created.

StaticdefineSchema

• defineSchema(): {
      _id: any;
      category: any;
      hidden: any;
      img: any;
      name: any;
      type: any;
      value: any;
  }

• Returns {
      _id: any;
      category: any;
      hidden: any;
      img: any;
      name: any;
      type: any;
      value: any;
  }

StaticmigrateData

• migrateData(source: any): any

• Parameters

  • source: any

  Returns any