GetDocumentOptions
in package
GetDocumentOptions Class Doc Comment
Tags
Table of Contents
- $certificate : string|null
- $certificate When set to **false**, the envelope signing certificate is removed from the download.
- $documents_by_userid : string|null
- $documents_by_userid
- $encoding : string|null
- $encoding
- $encrypt : string|null
- $encrypt When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.
- $language : string|null
- $language Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).
- $recipient_id : string|null
- $recipient_id
- $shared_user_id : string|null
- $shared_user_id
- $show_changes : string|null
- $show_changes When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
- $watermark : string|null
- $watermark When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.
- getCertificate() : string|null
- Gets certificate
- getDocumentsByUserid() : string|null
- Gets documents_by_userid
- getEncoding() : string|null
- Gets encoding
- getEncrypt() : string|null
- Gets encrypt
- getLanguage() : string|null
- Gets language
- getRecipientId() : string|null
- Gets recipient_id
- getSharedUserId() : string|null
- Gets shared_user_id
- getShowChanges() : string|null
- Gets show_changes
- getWatermark() : string|null
- Gets watermark
- setCertificate() : self
- Sets certificate
- setDocumentsByUserid() : self
- Sets documents_by_userid
- setEncoding() : self
- Sets encoding
- setEncrypt() : self
- Sets encrypt
- setLanguage() : self
- Sets language
- setRecipientId() : self
- Sets recipient_id
- setSharedUserId() : self
- Sets shared_user_id
- setShowChanges() : self
- Sets show_changes
- setWatermark() : self
- Sets watermark
Properties
$certificate
$certificate When set to **false**, the envelope signing certificate is removed from the download.
protected
string|null
$certificate
= null
$documents_by_userid
$documents_by_userid
protected
string|null
$documents_by_userid
= null
$encoding
$encoding
protected
string|null
$encoding
= null
$encrypt
$encrypt When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.
protected
string|null
$encrypt
= null
$language
$language Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).
protected
string|null
$language
= null
$recipient_id
$recipient_id
protected
string|null
$recipient_id
= null
$shared_user_id
$shared_user_id
protected
string|null
$shared_user_id
= null
$show_changes
$show_changes When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
protected
string|null
$show_changes
= null
$watermark
$watermark When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.
protected
string|null
$watermark
= null
Methods
getCertificate()
Gets certificate
public
getCertificate() : string|null
Return values
string|null —getDocumentsByUserid()
Gets documents_by_userid
public
getDocumentsByUserid() : string|null
Return values
string|null —getEncoding()
Gets encoding
public
getEncoding() : string|null
Return values
string|null —getEncrypt()
Gets encrypt
public
getEncrypt() : string|null
Return values
string|null —getLanguage()
Gets language
public
getLanguage() : string|null
Return values
string|null —getRecipientId()
Gets recipient_id
public
getRecipientId() : string|null
Return values
string|null —getSharedUserId()
Gets shared_user_id
public
getSharedUserId() : string|null
Return values
string|null —getShowChanges()
Gets show_changes
public
getShowChanges() : string|null
Return values
string|null —getWatermark()
Gets watermark
public
getWatermark() : string|null
Return values
string|null —setCertificate()
Sets certificate
public
setCertificate(string|null $certificate) : self
Parameters
- $certificate : string|null
-
When set to false, the envelope signing certificate is removed from the download.
Return values
self —setDocumentsByUserid()
Sets documents_by_userid
public
setDocumentsByUserid(string|null $documents_by_userid) : self
Parameters
- $documents_by_userid : string|null
Return values
self —setEncoding()
Sets encoding
public
setEncoding(string|null $encoding) : self
Parameters
- $encoding : string|null
Return values
self —setEncrypt()
Sets encrypt
public
setEncrypt(string|null $encrypt) : self
Parameters
- $encrypt : string|null
-
When set to true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.
Return values
self —setLanguage()
Sets language
public
setLanguage(string|null $language) : self
Parameters
- $language : string|null
-
Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).
Return values
self —setRecipientId()
Sets recipient_id
public
setRecipientId(string|null $recipient_id) : self
Parameters
- $recipient_id : string|null
Return values
self —setSharedUserId()
Sets shared_user_id
public
setSharedUserId(string|null $shared_user_id) : self
Parameters
- $shared_user_id : string|null
Return values
self —setShowChanges()
Sets show_changes
public
setShowChanges(string|null $show_changes) : self
Parameters
- $show_changes : string|null
-
When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
Return values
self —setWatermark()
Sets watermark
public
setWatermark(string|null $watermark) : self
Parameters
- $watermark : string|null
-
When set to true, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.