EnvelopeViewSettings
in package
implements
ModelInterface, ArrayAccess
EnvelopeViewSettings Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getBackButtonAction() : string|null
- Gets back_button_action
- getDocumentSettings() : EnvelopeViewDocumentSettings
- Gets document_settings
- getEnvelopeCustomFieldSettings() : EnvelopeViewEnvelopeCustomFieldSettings
- Gets envelope_custom_field_settings
- getLockToken() : string|null
- Gets lock_token
- getModelName() : string
- The original name of the model.
- getRecipientSettings() : EnvelopeViewRecipientSettings
- Gets recipient_settings
- getSendButtonAction() : string|null
- Gets send_button_action
- getShowAdvancedOptions() : string|null
- Gets show_advanced_options
- getShowBackButton() : string|null
- Gets show_back_button
- getShowDiscardAction() : string|null
- Gets show_discard_action
- getShowHeaderActions() : string|null
- Gets show_header_actions
- getStartingScreen() : string|null
- Gets starting_screen
- getTaggerSettings() : EnvelopeViewTaggerSettings
- Gets tagger_settings
- getTemplateSettings() : EnvelopeViewTemplateSettings
- Gets template_settings
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setBackButtonAction() : $this
- Sets back_button_action
- setDocumentSettings() : $this
- Sets document_settings
- setEnvelopeCustomFieldSettings() : $this
- Sets envelope_custom_field_settings
- setLockToken() : $this
- Sets lock_token
- setRecipientSettings() : $this
- Sets recipient_settings
- setSendButtonAction() : $this
- Sets send_button_action
- setShowAdvancedOptions() : $this
- Sets show_advanced_options
- setShowBackButton() : $this
- Sets show_back_button
- setShowDiscardAction() : $this
- Sets show_discard_action
- setShowHeaderActions() : $this
- Sets show_header_actions
- setStartingScreen() : $this
- Sets starting_screen
- setTaggerSettings() : $this
- Sets tagger_settings
- setTemplateSettings() : $this
- Sets template_settings
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['back_button_action' => 'backButtonAction', 'document_settings' => 'documentSettings', 'envelope_custom_field_settings' => 'envelopeCustomFieldSettings', 'lock_token' => 'lockToken', 'recipient_settings' => 'recipientSettings', 'send_button_action' => 'sendButtonAction', 'show_advanced_options' => 'showAdvancedOptions', 'show_back_button' => 'showBackButton', 'show_discard_action' => 'showDiscardAction', 'show_header_actions' => 'showHeaderActions', 'starting_screen' => 'startingScreen', 'tagger_settings' => 'taggerSettings', 'template_settings' => 'templateSettings']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['back_button_action' => 'getBackButtonAction', 'document_settings' => 'getDocumentSettings', 'envelope_custom_field_settings' => 'getEnvelopeCustomFieldSettings', 'lock_token' => 'getLockToken', 'recipient_settings' => 'getRecipientSettings', 'send_button_action' => 'getSendButtonAction', 'show_advanced_options' => 'getShowAdvancedOptions', 'show_back_button' => 'getShowBackButton', 'show_discard_action' => 'getShowDiscardAction', 'show_header_actions' => 'getShowHeaderActions', 'starting_screen' => 'getStartingScreen', 'tagger_settings' => 'getTaggerSettings', 'template_settings' => 'getTemplateSettings']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['back_button_action' => 'setBackButtonAction', 'document_settings' => 'setDocumentSettings', 'envelope_custom_field_settings' => 'setEnvelopeCustomFieldSettings', 'lock_token' => 'setLockToken', 'recipient_settings' => 'setRecipientSettings', 'send_button_action' => 'setSendButtonAction', 'show_advanced_options' => 'setShowAdvancedOptions', 'show_back_button' => 'setShowBackButton', 'show_discard_action' => 'setShowDiscardAction', 'show_header_actions' => 'setShowHeaderActions', 'starting_screen' => 'setStartingScreen', 'tagger_settings' => 'setTaggerSettings', 'template_settings' => 'setTemplateSettings']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['back_button_action' => null, 'document_settings' => null, 'envelope_custom_field_settings' => null, 'lock_token' => null, 'recipient_settings' => null, 'send_button_action' => null, 'show_advanced_options' => null, 'show_back_button' => null, 'show_discard_action' => null, 'show_header_actions' => null, 'starting_screen' => null, 'tagger_settings' => null, 'template_settings' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'envelopeViewSettings'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['back_button_action' => '?string', 'document_settings' => '\\DocuSign\\eSign\\Model\\EnvelopeViewDocumentSettings', 'envelope_custom_field_settings' => '\\DocuSign\\eSign\\Model\\EnvelopeViewEnvelopeCustomFieldSettings', 'lock_token' => '?string', 'recipient_settings' => '\\DocuSign\\eSign\\Model\\EnvelopeViewRecipientSettings', 'send_button_action' => '?string', 'show_advanced_options' => '?string', 'show_back_button' => '?string', 'show_discard_action' => '?string', 'show_header_actions' => '?string', 'starting_screen' => '?string', 'tagger_settings' => '\\DocuSign\\eSign\\Model\\EnvelopeViewTaggerSettings', 'template_settings' => '\\DocuSign\\eSign\\Model\\EnvelopeViewTemplateSettings']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getBackButtonAction()
Gets back_button_action
public
getBackButtonAction() : string|null
Return values
string|null —getDocumentSettings()
Gets document_settings
public
getDocumentSettings() : EnvelopeViewDocumentSettings
Return values
EnvelopeViewDocumentSettings —getEnvelopeCustomFieldSettings()
Gets envelope_custom_field_settings
public
getEnvelopeCustomFieldSettings() : EnvelopeViewEnvelopeCustomFieldSettings
Return values
EnvelopeViewEnvelopeCustomFieldSettings —getLockToken()
Gets lock_token
public
getLockToken() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRecipientSettings()
Gets recipient_settings
public
getRecipientSettings() : EnvelopeViewRecipientSettings
Return values
EnvelopeViewRecipientSettings —getSendButtonAction()
Gets send_button_action
public
getSendButtonAction() : string|null
Return values
string|null —getShowAdvancedOptions()
Gets show_advanced_options
public
getShowAdvancedOptions() : string|null
Return values
string|null —getShowBackButton()
Gets show_back_button
public
getShowBackButton() : string|null
Return values
string|null —getShowDiscardAction()
Gets show_discard_action
public
getShowDiscardAction() : string|null
Return values
string|null —getShowHeaderActions()
Gets show_header_actions
public
getShowHeaderActions() : string|null
Return values
string|null —getStartingScreen()
Gets starting_screen
public
getStartingScreen() : string|null
Return values
string|null —getTaggerSettings()
Gets tagger_settings
public
getTaggerSettings() : EnvelopeViewTaggerSettings
Return values
EnvelopeViewTaggerSettings —getTemplateSettings()
Gets template_settings
public
getTemplateSettings() : EnvelopeViewTemplateSettings
Return values
EnvelopeViewTemplateSettings —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setBackButtonAction()
Sets back_button_action
public
setBackButtonAction(string|null $back_button_action) : $this
Parameters
- $back_button_action : string|null
Return values
$this —setDocumentSettings()
Sets document_settings
public
setDocumentSettings(EnvelopeViewDocumentSettings $document_settings) : $this
Parameters
- $document_settings : EnvelopeViewDocumentSettings
Return values
$this —setEnvelopeCustomFieldSettings()
Sets envelope_custom_field_settings
public
setEnvelopeCustomFieldSettings(EnvelopeViewEnvelopeCustomFieldSettings $envelope_custom_field_settings) : $this
Parameters
- $envelope_custom_field_settings : EnvelopeViewEnvelopeCustomFieldSettings
Return values
$this —setLockToken()
Sets lock_token
public
setLockToken(string|null $lock_token) : $this
Parameters
- $lock_token : string|null
Return values
$this —setRecipientSettings()
Sets recipient_settings
public
setRecipientSettings(EnvelopeViewRecipientSettings $recipient_settings) : $this
Parameters
- $recipient_settings : EnvelopeViewRecipientSettings
Return values
$this —setSendButtonAction()
Sets send_button_action
public
setSendButtonAction(string|null $send_button_action) : $this
Parameters
- $send_button_action : string|null
Return values
$this —setShowAdvancedOptions()
Sets show_advanced_options
public
setShowAdvancedOptions(string|null $show_advanced_options) : $this
Parameters
- $show_advanced_options : string|null
Return values
$this —setShowBackButton()
Sets show_back_button
public
setShowBackButton(string|null $show_back_button) : $this
Parameters
- $show_back_button : string|null
Return values
$this —setShowDiscardAction()
Sets show_discard_action
public
setShowDiscardAction(string|null $show_discard_action) : $this
Parameters
- $show_discard_action : string|null
Return values
$this —setShowHeaderActions()
Sets show_header_actions
public
setShowHeaderActions(string|null $show_header_actions) : $this
Parameters
- $show_header_actions : string|null
Return values
$this —setStartingScreen()
Sets starting_screen
public
setStartingScreen(string|null $starting_screen) : $this
Parameters
- $starting_screen : string|null
Return values
$this —setTaggerSettings()
Sets tagger_settings
public
setTaggerSettings(EnvelopeViewTaggerSettings $tagger_settings) : $this
Parameters
- $tagger_settings : EnvelopeViewTaggerSettings
Return values
$this —setTemplateSettings()
Sets template_settings
public
setTemplateSettings(EnvelopeViewTemplateSettings $template_settings) : $this
Parameters
- $template_settings : EnvelopeViewTemplateSettings
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid