DocumentHtmlDefinition
in package
implements
ModelInterface, ArrayAccess
DocumentHtmlDefinition 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
- getDisplayAnchorPrefix() : string|null
- Gets display_anchor_prefix
- getDisplayAnchors() : array<string|int, DocumentHtmlDisplayAnchor>
- Gets display_anchors
- getDisplayOrder() : string|null
- Gets display_order
- getDisplayPageNumber() : string|null
- Gets display_page_number
- getDocumentGuid() : string|null
- Gets document_guid
- getDocumentId() : string|null
- Gets document_id
- getHeaderLabel() : string|null
- Gets header_label
- getMaxScreenWidth() : string|null
- Gets max_screen_width
- getModelName() : string
- The original name of the model.
- getRemoveEmptyTags() : string|null
- Gets remove_empty_tags
- getShowMobileOptimizedToggle() : string|null
- Gets show_mobile_optimized_toggle
- getSource() : string|null
- Gets source
- 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.
- setDisplayAnchorPrefix() : $this
- Sets display_anchor_prefix
- setDisplayAnchors() : $this
- Sets display_anchors
- setDisplayOrder() : $this
- Sets display_order
- setDisplayPageNumber() : $this
- Sets display_page_number
- setDocumentGuid() : $this
- Sets document_guid
- setDocumentId() : $this
- Sets document_id
- setHeaderLabel() : $this
- Sets header_label
- setMaxScreenWidth() : $this
- Sets max_screen_width
- setRemoveEmptyTags() : $this
- Sets remove_empty_tags
- setShowMobileOptimizedToggle() : $this
- Sets show_mobile_optimized_toggle
- setSource() : $this
- Sets source
- 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
= ['display_anchor_prefix' => 'displayAnchorPrefix', 'display_anchors' => 'displayAnchors', 'display_order' => 'displayOrder', 'display_page_number' => 'displayPageNumber', 'document_guid' => 'documentGuid', 'document_id' => 'documentId', 'header_label' => 'headerLabel', 'max_screen_width' => 'maxScreenWidth', 'remove_empty_tags' => 'removeEmptyTags', 'show_mobile_optimized_toggle' => 'showMobileOptimizedToggle', 'source' => 'source']
$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
= ['display_anchor_prefix' => 'getDisplayAnchorPrefix', 'display_anchors' => 'getDisplayAnchors', 'display_order' => 'getDisplayOrder', 'display_page_number' => 'getDisplayPageNumber', 'document_guid' => 'getDocumentGuid', 'document_id' => 'getDocumentId', 'header_label' => 'getHeaderLabel', 'max_screen_width' => 'getMaxScreenWidth', 'remove_empty_tags' => 'getRemoveEmptyTags', 'show_mobile_optimized_toggle' => 'getShowMobileOptimizedToggle', 'source' => 'getSource']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['display_anchor_prefix' => 'setDisplayAnchorPrefix', 'display_anchors' => 'setDisplayAnchors', 'display_order' => 'setDisplayOrder', 'display_page_number' => 'setDisplayPageNumber', 'document_guid' => 'setDocumentGuid', 'document_id' => 'setDocumentId', 'header_label' => 'setHeaderLabel', 'max_screen_width' => 'setMaxScreenWidth', 'remove_empty_tags' => 'setRemoveEmptyTags', 'show_mobile_optimized_toggle' => 'setShowMobileOptimizedToggle', 'source' => 'setSource']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['display_anchor_prefix' => null, 'display_anchors' => null, 'display_order' => null, 'display_page_number' => null, 'document_guid' => null, 'document_id' => null, 'header_label' => null, 'max_screen_width' => null, 'remove_empty_tags' => null, 'show_mobile_optimized_toggle' => null, 'source' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'documentHtmlDefinition'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['display_anchor_prefix' => '?string', 'display_anchors' => '\\DocuSign\\eSign\\Model\\DocumentHtmlDisplayAnchor[]', 'display_order' => '?string', 'display_page_number' => '?string', 'document_guid' => '?string', 'document_id' => '?string', 'header_label' => '?string', 'max_screen_width' => '?string', 'remove_empty_tags' => '?string', 'show_mobile_optimized_toggle' => '?string', 'source' => '?string']
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> —getDisplayAnchorPrefix()
Gets display_anchor_prefix
public
getDisplayAnchorPrefix() : string|null
Return values
string|null —getDisplayAnchors()
Gets display_anchors
public
getDisplayAnchors() : array<string|int, DocumentHtmlDisplayAnchor>
Return values
array<string|int, DocumentHtmlDisplayAnchor> —getDisplayOrder()
Gets display_order
public
getDisplayOrder() : string|null
Return values
string|null —getDisplayPageNumber()
Gets display_page_number
public
getDisplayPageNumber() : string|null
Return values
string|null —getDocumentGuid()
Gets document_guid
public
getDocumentGuid() : string|null
Return values
string|null —getDocumentId()
Gets document_id
public
getDocumentId() : string|null
Return values
string|null —getHeaderLabel()
Gets header_label
public
getHeaderLabel() : string|null
Return values
string|null —getMaxScreenWidth()
Gets max_screen_width
public
getMaxScreenWidth() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRemoveEmptyTags()
Gets remove_empty_tags
public
getRemoveEmptyTags() : string|null
Return values
string|null —getShowMobileOptimizedToggle()
Gets show_mobile_optimized_toggle
public
getShowMobileOptimizedToggle() : string|null
Return values
string|null —getSource()
Gets source
public
getSource() : string|null
Return values
string|null —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 —setDisplayAnchorPrefix()
Sets display_anchor_prefix
public
setDisplayAnchorPrefix(string|null $display_anchor_prefix) : $this
Parameters
- $display_anchor_prefix : string|null
Return values
$this —setDisplayAnchors()
Sets display_anchors
public
setDisplayAnchors(array<string|int, DocumentHtmlDisplayAnchor> $display_anchors) : $this
Parameters
- $display_anchors : array<string|int, DocumentHtmlDisplayAnchor>
Return values
$this —setDisplayOrder()
Sets display_order
public
setDisplayOrder(string|null $display_order) : $this
Parameters
- $display_order : string|null
Return values
$this —setDisplayPageNumber()
Sets display_page_number
public
setDisplayPageNumber(string|null $display_page_number) : $this
Parameters
- $display_page_number : string|null
Return values
$this —setDocumentGuid()
Sets document_guid
public
setDocumentGuid(string|null $document_guid) : $this
Parameters
- $document_guid : string|null
Return values
$this —setDocumentId()
Sets document_id
public
setDocumentId(string|null $document_id) : $this
Parameters
- $document_id : string|null
-
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
Return values
$this —setHeaderLabel()
Sets header_label
public
setHeaderLabel(string|null $header_label) : $this
Parameters
- $header_label : string|null
Return values
$this —setMaxScreenWidth()
Sets max_screen_width
public
setMaxScreenWidth(string|null $max_screen_width) : $this
Parameters
- $max_screen_width : string|null
Return values
$this —setRemoveEmptyTags()
Sets remove_empty_tags
public
setRemoveEmptyTags(string|null $remove_empty_tags) : $this
Parameters
- $remove_empty_tags : string|null
Return values
$this —setShowMobileOptimizedToggle()
Sets show_mobile_optimized_toggle
public
setShowMobileOptimizedToggle(string|null $show_mobile_optimized_toggle) : $this
Parameters
- $show_mobile_optimized_toggle : string|null
Return values
$this —setSource()
Sets source
public
setSource(string|null $source) : $this
Parameters
- $source : string|null
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