UpdateOptions
in package
UpdateOptions Class Doc Comment
Tags
Table of Contents
- $advanced_update : string|null
- $advanced_update When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
- $recycle_on_void : string|null
- $recycle_on_void
- $resend_envelope : string|null
- $resend_envelope When set to **true**, sends the specified envelope again.
- getAdvancedUpdate() : string|null
- Gets advanced_update
- getRecycleOnVoid() : string|null
- Gets recycle_on_void
- getResendEnvelope() : string|null
- Gets resend_envelope
- setAdvancedUpdate() : self
- Sets advanced_update
- setRecycleOnVoid() : self
- Sets recycle_on_void
- setResendEnvelope() : self
- Sets resend_envelope
Properties
$advanced_update
$advanced_update When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
protected
string|null
$advanced_update
= null
$recycle_on_void
$recycle_on_void
protected
string|null
$recycle_on_void
= null
$resend_envelope
$resend_envelope When set to **true**, sends the specified envelope again.
protected
string|null
$resend_envelope
= null
Methods
getAdvancedUpdate()
Gets advanced_update
public
getAdvancedUpdate() : string|null
Return values
string|null —getRecycleOnVoid()
Gets recycle_on_void
public
getRecycleOnVoid() : string|null
Return values
string|null —getResendEnvelope()
Gets resend_envelope
public
getResendEnvelope() : string|null
Return values
string|null —setAdvancedUpdate()
Sets advanced_update
public
setAdvancedUpdate(string|null $advanced_update) : self
Parameters
- $advanced_update : string|null
-
When set to true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
Return values
self —setRecycleOnVoid()
Sets recycle_on_void
public
setRecycleOnVoid(string|null $recycle_on_void) : self
Parameters
- $recycle_on_void : string|null
Return values
self —setResendEnvelope()
Sets resend_envelope
public
setResendEnvelope(string|null $resend_envelope) : self
Parameters
- $resend_envelope : string|null
-
When set to true, sends the specified envelope again.