Class ItemScriptCall

constructor

• new ItemScriptCall(data, parent): ItemScriptCall

• Parameters

  • data: any

  • parent: any

  Returns ItemScriptCall

data

parent

Static AsyncFunction

category

• get category(): any

• Returns any

hidden

• get hidden(): any

• Returns any

id

• get id(): any

• Returns any

name

• get name(): any

• Returns any

type

• get type(): any

• Returns any

value

• get value(): any

• Returns any

Static defaultData

• get defaultData(): {
      _id: string;
      category: string;
      hidden: boolean;
      img: string;
      name: string;
      type: string;
      value: string;
  }

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

  • _id: string

  • category: string

  • hidden: boolean

  • img: string

  • name: string

  • type: string

  • value: string

edit

• edit(): Promise<any>

• Returns Promise<any>

execute

• execute(shared, extraParams?): Promise<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 Promise<any>

getScriptBody

• getScriptBody(): Promise<any>

• Returns Promise<any>

update

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

• Parameters

  • data: any

  • options: {} = {}

  Returns Promise<any>

Static create

• create(data, context): Promise<any[]>

• Creates a script call.

  Parameters

  • data: object[]

    Data to initialize the script call(s) with.

  • context: {
        parent: undefined | ItemPF;
    }

    An object containing context information.

    • parent: undefined | ItemPF

      The parent entity to create the script call within.

  Returns Promise<any[]>

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