module:model/WebFormInstance

module:model/WebFormInstance

new module:model/WebFormInstance(id)

Source:

Constructs a new WebFormInstance.
An object that contains the Web Form Instance required to render it and its metadata such as created by, created time

Parameters:
Name Type Description
id String

Members

(inner) accountId :String

Source:
Type:
  • String

(inner) clientUserId :String

Source:
Type:
  • String

(inner) envelopes :Array:.<module:model/WebFormInstanceEnvelopes:>

Source:

The associated envelope that is created when the instance is submitted

Type:

(inner) formId :String

Source:

Web form from which the instance is created

Type:
  • String

(inner) formUrl :String

Source:
Type:
  • String

(inner) formValues :module:model/WebFormValues

Source:
Type:

(inner) id :String

Source:
Type:
  • String

(inner) instanceMetadata :module:model/WebFormInstanceMetadata

Source:
Type:

(inner) instanceToken :String

Source:
Type:
  • String

(inner) status :module:model/InstanceStatus

Source:
Type:
  • module:model/InstanceStatus

(inner) tags :Array:.<String:>

Source:

List of tags provided by the user with each request. This field is optional.

Type:
  • Array:.<String:>

(inner) tokenExpirationDateTime :String

Source:
Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/WebFormInstance}

Source:

Constructs a WebFormInstance 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.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:model/WebFormInstance

Optional instance to populate.

Returns:

The populated WebFormInstance instance.

Type
module:model/WebFormInstance