PocketModuleExt

PocketModuleExt

new PocketModuleExt()

Source:

Methods

$payload(data, async, type)

  • you can also use it on concurrent payloads to existing projectID, once initial project is created every other call will update each Probe{}.data/status, based on payloadData
Source:
Parameters:
Name Type Description
data ProjectPayloadModel | Promise.<ProjectPayloadModel>

required

async *

override current opts.sync for this payload

type "new" | "update"

optional, new/update, update: if we call on an existing project we can update data/status properties of all assigned tasks at once

  • initialize new payload, for as many tasks
  • sets a multi task with instructions:
  • data = { id: '', // 1 id for all tasks tasks: [{ taskName: '', data: '', campaign: '' }] }
  • call distributor and setDefer

$ready(payloadID, allowsMultiplenullable, strictnullable) → {PocketModule|Object}

memberof PocketModule

  • resolves currently active $payload(...)
  • after completion of Pocket, instance data for all Probes is deleted
  • can be called even before project was declared thanks to callback dispatcher $projectSetAsync()
Source:
Parameters:
Name Type Attributes Default Description
payloadID *

,required

allowsMultiple boolean <nullable>
false

optional, when set to true will allow multiple calls to resolved data

strict boolean <nullable>
false

if true will check {payloadID} exists

Returns:
Type:
PocketModule | Object

$removeProject(projectID)

removes all Probes and references relating to projectID

Source:
Parameters:
Name Type Description
projectID *

deletePocketSet()

  • delete completed pocketSet
Source: