Documentation

TabMetadata
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess

TabMetadata Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess

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
getAnchor() : string|null: Gets anchor
getAnchorCaseSensitive() : string|null: Gets anchor_case_sensitive
getAnchorHorizontalAlignment() : string|null: Gets anchor_horizontal_alignment
getAnchorIgnoreIfNotPresent() : string|null: Gets anchor_ignore_if_not_present
getAnchorMatchWholeWord() : string|null: Gets anchor_match_whole_word
getAnchorUnits() : string|null: Gets anchor_units
getAnchorXOffset() : string|null: Gets anchor_x_offset
getAnchorYOffset() : string|null: Gets anchor_y_offset
getBold() : string|null: Gets bold
getCollaborative() : string|null: Gets collaborative
getConcealValueOnDocument() : string|null: Gets conceal_value_on_document
getCreatedByDisplayName() : string|null: Gets created_by_display_name
getCreatedByUserId() : string|null: Gets created_by_user_id
getCustomTabId() : string|null: Gets custom_tab_id
getDisableAutoSize() : string|null: Gets disable_auto_size
getEditable() : string|null: Gets editable
getFont() : string|null: Gets font
getFontColor() : string|null: Gets font_color
getFontSize() : string|null: Gets font_size
getHeight() : string|null: Gets height
getIncludedInEmail() : string|null: Gets included_in_email
getInitialValue() : string|null: Gets initial_value
getItalic() : string|null: Gets italic
getItems() : array<string|int, ?string>: Gets items
getLastModified() : string|null: Gets last_modified
getLastModifiedByDisplayName() : string|null: Gets last_modified_by_display_name
getLastModifiedByUserId() : string|null: Gets last_modified_by_user_id
getLocalePolicy() : LocalePolicyTab: Gets locale_policy
getLocked() : string|null: Gets locked
getMaximumLength() : string|null: Gets maximum_length
getMaxNumericalValue() : string|null: Gets max_numerical_value
getMergeField() : MergeField: Gets merge_field
getMinNumericalValue() : string|null: Gets min_numerical_value
getModelName() : string: The original name of the model.
getName() : string|null: Gets name
getNumericalValue() : string|null: Gets numerical_value
getPaymentItemCode() : string|null: Gets payment_item_code
getPaymentItemDescription() : string|null: Gets payment_item_description
getPaymentItemName() : string|null: Gets payment_item_name
getRequireAll() : string|null: Gets require_all
getRequired() : string|null: Gets required
getRequireInitialOnSharedChange() : string|null: Gets require_initial_on_shared_change
getScaleValue() : string|null: Gets scale_value
getSelected() : string|null: Gets selected
getShared() : string|null: Gets shared
getSignatureProviderId() : string|null: Gets signature_provider_id
getStampType() : string|null: Gets stamp_type
getStampTypeMetadata() : PropertyMetadata: Gets stamp_type_metadata
getTabLabel() : string|null: Gets tab_label
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getType() : string|null: Gets type
getUnderline() : string|null: Gets underline
getValidationMessage() : string|null: Gets validation_message
getValidationPattern() : string|null: Gets validation_pattern
getValidationType() : string|null: Gets validation_type
getWidth() : string|null: Gets width
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.
setAnchor() : $this: Sets anchor
setAnchorCaseSensitive() : $this: Sets anchor_case_sensitive
setAnchorHorizontalAlignment() : $this: Sets anchor_horizontal_alignment
setAnchorIgnoreIfNotPresent() : $this: Sets anchor_ignore_if_not_present
setAnchorMatchWholeWord() : $this: Sets anchor_match_whole_word
setAnchorUnits() : $this: Sets anchor_units
setAnchorXOffset() : $this: Sets anchor_x_offset
setAnchorYOffset() : $this: Sets anchor_y_offset
setBold() : $this: Sets bold
setCollaborative() : $this: Sets collaborative
setConcealValueOnDocument() : $this: Sets conceal_value_on_document
setCreatedByDisplayName() : $this: Sets created_by_display_name
setCreatedByUserId() : $this: Sets created_by_user_id
setCustomTabId() : $this: Sets custom_tab_id
setDisableAutoSize() : $this: Sets disable_auto_size
setEditable() : $this: Sets editable
setFont() : $this: Sets font
setFontColor() : $this: Sets font_color
setFontSize() : $this: Sets font_size
setHeight() : $this: Sets height
setIncludedInEmail() : $this: Sets included_in_email
setInitialValue() : $this: Sets initial_value
setItalic() : $this: Sets italic
setItems() : $this: Sets items
setLastModified() : $this: Sets last_modified
setLastModifiedByDisplayName() : $this: Sets last_modified_by_display_name
setLastModifiedByUserId() : $this: Sets last_modified_by_user_id
setLocalePolicy() : $this: Sets locale_policy
setLocked() : $this: Sets locked
setMaximumLength() : $this: Sets maximum_length
setMaxNumericalValue() : $this: Sets max_numerical_value
setMergeField() : $this: Sets merge_field
setMinNumericalValue() : $this: Sets min_numerical_value
setName() : $this: Sets name
setNumericalValue() : $this: Sets numerical_value
setPaymentItemCode() : $this: Sets payment_item_code
setPaymentItemDescription() : $this: Sets payment_item_description
setPaymentItemName() : $this: Sets payment_item_name
setRequireAll() : $this: Sets require_all
setRequired() : $this: Sets required
setRequireInitialOnSharedChange() : $this: Sets require_initial_on_shared_change
setScaleValue() : $this: Sets scale_value
setSelected() : $this: Sets selected
setShared() : $this: Sets shared
setSignatureProviderId() : $this: Sets signature_provider_id
setStampType() : $this: Sets stamp_type
setStampTypeMetadata() : $this: Sets stamp_type_metadata
setTabLabel() : $this: Sets tab_label
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setType() : $this: Sets type
setUnderline() : $this: Sets underline
setValidationMessage() : $this: Sets validation_message
setValidationPattern() : $this: Sets validation_pattern
setValidationType() : $this: Sets validation_type
setWidth() : $this: Sets width
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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$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
     = ['anchor' => 'anchor', 'anchor_case_sensitive' => 'anchorCaseSensitive', 'anchor_horizontal_alignment' => 'anchorHorizontalAlignment', 'anchor_ignore_if_not_present' => 'anchorIgnoreIfNotPresent', 'anchor_match_whole_word' => 'anchorMatchWholeWord', 'anchor_units' => 'anchorUnits', 'anchor_x_offset' => 'anchorXOffset', 'anchor_y_offset' => 'anchorYOffset', 'bold' => 'bold', 'collaborative' => 'collaborative', 'conceal_value_on_document' => 'concealValueOnDocument', 'created_by_display_name' => 'createdByDisplayName', 'created_by_user_id' => 'createdByUserId', 'custom_tab_id' => 'customTabId', 'disable_auto_size' => 'disableAutoSize', 'editable' => 'editable', 'font' => 'font', 'font_color' => 'fontColor', 'font_size' => 'fontSize', 'height' => 'height', 'included_in_email' => 'includedInEmail', 'initial_value' => 'initialValue', 'italic' => 'italic', 'items' => 'items', 'last_modified' => 'lastModified', 'last_modified_by_display_name' => 'lastModifiedByDisplayName', 'last_modified_by_user_id' => 'lastModifiedByUserId', 'locale_policy' => 'localePolicy', 'locked' => 'locked', 'maximum_length' => 'maximumLength', 'max_numerical_value' => 'maxNumericalValue', 'merge_field' => 'mergeField', 'min_numerical_value' => 'minNumericalValue', 'name' => 'name', 'numerical_value' => 'numericalValue', 'payment_item_code' => 'paymentItemCode', 'payment_item_description' => 'paymentItemDescription', 'payment_item_name' => 'paymentItemName', 'require_all' => 'requireAll', 'required' => 'required', 'require_initial_on_shared_change' => 'requireInitialOnSharedChange', 'scale_value' => 'scaleValue', 'selected' => 'selected', 'shared' => 'shared', 'signature_provider_id' => 'signatureProviderId', 'stamp_type' => 'stampType', 'stamp_type_metadata' => 'stampTypeMetadata', 'tab_label' => 'tabLabel', 'type' => 'type', 'underline' => 'underline', 'validation_message' => 'validationMessage', 'validation_pattern' => 'validationPattern', 'validation_type' => 'validationType', 'width' => 'width']

$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
     = ['anchor' => 'getAnchor', 'anchor_case_sensitive' => 'getAnchorCaseSensitive', 'anchor_horizontal_alignment' => 'getAnchorHorizontalAlignment', 'anchor_ignore_if_not_present' => 'getAnchorIgnoreIfNotPresent', 'anchor_match_whole_word' => 'getAnchorMatchWholeWord', 'anchor_units' => 'getAnchorUnits', 'anchor_x_offset' => 'getAnchorXOffset', 'anchor_y_offset' => 'getAnchorYOffset', 'bold' => 'getBold', 'collaborative' => 'getCollaborative', 'conceal_value_on_document' => 'getConcealValueOnDocument', 'created_by_display_name' => 'getCreatedByDisplayName', 'created_by_user_id' => 'getCreatedByUserId', 'custom_tab_id' => 'getCustomTabId', 'disable_auto_size' => 'getDisableAutoSize', 'editable' => 'getEditable', 'font' => 'getFont', 'font_color' => 'getFontColor', 'font_size' => 'getFontSize', 'height' => 'getHeight', 'included_in_email' => 'getIncludedInEmail', 'initial_value' => 'getInitialValue', 'italic' => 'getItalic', 'items' => 'getItems', 'last_modified' => 'getLastModified', 'last_modified_by_display_name' => 'getLastModifiedByDisplayName', 'last_modified_by_user_id' => 'getLastModifiedByUserId', 'locale_policy' => 'getLocalePolicy', 'locked' => 'getLocked', 'maximum_length' => 'getMaximumLength', 'max_numerical_value' => 'getMaxNumericalValue', 'merge_field' => 'getMergeField', 'min_numerical_value' => 'getMinNumericalValue', 'name' => 'getName', 'numerical_value' => 'getNumericalValue', 'payment_item_code' => 'getPaymentItemCode', 'payment_item_description' => 'getPaymentItemDescription', 'payment_item_name' => 'getPaymentItemName', 'require_all' => 'getRequireAll', 'required' => 'getRequired', 'require_initial_on_shared_change' => 'getRequireInitialOnSharedChange', 'scale_value' => 'getScaleValue', 'selected' => 'getSelected', 'shared' => 'getShared', 'signature_provider_id' => 'getSignatureProviderId', 'stamp_type' => 'getStampType', 'stamp_type_metadata' => 'getStampTypeMetadata', 'tab_label' => 'getTabLabel', 'type' => 'getType', 'underline' => 'getUnderline', 'validation_message' => 'getValidationMessage', 'validation_pattern' => 'getValidationPattern', 'validation_type' => 'getValidationType', 'width' => 'getWidth']

$setters

Array of attributes to setter functions (for deserialization of responses)


    protected
    static    array<string|int, string>
    $setters
     = ['anchor' => 'setAnchor', 'anchor_case_sensitive' => 'setAnchorCaseSensitive', 'anchor_horizontal_alignment' => 'setAnchorHorizontalAlignment', 'anchor_ignore_if_not_present' => 'setAnchorIgnoreIfNotPresent', 'anchor_match_whole_word' => 'setAnchorMatchWholeWord', 'anchor_units' => 'setAnchorUnits', 'anchor_x_offset' => 'setAnchorXOffset', 'anchor_y_offset' => 'setAnchorYOffset', 'bold' => 'setBold', 'collaborative' => 'setCollaborative', 'conceal_value_on_document' => 'setConcealValueOnDocument', 'created_by_display_name' => 'setCreatedByDisplayName', 'created_by_user_id' => 'setCreatedByUserId', 'custom_tab_id' => 'setCustomTabId', 'disable_auto_size' => 'setDisableAutoSize', 'editable' => 'setEditable', 'font' => 'setFont', 'font_color' => 'setFontColor', 'font_size' => 'setFontSize', 'height' => 'setHeight', 'included_in_email' => 'setIncludedInEmail', 'initial_value' => 'setInitialValue', 'italic' => 'setItalic', 'items' => 'setItems', 'last_modified' => 'setLastModified', 'last_modified_by_display_name' => 'setLastModifiedByDisplayName', 'last_modified_by_user_id' => 'setLastModifiedByUserId', 'locale_policy' => 'setLocalePolicy', 'locked' => 'setLocked', 'maximum_length' => 'setMaximumLength', 'max_numerical_value' => 'setMaxNumericalValue', 'merge_field' => 'setMergeField', 'min_numerical_value' => 'setMinNumericalValue', 'name' => 'setName', 'numerical_value' => 'setNumericalValue', 'payment_item_code' => 'setPaymentItemCode', 'payment_item_description' => 'setPaymentItemDescription', 'payment_item_name' => 'setPaymentItemName', 'require_all' => 'setRequireAll', 'required' => 'setRequired', 'require_initial_on_shared_change' => 'setRequireInitialOnSharedChange', 'scale_value' => 'setScaleValue', 'selected' => 'setSelected', 'shared' => 'setShared', 'signature_provider_id' => 'setSignatureProviderId', 'stamp_type' => 'setStampType', 'stamp_type_metadata' => 'setStampTypeMetadata', 'tab_label' => 'setTabLabel', 'type' => 'setType', 'underline' => 'setUnderline', 'validation_message' => 'setValidationMessage', 'validation_pattern' => 'setValidationPattern', 'validation_type' => 'setValidationType', 'width' => 'setWidth']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerFormats
     = ['anchor' => null, 'anchor_case_sensitive' => null, 'anchor_horizontal_alignment' => null, 'anchor_ignore_if_not_present' => null, 'anchor_match_whole_word' => null, 'anchor_units' => null, 'anchor_x_offset' => null, 'anchor_y_offset' => null, 'bold' => null, 'collaborative' => null, 'conceal_value_on_document' => null, 'created_by_display_name' => null, 'created_by_user_id' => null, 'custom_tab_id' => null, 'disable_auto_size' => null, 'editable' => null, 'font' => null, 'font_color' => null, 'font_size' => null, 'height' => null, 'included_in_email' => null, 'initial_value' => null, 'italic' => null, 'items' => null, 'last_modified' => null, 'last_modified_by_display_name' => null, 'last_modified_by_user_id' => null, 'locale_policy' => null, 'locked' => null, 'maximum_length' => null, 'max_numerical_value' => null, 'merge_field' => null, 'min_numerical_value' => null, 'name' => null, 'numerical_value' => null, 'payment_item_code' => null, 'payment_item_description' => null, 'payment_item_name' => null, 'require_all' => null, 'required' => null, 'require_initial_on_shared_change' => null, 'scale_value' => null, 'selected' => null, 'shared' => null, 'signature_provider_id' => null, 'stamp_type' => null, 'stamp_type_metadata' => null, 'tab_label' => null, 'type' => null, 'underline' => null, 'validation_message' => null, 'validation_pattern' => null, 'validation_type' => null, 'width' => null]

$swaggerModelName

The original name of the model.


    protected
    static    string
    $swaggerModelName
     = 'tabMetadata'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerTypes
     = ['anchor' => '?string', 'anchor_case_sensitive' => '?string', 'anchor_horizontal_alignment' => '?string', 'anchor_ignore_if_not_present' => '?string', 'anchor_match_whole_word' => '?string', 'anchor_units' => '?string', 'anchor_x_offset' => '?string', 'anchor_y_offset' => '?string', 'bold' => '?string', 'collaborative' => '?string', 'conceal_value_on_document' => '?string', 'created_by_display_name' => '?string', 'created_by_user_id' => '?string', 'custom_tab_id' => '?string', 'disable_auto_size' => '?string', 'editable' => '?string', 'font' => '?string', 'font_color' => '?string', 'font_size' => '?string', 'height' => '?string', 'included_in_email' => '?string', 'initial_value' => '?string', 'italic' => '?string', 'items' => '?string[]', 'last_modified' => '?string', 'last_modified_by_display_name' => '?string', 'last_modified_by_user_id' => '?string', 'locale_policy' => '\\DocuSign\\eSign\\Model\\LocalePolicyTab', 'locked' => '?string', 'maximum_length' => '?string', 'max_numerical_value' => '?string', 'merge_field' => '\\DocuSign\\eSign\\Model\\MergeField', 'min_numerical_value' => '?string', 'name' => '?string', 'numerical_value' => '?string', 'payment_item_code' => '?string', 'payment_item_description' => '?string', 'payment_item_name' => '?string', 'require_all' => '?string', 'required' => '?string', 'require_initial_on_shared_change' => '?string', 'scale_value' => '?string', 'selected' => '?string', 'shared' => '?string', 'signature_provider_id' => '?string', 'stamp_type' => '?string', 'stamp_type_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_label' => '?string', 'type' => '?string', 'underline' => '?string', 'validation_message' => '?string', 'validation_pattern' => '?string', 'validation_type' => '?string', 'width' => '?string']

__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> —

getAnchor()

Gets anchor


    public
                getAnchor() : string|null

Return values

string|null —

getAnchorCaseSensitive()

Gets anchor_case_sensitive


    public
                getAnchorCaseSensitive() : string|null

Return values

string|null —

getAnchorHorizontalAlignment()

Gets anchor_horizontal_alignment


    public
                getAnchorHorizontalAlignment() : string|null

Return values

string|null —

getAnchorIgnoreIfNotPresent()

Gets anchor_ignore_if_not_present


    public
                getAnchorIgnoreIfNotPresent() : string|null

Return values

string|null —

getAnchorMatchWholeWord()

Gets anchor_match_whole_word


    public
                getAnchorMatchWholeWord() : string|null

Return values

string|null —

getAnchorUnits()

Gets anchor_units


    public
                getAnchorUnits() : string|null

Return values

string|null —

getAnchorXOffset()

Gets anchor_x_offset


    public
                getAnchorXOffset() : string|null

Return values

string|null —

getAnchorYOffset()

Gets anchor_y_offset


    public
                getAnchorYOffset() : string|null

Return values

string|null —

getBold()

Gets bold


    public
                getBold() : string|null

Return values

string|null —

getCollaborative()

Gets collaborative


    public
                getCollaborative() : string|null

Return values

string|null —

getConcealValueOnDocument()

Gets conceal_value_on_document


    public
                getConcealValueOnDocument() : string|null

Return values

string|null —

getCreatedByDisplayName()

Gets created_by_display_name


    public
                getCreatedByDisplayName() : string|null

Return values

string|null —

getCreatedByUserId()

Gets created_by_user_id


    public
                getCreatedByUserId() : string|null

Return values

string|null —

getCustomTabId()

Gets custom_tab_id


    public
                getCustomTabId() : string|null

Return values

string|null —

getDisableAutoSize()

Gets disable_auto_size


    public
                getDisableAutoSize() : string|null

Return values

string|null —

getEditable()

Gets editable


    public
                getEditable() : string|null

Return values

string|null —

getFont()

Gets font


    public
                getFont() : string|null

Return values

string|null —

getFontColor()

Gets font_color


    public
                getFontColor() : string|null

Return values

string|null —

getFontSize()

Gets font_size


    public
                getFontSize() : string|null

Return values

string|null —

getHeight()

Gets height


    public
                getHeight() : string|null

Return values

string|null —

getIncludedInEmail()

Gets included_in_email


    public
                getIncludedInEmail() : string|null

Return values

string|null —

getInitialValue()

Gets initial_value


    public
                getInitialValue() : string|null

Return values

string|null —

getItalic()

Gets italic


    public
                getItalic() : string|null

Return values

string|null —

getItems()

Gets items


    public
                getItems() : array<string|int, ?string>

Return values

array<string|int, ?string> —

getLastModified()

Gets last_modified


    public
                getLastModified() : string|null

Return values

string|null —

getLastModifiedByDisplayName()

Gets last_modified_by_display_name


    public
                getLastModifiedByDisplayName() : string|null

Return values

string|null —

getLastModifiedByUserId()

Gets last_modified_by_user_id


    public
                getLastModifiedByUserId() : string|null

Return values

string|null —

getLocalePolicy()

Gets locale_policy


    public
                getLocalePolicy() : LocalePolicyTab

Return values

LocalePolicyTab —

getLocked()

Gets locked


    public
                getLocked() : string|null

Return values

string|null —

getMaximumLength()

Gets maximum_length


    public
                getMaximumLength() : string|null

Return values

string|null —

getMaxNumericalValue()

Gets max_numerical_value


    public
                getMaxNumericalValue() : string|null

Return values

string|null —

getMergeField()

Gets merge_field


    public
                getMergeField() : MergeField

Return values

MergeField —

getMinNumericalValue()

Gets min_numerical_value


    public
                getMinNumericalValue() : string|null

Return values

string|null —

getModelName()

The original name of the model.


    public
                getModelName() : string

Return values

string —

getName()

Gets name


    public
                getName() : string|null

Return values

string|null —

getNumericalValue()

Gets numerical_value


    public
                getNumericalValue() : string|null

Return values

string|null —

getPaymentItemCode()

Gets payment_item_code


    public
                getPaymentItemCode() : string|null

Return values

string|null —

getPaymentItemDescription()

Gets payment_item_description


    public
                getPaymentItemDescription() : string|null

Return values

string|null —

getPaymentItemName()

Gets payment_item_name


    public
                getPaymentItemName() : string|null

Return values

string|null —

getRequireAll()

Gets require_all


    public
                getRequireAll() : string|null

Return values

string|null —

getRequired()

Gets required


    public
                getRequired() : string|null

Return values

string|null —

getRequireInitialOnSharedChange()

Gets require_initial_on_shared_change


    public
                getRequireInitialOnSharedChange() : string|null

Return values

string|null —

getScaleValue()

Gets scale_value


    public
                getScaleValue() : string|null

Return values

string|null —

getSelected()

Gets selected


    public
                getSelected() : string|null

Return values

string|null —

getShared()

Gets shared


    public
                getShared() : string|null

Return values

string|null —

getSignatureProviderId()

Gets signature_provider_id


    public
                getSignatureProviderId() : string|null

Return values

string|null —

getStampType()

Gets stamp_type


    public
                getStampType() : string|null

Return values

string|null —

getStampTypeMetadata()

Gets stamp_type_metadata


    public
                getStampTypeMetadata() : PropertyMetadata

Return values

PropertyMetadata —

getTabLabel()

Gets tab_label


    public
                getTabLabel() : 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> —

getType()

Gets type


    public
                getType() : string|null

Return values

string|null —

getUnderline()

Gets underline


    public
                getUnderline() : string|null

Return values

string|null —

getValidationMessage()

Gets validation_message


    public
                getValidationMessage() : string|null

Return values

string|null —

getValidationPattern()

Gets validation_pattern


    public
                getValidationPattern() : string|null

Return values

string|null —

getValidationType()

Gets validation_type


    public
                getValidationType() : string|null

Return values

string|null —

getWidth()

Gets width


    public
                getWidth() : string|null

Return values

string|null —

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 —

setAnchor()

Sets anchor


    public
                setAnchor(string|null $anchor) : $this

Parameters

$anchor : string|null: An optional string that is used to auto-match tabs to strings located in the documents of an envelope.

Return values

$this —

setAnchorCaseSensitive()

Sets anchor_case_sensitive


    public
                setAnchorCaseSensitive(string|null $anchor_case_sensitive) : $this

Parameters

$anchor_case_sensitive : string|null: When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.

Return values

$this —

setAnchorHorizontalAlignment()

Sets anchor_horizontal_alignment


    public
                setAnchorHorizontalAlignment(string|null $anchor_horizontal_alignment) : $this

Parameters

$anchor_horizontal_alignment : string|null: Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.

Return values

$this —

setAnchorIgnoreIfNotPresent()

Sets anchor_ignore_if_not_present


    public
                setAnchorIgnoreIfNotPresent(string|null $anchor_ignore_if_not_present) : $this

Parameters

$anchor_ignore_if_not_present : string|null: When set to true, this tab is ignored if anchorString is not found in the document.

Return values

$this —

setAnchorMatchWholeWord()

Sets anchor_match_whole_word


    public
                setAnchorMatchWholeWord(string|null $anchor_match_whole_word) : $this

Parameters

$anchor_match_whole_word : string|null: When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.

Return values

$this —

setAnchorUnits()

Sets anchor_units


    public
                setAnchorUnits(string|null $anchor_units) : $this

Parameters

$anchor_units : string|null: Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

Return values

$this —

setAnchorXOffset()

Sets anchor_x_offset


    public
                setAnchorXOffset(string|null $anchor_x_offset) : $this

Parameters

$anchor_x_offset : string|null: Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.

Return values

$this —

setAnchorYOffset()

Sets anchor_y_offset


    public
                setAnchorYOffset(string|null $anchor_y_offset) : $this

Parameters

$anchor_y_offset : string|null: Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.

Return values

$this —

setBold()

Sets bold


    public
                setBold(string|null $bold) : $this

Parameters

$bold : string|null: When set to true, the information in the tab is bold.

Return values

$this —

setCollaborative()

Sets collaborative


    public
                setCollaborative(string|null $collaborative) : $this

Parameters

$collaborative : string|null

Return values

$this —

setConcealValueOnDocument()

Sets conceal_value_on_document


    public
                setConcealValueOnDocument(string|null $conceal_value_on_document) : $this

Parameters

$conceal_value_on_document : string|null: When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

Return values

$this —

setCreatedByDisplayName()

Sets created_by_display_name


    public
                setCreatedByDisplayName(string|null $created_by_display_name) : $this

Parameters

$created_by_display_name : string|null: The user name of the DocuSign user who created this object.

Return values

$this —

setCreatedByUserId()

Sets created_by_user_id


    public
                setCreatedByUserId(string|null $created_by_user_id) : $this

Parameters

$created_by_user_id : string|null: The userId of the DocuSign user who created this object.

Return values

$this —

setCustomTabId()

Sets custom_tab_id


    public
                setCustomTabId(string|null $custom_tab_id) : $this

Parameters

$custom_tab_id : string|null: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

Return values

$this —

setDisableAutoSize()

Sets disable_auto_size


    public
                setDisableAutoSize(string|null $disable_auto_size) : $this

Parameters

$disable_auto_size : string|null: When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

Return values

$this —

setEditable()

Sets editable


    public
                setEditable(string|null $editable) : $this

Parameters

$editable : string|null: When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified.

Return values

$this —

setFont()

Sets font


    public
                setFont(string|null $font) : $this

Parameters

$font : string|null: The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.

Return values

$this —

setFontColor()

Sets font_color


    public
                setFontColor(string|null $font_color) : $this

Parameters

$font_color : string|null: The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.

Return values

$this —

setFontSize()

Sets font_size


    public
                setFontSize(string|null $font_size) : $this

Parameters

$font_size : string|null: The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.

Return values

$this —

setHeight()

Sets height


    public
                setHeight(string|null $height) : $this

Parameters

$height : string|null: Height of the tab in pixels.

Return values

$this —

setIncludedInEmail()

Sets included_in_email


    public
                setIncludedInEmail(string|null $included_in_email) : $this

Parameters

$included_in_email : string|null: When set to true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.

Return values

$this —

setInitialValue()

Sets initial_value


    public
                setInitialValue(string|null $initial_value) : $this

Parameters

$initial_value : string|null: The original value of the tab.

Return values

$this —

setItalic()

Sets italic


    public
                setItalic(string|null $italic) : $this

Parameters

$italic : string|null: When set to true, the information in the tab is italic.

Return values

$this —

setItems()

Sets items


    public
                setItems(array<string|int, ?string> $items) : $this

Parameters

$items : array<string|int, ?string>: If the tab is a list, this represents the values that are possible for the tab.

Return values

$this —

setLastModified()

Sets last_modified


    public
                setLastModified(string|null $last_modified) : $this

Parameters

$last_modified : string|null: The UTC DateTime this object was last modified. This is in ISO8601 format.

Return values

$this —

setLastModifiedByDisplayName()

Sets last_modified_by_display_name


    public
                setLastModifiedByDisplayName(string|null $last_modified_by_display_name) : $this

Parameters

$last_modified_by_display_name : string|null: The User Name of the DocuSign user who last modified this object.

Return values

$this —

setLastModifiedByUserId()

Sets last_modified_by_user_id


    public
                setLastModifiedByUserId(string|null $last_modified_by_user_id) : $this

Parameters

$last_modified_by_user_id : string|null: The userId of the DocuSign user who last modified this object.

Return values

$this —

setLocalePolicy()

Sets locale_policy


    public
                setLocalePolicy(LocalePolicyTab $locale_policy) : $this

Parameters

$locale_policy : LocalePolicyTab: Reserved for DocuSign.

Return values

$this —

setLocked()

Sets locked


    public
                setLocked(string|null $locked) : $this

Parameters

$locked : string|null: When set to true, the signer cannot change the data of the custom tab.

Return values

$this —

setMaximumLength()

Sets maximum_length


    public
                setMaximumLength(string|null $maximum_length) : $this

Parameters

$maximum_length : string|null: The maximum number of entry characters supported by the custom tab.

Return values

$this —

setMaxNumericalValue()

Sets max_numerical_value


    public
                setMaxNumericalValue(string|null $max_numerical_value) : $this

Parameters

$max_numerical_value : string|null

Return values

$this —

setMergeField()

Sets merge_field


    public
                setMergeField(MergeField $merge_field) : $this

Parameters

$merge_field : MergeField: Contains the information necessary to map the tab to a field in SalesForce.

Return values

$this —

setMinNumericalValue()

Sets min_numerical_value


    public
                setMinNumericalValue(string|null $min_numerical_value) : $this

Parameters

$min_numerical_value : string|null

Return values

$this —

setName()

Sets name


    public
                setName(string|null $name) : $this

Parameters

$name : string|null

Return values

$this —

setNumericalValue()

Sets numerical_value


    public
                setNumericalValue(string|null $numerical_value) : $this

Parameters

$numerical_value : string|null

Return values

$this —

setPaymentItemCode()

Sets payment_item_code


    public
                setPaymentItemCode(string|null $payment_item_code) : $this

Parameters

$payment_item_code : string|null

Return values

$this —

setPaymentItemDescription()

Sets payment_item_description


    public
                setPaymentItemDescription(string|null $payment_item_description) : $this

Parameters

$payment_item_description : string|null

Return values

$this —

setPaymentItemName()

Sets payment_item_name


    public
                setPaymentItemName(string|null $payment_item_name) : $this

Parameters

$payment_item_name : string|null

Return values

$this —

setRequireAll()

Sets require_all


    public
                setRequireAll(string|null $require_all) : $this

Parameters

$require_all : string|null: When set to true and shared is true, information must be entered in this field to complete the envelope.

Return values

$this —

setRequired()

Sets required


    public
                setRequired(string|null $required) : $this

Parameters

$required : string|null: When set to true, the signer is required to fill out this tab

Return values

$this —

setRequireInitialOnSharedChange()

Sets require_initial_on_shared_change


    public
                setRequireInitialOnSharedChange(string|null $require_initial_on_shared_change) : $this

Parameters

$require_initial_on_shared_change : string|null: Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

Return values

$this —

setScaleValue()

Sets scale_value


    public
                setScaleValue(string|null $scale_value) : $this

Parameters

$scale_value : string|null

Return values

$this —

setSelected()

Sets selected


    public
                setSelected(string|null $selected) : $this

Parameters

$selected : string|null

Return values

$this —

setShared()

Sets shared


    public
                setShared(string|null $shared) : $this

Parameters

$shared : string|null: When set to true, this custom tab is shared.

Return values

$this —

setSignatureProviderId()

Sets signature_provider_id


    public
                setSignatureProviderId(string|null $signature_provider_id) : $this

Parameters

$signature_provider_id : string|null

Return values

$this —

setStampType()

Sets stamp_type


    public
                setStampType(string|null $stamp_type) : $this

Parameters

$stamp_type : string|null

Return values

$this —

setStampTypeMetadata()

Sets stamp_type_metadata


    public
                setStampTypeMetadata(PropertyMetadata $stamp_type_metadata) : $this

Parameters

$stamp_type_metadata : PropertyMetadata: Metadata that indicates whether the stampType property is editable.

Return values

$this —

setTabLabel()

Sets tab_label


    public
                setTabLabel(string|null $tab_label) : $this

Parameters

$tab_label : string|null: The label string associated with the tab.

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> —

setType()

Sets type


    public
                setType(string|null $type) : $this

Parameters

$type : string|null: The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.

Return values

$this —

setUnderline()

Sets underline


    public
                setUnderline(string|null $underline) : $this

Parameters

$underline : string|null: When set to true, the information in the tab is underlined.

Return values

$this —

setValidationMessage()

Sets validation_message


    public
                setValidationMessage(string|null $validation_message) : $this

Parameters

$validation_message : string|null: The message displayed if the custom tab fails input validation (either custom of embedded).

Return values

$this —

setValidationPattern()

Sets validation_pattern


    public
                setValidationPattern(string|null $validation_pattern) : $this

Parameters

$validation_pattern : string|null: A regular expression used to validate input for the tab.

Return values

$this —

setValidationType()

Sets validation_type


    public
                setValidationType(string|null $validation_type) : $this

Parameters

$validation_type : string|null

Return values

$this —

setWidth()

Sets width


    public
                setWidth(string|null $width) : $this

Parameters

$width : string|null: Width of the tab in pixels.

Return values

$this —

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

TabMetadata in package DocuSign eSign implements ModelInterface, ArrayAccess

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$setters

$swaggerFormats

$swaggerModelName

$swaggerTypes

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getAnchor()

Return values

getAnchorCaseSensitive()

Return values

getAnchorHorizontalAlignment()

Return values

getAnchorIgnoreIfNotPresent()

Return values

getAnchorMatchWholeWord()

Return values

getAnchorUnits()

Return values

getAnchorXOffset()

Return values

getAnchorYOffset()

Return values

getBold()

Return values

getCollaborative()

Return values

getConcealValueOnDocument()

Return values

getCreatedByDisplayName()

Return values

getCreatedByUserId()

Return values

getCustomTabId()

Return values

getDisableAutoSize()

Return values

getEditable()

Return values

getFont()

Return values

getFontColor()

Return values

getFontSize()

Return values

getHeight()

Return values

getIncludedInEmail()

Return values

getInitialValue()

Return values

getItalic()

Return values

getItems()

Return values

getLastModified()

Return values

getLastModifiedByDisplayName()

Return values

getLastModifiedByUserId()

Return values

getLocalePolicy()

Return values

getLocked()

Return values

TabMetadata
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess