Class: module:model/JobPayloadInput

module:model/JobPayloadInput(urn, theData, obj)

new module:model/JobPayloadInput(urn, theData, obj)

Constructs a new JobPayloadInput. Group of inputs

Parameters:
Name Type Description
urn String

The design URN; returned when uploading the file to Forge The URN needs to be Base64 (URL Safe) encoded.

theData Object

The plain JavaScript object bearing properties of interest.

obj module:model/JobPayloadInput

Optional instance to populate.

Source:

Members

(static) constructFromObject

Constructs a JobPayloadInput from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Source:

(inner) compressedUrn :Boolean

Set this to true if the source file is compressed. If set to true, you need to define the rootFilename.

Type:
  • Boolean
Default Value:
  • false
Source:

(inner) rootFilename :String

The root filename of the compressed file. Mandatory if the compressedUrn is set to true.

Type:
  • String
Source:

(inner) urn :String

The design URN; returned when uploading the file to Forge The URN needs to be Base64 (URL Safe) encoded.

Type:
  • String
Source: