CreateEnvelopeOptions
in package
CreateEnvelopeOptions Class Doc Comment
Tags
Table of Contents
- $cdse_mode : string|null
- $cdse_mode
- $change_routing_order : string|null
- $change_routing_order
- $completed_documents_only : string|null
- $completed_documents_only If set to true then we want to set the sourceEnvelopeId to indicate that this is a\"forward\" envelope action
- $merge_roles_on_draft : string|null
- $merge_roles_on_draft When set to **true**, merges template roles and remove empty recipients when you create an envelope with multiple templates.
- $tab_label_exact_matches : string|null
- $tab_label_exact_matches
- getCdseMode() : string|null
- Gets cdse_mode
- getChangeRoutingOrder() : string|null
- Gets change_routing_order
- getCompletedDocumentsOnly() : string|null
- Gets completed_documents_only
- getMergeRolesOnDraft() : string|null
- Gets merge_roles_on_draft
- getTabLabelExactMatches() : string|null
- Gets tab_label_exact_matches
- setCdseMode() : self
- Sets cdse_mode
- setChangeRoutingOrder() : self
- Sets change_routing_order
- setCompletedDocumentsOnly() : self
- Sets completed_documents_only
- setMergeRolesOnDraft() : self
- Sets merge_roles_on_draft
- setTabLabelExactMatches() : self
- Sets tab_label_exact_matches
Properties
$cdse_mode
$cdse_mode
protected
string|null
$cdse_mode
= null
$change_routing_order
$change_routing_order
protected
string|null
$change_routing_order
= null
$completed_documents_only
$completed_documents_only If set to true then we want to set the sourceEnvelopeId to indicate that this is a\"forward\" envelope action
protected
string|null
$completed_documents_only
= null
$merge_roles_on_draft
$merge_roles_on_draft When set to **true**, merges template roles and remove empty recipients when you create an envelope with multiple templates.
protected
string|null
$merge_roles_on_draft
= null
$tab_label_exact_matches
$tab_label_exact_matches
protected
string|null
$tab_label_exact_matches
= null
Methods
getCdseMode()
Gets cdse_mode
public
getCdseMode() : string|null
Return values
string|null —getChangeRoutingOrder()
Gets change_routing_order
public
getChangeRoutingOrder() : string|null
Return values
string|null —getCompletedDocumentsOnly()
Gets completed_documents_only
public
getCompletedDocumentsOnly() : string|null
Return values
string|null —getMergeRolesOnDraft()
Gets merge_roles_on_draft
public
getMergeRolesOnDraft() : string|null
Return values
string|null —getTabLabelExactMatches()
Gets tab_label_exact_matches
public
getTabLabelExactMatches() : string|null
Return values
string|null —setCdseMode()
Sets cdse_mode
public
setCdseMode(string|null $cdse_mode) : self
Parameters
- $cdse_mode : string|null
Return values
self —setChangeRoutingOrder()
Sets change_routing_order
public
setChangeRoutingOrder(string|null $change_routing_order) : self
Parameters
- $change_routing_order : string|null
Return values
self —setCompletedDocumentsOnly()
Sets completed_documents_only
public
setCompletedDocumentsOnly(string|null $completed_documents_only) : self
Parameters
- $completed_documents_only : string|null
-
If set to true then we want to set the sourceEnvelopeId to indicate that this is a"forward" envelope action
Return values
self —setMergeRolesOnDraft()
Sets merge_roles_on_draft
public
setMergeRolesOnDraft(string|null $merge_roles_on_draft) : self
Parameters
- $merge_roles_on_draft : string|null
-
When set to true, merges template roles and remove empty recipients when you create an envelope with multiple templates.
Return values
self —setTabLabelExactMatches()
Sets tab_label_exact_matches
public
setTabLabelExactMatches(string|null $tab_label_exact_matches) : self
Parameters
- $tab_label_exact_matches : string|null