Documentation

RadioGroup
in package
implements ModelInterface, ArrayAccess

RadioGroup Class Doc Comment

Tags
category

Class

description

This group tab is used to place radio buttons on a document. The `radios` property contains a list of `radio` objects associated with the group. Only one radio button can be selected in a group.

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

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
getConditionalParentLabel()  : string|null
Gets conditional_parent_label
getConditionalParentLabelMetadata()  : PropertyMetadata
Gets conditional_parent_label_metadata
getConditionalParentValue()  : string|null
Gets conditional_parent_value
getConditionalParentValueMetadata()  : PropertyMetadata
Gets conditional_parent_value_metadata
getDocumentId()  : string|null
Gets document_id
getDocumentIdMetadata()  : PropertyMetadata
Gets document_id_metadata
getGroupName()  : string|null
Gets group_name
getGroupNameMetadata()  : PropertyMetadata
Gets group_name_metadata
getModelName()  : string
The original name of the model.
getOriginalValue()  : string|null
Gets original_value
getOriginalValueMetadata()  : PropertyMetadata
Gets original_value_metadata
getRadios()  : array<string|int, Radio>
Gets radios
getRecipientId()  : string|null
Gets recipient_id
getRecipientIdGuid()  : string|null
Gets recipient_id_guid
getRecipientIdGuidMetadata()  : PropertyMetadata
Gets recipient_id_guid_metadata
getRecipientIdMetadata()  : PropertyMetadata
Gets recipient_id_metadata
getRequireAll()  : string|null
Gets require_all
getRequireAllMetadata()  : PropertyMetadata
Gets require_all_metadata
getRequireInitialOnSharedChange()  : string|null
Gets require_initial_on_shared_change
getRequireInitialOnSharedChangeMetadata()  : PropertyMetadata
Gets require_initial_on_shared_change_metadata
getShared()  : string|null
Gets shared
getSharedMetadata()  : PropertyMetadata
Gets shared_metadata
getShareToRecipients()  : string|null
Gets share_to_recipients
getShareToRecipientsMetadata()  : PropertyMetadata
Gets share_to_recipients_metadata
getTabType()  : string|null
Gets tab_type
getTabTypeMetadata()  : PropertyMetadata
Gets tab_type_metadata
getTemplateLocked()  : string|null
Gets template_locked
getTemplateLockedMetadata()  : PropertyMetadata
Gets template_locked_metadata
getTemplateRequired()  : string|null
Gets template_required
getTemplateRequiredMetadata()  : PropertyMetadata
Gets template_required_metadata
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTooltip()  : string|null
Gets tooltip
getTooltipMetadata()  : PropertyMetadata
Gets tooltip_metadata
getValue()  : string|null
Gets value
getValueMetadata()  : PropertyMetadata
Gets value_metadata
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.
setConditionalParentLabel()  : $this
Sets conditional_parent_label
setConditionalParentLabelMetadata()  : $this
Sets conditional_parent_label_metadata
setConditionalParentValue()  : $this
Sets conditional_parent_value
setConditionalParentValueMetadata()  : $this
Sets conditional_parent_value_metadata
setDocumentId()  : $this
Sets document_id
setDocumentIdMetadata()  : $this
Sets document_id_metadata
setGroupName()  : $this
Sets group_name
setGroupNameMetadata()  : $this
Sets group_name_metadata
setOriginalValue()  : $this
Sets original_value
setOriginalValueMetadata()  : $this
Sets original_value_metadata
setRadios()  : $this
Sets radios
setRecipientId()  : $this
Sets recipient_id
setRecipientIdGuid()  : $this
Sets recipient_id_guid
setRecipientIdGuidMetadata()  : $this
Sets recipient_id_guid_metadata
setRecipientIdMetadata()  : $this
Sets recipient_id_metadata
setRequireAll()  : $this
Sets require_all
setRequireAllMetadata()  : $this
Sets require_all_metadata
setRequireInitialOnSharedChange()  : $this
Sets require_initial_on_shared_change
setRequireInitialOnSharedChangeMetadata()  : $this
Sets require_initial_on_shared_change_metadata
setShared()  : $this
Sets shared
setSharedMetadata()  : $this
Sets shared_metadata
setShareToRecipients()  : $this
Sets share_to_recipients
setShareToRecipientsMetadata()  : $this
Sets share_to_recipients_metadata
setTabType()  : $this
Sets tab_type
setTabTypeMetadata()  : $this
Sets tab_type_metadata
setTemplateLocked()  : $this
Sets template_locked
setTemplateLockedMetadata()  : $this
Sets template_locked_metadata
setTemplateRequired()  : $this
Sets template_required
setTemplateRequiredMetadata()  : $this
Sets template_required_metadata
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTooltip()  : $this
Sets tooltip
setTooltipMetadata()  : $this
Sets tooltip_metadata
setValue()  : $this
Sets value
setValueMetadata()  : $this
Sets value_metadata
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

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 = ['conditional_parent_label' => 'conditionalParentLabel', 'conditional_parent_label_metadata' => 'conditionalParentLabelMetadata', 'conditional_parent_value' => 'conditionalParentValue', 'conditional_parent_value_metadata' => 'conditionalParentValueMetadata', 'document_id' => 'documentId', 'document_id_metadata' => 'documentIdMetadata', 'group_name' => 'groupName', 'group_name_metadata' => 'groupNameMetadata', 'original_value' => 'originalValue', 'original_value_metadata' => 'originalValueMetadata', 'radios' => 'radios', 'recipient_id' => 'recipientId', 'recipient_id_guid' => 'recipientIdGuid', 'recipient_id_guid_metadata' => 'recipientIdGuidMetadata', 'recipient_id_metadata' => 'recipientIdMetadata', 'require_all' => 'requireAll', 'require_all_metadata' => 'requireAllMetadata', 'require_initial_on_shared_change' => 'requireInitialOnSharedChange', 'require_initial_on_shared_change_metadata' => 'requireInitialOnSharedChangeMetadata', 'shared' => 'shared', 'shared_metadata' => 'sharedMetadata', 'share_to_recipients' => 'shareToRecipients', 'share_to_recipients_metadata' => 'shareToRecipientsMetadata', 'tab_type' => 'tabType', 'tab_type_metadata' => 'tabTypeMetadata', 'template_locked' => 'templateLocked', 'template_locked_metadata' => 'templateLockedMetadata', 'template_required' => 'templateRequired', 'template_required_metadata' => 'templateRequiredMetadata', 'tooltip' => 'tooltip', 'tooltip_metadata' => 'tooltipMetadata', 'value' => 'value', 'value_metadata' => 'valueMetadata']

$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 = ['conditional_parent_label' => 'getConditionalParentLabel', 'conditional_parent_label_metadata' => 'getConditionalParentLabelMetadata', 'conditional_parent_value' => 'getConditionalParentValue', 'conditional_parent_value_metadata' => 'getConditionalParentValueMetadata', 'document_id' => 'getDocumentId', 'document_id_metadata' => 'getDocumentIdMetadata', 'group_name' => 'getGroupName', 'group_name_metadata' => 'getGroupNameMetadata', 'original_value' => 'getOriginalValue', 'original_value_metadata' => 'getOriginalValueMetadata', 'radios' => 'getRadios', 'recipient_id' => 'getRecipientId', 'recipient_id_guid' => 'getRecipientIdGuid', 'recipient_id_guid_metadata' => 'getRecipientIdGuidMetadata', 'recipient_id_metadata' => 'getRecipientIdMetadata', 'require_all' => 'getRequireAll', 'require_all_metadata' => 'getRequireAllMetadata', 'require_initial_on_shared_change' => 'getRequireInitialOnSharedChange', 'require_initial_on_shared_change_metadata' => 'getRequireInitialOnSharedChangeMetadata', 'shared' => 'getShared', 'shared_metadata' => 'getSharedMetadata', 'share_to_recipients' => 'getShareToRecipients', 'share_to_recipients_metadata' => 'getShareToRecipientsMetadata', 'tab_type' => 'getTabType', 'tab_type_metadata' => 'getTabTypeMetadata', 'template_locked' => 'getTemplateLocked', 'template_locked_metadata' => 'getTemplateLockedMetadata', 'template_required' => 'getTemplateRequired', 'template_required_metadata' => 'getTemplateRequiredMetadata', 'tooltip' => 'getTooltip', 'tooltip_metadata' => 'getTooltipMetadata', 'value' => 'getValue', 'value_metadata' => 'getValueMetadata']

$setters

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

protected static array<string|int, string> $setters = ['conditional_parent_label' => 'setConditionalParentLabel', 'conditional_parent_label_metadata' => 'setConditionalParentLabelMetadata', 'conditional_parent_value' => 'setConditionalParentValue', 'conditional_parent_value_metadata' => 'setConditionalParentValueMetadata', 'document_id' => 'setDocumentId', 'document_id_metadata' => 'setDocumentIdMetadata', 'group_name' => 'setGroupName', 'group_name_metadata' => 'setGroupNameMetadata', 'original_value' => 'setOriginalValue', 'original_value_metadata' => 'setOriginalValueMetadata', 'radios' => 'setRadios', 'recipient_id' => 'setRecipientId', 'recipient_id_guid' => 'setRecipientIdGuid', 'recipient_id_guid_metadata' => 'setRecipientIdGuidMetadata', 'recipient_id_metadata' => 'setRecipientIdMetadata', 'require_all' => 'setRequireAll', 'require_all_metadata' => 'setRequireAllMetadata', 'require_initial_on_shared_change' => 'setRequireInitialOnSharedChange', 'require_initial_on_shared_change_metadata' => 'setRequireInitialOnSharedChangeMetadata', 'shared' => 'setShared', 'shared_metadata' => 'setSharedMetadata', 'share_to_recipients' => 'setShareToRecipients', 'share_to_recipients_metadata' => 'setShareToRecipientsMetadata', 'tab_type' => 'setTabType', 'tab_type_metadata' => 'setTabTypeMetadata', 'template_locked' => 'setTemplateLocked', 'template_locked_metadata' => 'setTemplateLockedMetadata', 'template_required' => 'setTemplateRequired', 'template_required_metadata' => 'setTemplateRequiredMetadata', 'tooltip' => 'setTooltip', 'tooltip_metadata' => 'setTooltipMetadata', 'value' => 'setValue', 'value_metadata' => 'setValueMetadata']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['conditional_parent_label' => null, 'conditional_parent_label_metadata' => null, 'conditional_parent_value' => null, 'conditional_parent_value_metadata' => null, 'document_id' => null, 'document_id_metadata' => null, 'group_name' => null, 'group_name_metadata' => null, 'original_value' => null, 'original_value_metadata' => null, 'radios' => null, 'recipient_id' => null, 'recipient_id_guid' => null, 'recipient_id_guid_metadata' => null, 'recipient_id_metadata' => null, 'require_all' => null, 'require_all_metadata' => null, 'require_initial_on_shared_change' => null, 'require_initial_on_shared_change_metadata' => null, 'shared' => null, 'shared_metadata' => null, 'share_to_recipients' => null, 'share_to_recipients_metadata' => null, 'tab_type' => null, 'tab_type_metadata' => null, 'template_locked' => null, 'template_locked_metadata' => null, 'template_required' => null, 'template_required_metadata' => null, 'tooltip' => null, 'tooltip_metadata' => null, 'value' => null, 'value_metadata' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'radioGroup'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['conditional_parent_label' => '?string', 'conditional_parent_label_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'conditional_parent_value' => '?string', 'conditional_parent_value_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'document_id' => '?string', 'document_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'group_name' => '?string', 'group_name_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'original_value' => '?string', 'original_value_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'radios' => '\\DocuSign\\eSign\\Model\\Radio[]', 'recipient_id' => '?string', 'recipient_id_guid' => '?string', 'recipient_id_guid_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'recipient_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'require_all' => '?string', 'require_all_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'require_initial_on_shared_change' => '?string', 'require_initial_on_shared_change_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'shared' => '?string', 'shared_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'share_to_recipients' => '?string', 'share_to_recipients_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_type' => '?string', 'tab_type_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'template_locked' => '?string', 'template_locked_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'template_required' => '?string', 'template_required_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tooltip' => '?string', 'tooltip_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'value' => '?string', 'value_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata']

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

getConditionalParentLabel()

Gets conditional_parent_label

public getConditionalParentLabel() : string|null
Return values
string|null —

getConditionalParentValue()

Gets conditional_parent_value

public getConditionalParentValue() : string|null
Return values
string|null —

getDocumentId()

Gets document_id

public getDocumentId() : string|null
Return values
string|null —

getGroupName()

Gets group_name

public getGroupName() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getOriginalValue()

Gets original_value

public getOriginalValue() : string|null
Return values
string|null —

getRadios()

Gets radios

public getRadios() : array<string|int, Radio>
Return values
array<string|int, Radio> —

getRecipientId()

Gets recipient_id

public getRecipientId() : string|null
Return values
string|null —

getRecipientIdGuid()

Gets recipient_id_guid

public getRecipientIdGuid() : string|null
Return values
string|null —

getRequireAll()

Gets require_all

public getRequireAll() : string|null
Return values
string|null —

getRequireInitialOnSharedChange()

Gets require_initial_on_shared_change

public getRequireInitialOnSharedChange() : string|null
Return values
string|null —

getShared()

Gets shared

public getShared() : string|null
Return values
string|null —

getShareToRecipients()

Gets share_to_recipients

public getShareToRecipients() : string|null
Return values
string|null —

getTabType()

Gets tab_type

public getTabType() : string|null
Return values
string|null —

getTemplateLocked()

Gets template_locked

public getTemplateLocked() : string|null
Return values
string|null —

getTemplateRequired()

Gets template_required

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

getTooltip()

Gets tooltip

public getTooltip() : string|null
Return values
string|null —

getValue()

Gets value

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

setConditionalParentLabel()

Sets conditional_parent_label

public setConditionalParentLabel(string|null $conditional_parent_label) : $this
Parameters
$conditional_parent_label : string|null

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

Return values
$this —

setConditionalParentLabelMetadata()

Sets conditional_parent_label_metadata

public setConditionalParentLabelMetadata(PropertyMetadata $conditional_parent_label_metadata) : $this
Parameters
$conditional_parent_label_metadata : PropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

Return values
$this —

setConditionalParentValue()

Sets conditional_parent_value

public setConditionalParentValue(string|null $conditional_parent_value) : $this
Parameters
$conditional_parent_value : string|null

For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

Return values
$this —

setConditionalParentValueMetadata()

Sets conditional_parent_value_metadata

public setConditionalParentValueMetadata(PropertyMetadata $conditional_parent_value_metadata) : $this
Parameters
$conditional_parent_value_metadata : PropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

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 —

setDocumentIdMetadata()

Sets document_id_metadata

public setDocumentIdMetadata(PropertyMetadata $document_id_metadata) : $this
Parameters
$document_id_metadata : PropertyMetadata

Metadata that indicates whether the documentId property is editable.

Return values
$this —

setGroupName()

Sets group_name

public setGroupName(string|null $group_name) : $this
Parameters
$group_name : string|null

The name of the group.

Return values
$this —

setGroupNameMetadata()

Sets group_name_metadata

public setGroupNameMetadata(PropertyMetadata $group_name_metadata) : $this
Parameters
$group_name_metadata : PropertyMetadata

Metadata that indicates whether the groupName property is editable.

Return values
$this —

setOriginalValue()

Sets original_value

public setOriginalValue(string|null $original_value) : $this
Parameters
$original_value : string|null

The initial value of the tab when it was sent to the recipient.

Return values
$this —

setOriginalValueMetadata()

Sets original_value_metadata

public setOriginalValueMetadata(PropertyMetadata $original_value_metadata) : $this
Parameters
$original_value_metadata : PropertyMetadata

Metadata that indicates whether the originalValue property is editable.

Return values
$this —

setRadios()

Sets radios

public setRadios(array<string|int, Radio> $radios) : $this
Parameters
$radios : array<string|int, Radio>

Specifies the locations and status for radio buttons that are grouped together.

Return values
$this —

setRecipientId()

Sets recipient_id

public setRecipientId(string|null $recipient_id) : $this
Parameters
$recipient_id : string|null

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Return values
$this —

setRecipientIdGuid()

Sets recipient_id_guid

public setRecipientIdGuid(string|null $recipient_id_guid) : $this
Parameters
$recipient_id_guid : string|null
Return values
$this —

setRecipientIdGuidMetadata()

Sets recipient_id_guid_metadata

public setRecipientIdGuidMetadata(PropertyMetadata $recipient_id_guid_metadata) : $this
Parameters
$recipient_id_guid_metadata : PropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

Return values
$this —

setRecipientIdMetadata()

Sets recipient_id_metadata

public setRecipientIdMetadata(PropertyMetadata $recipient_id_metadata) : $this
Parameters
$recipient_id_metadata : PropertyMetadata

Metadata that indicates whether the recipientId property is editable.

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 —

setRequireAllMetadata()

Sets require_all_metadata

public setRequireAllMetadata(PropertyMetadata $require_all_metadata) : $this
Parameters
$require_all_metadata : PropertyMetadata

Metadata that indicates whether the requireAll property is editable.

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 —

setRequireInitialOnSharedChangeMetadata()

Sets require_initial_on_shared_change_metadata

public setRequireInitialOnSharedChangeMetadata(PropertyMetadata $require_initial_on_shared_change_metadata) : $this
Parameters
$require_initial_on_shared_change_metadata : PropertyMetadata

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

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 —

setSharedMetadata()

Sets shared_metadata

public setSharedMetadata(PropertyMetadata $shared_metadata) : $this
Parameters
$shared_metadata : PropertyMetadata

Metadata that indicates whether the shared property is editable.

Return values
$this —

setShareToRecipients()

Sets share_to_recipients

public setShareToRecipients(string|null $share_to_recipients) : $this
Parameters
$share_to_recipients : string|null
Return values
$this —

setShareToRecipientsMetadata()

Sets share_to_recipients_metadata

public setShareToRecipientsMetadata(PropertyMetadata $share_to_recipients_metadata) : $this
Parameters
$share_to_recipients_metadata : PropertyMetadata

Reserved for DocuSign.

Return values
$this —

setTabType()

Sets tab_type

public setTabType(string|null $tab_type) : $this
Parameters
$tab_type : string|null
Return values
$this —

setTabTypeMetadata()

Sets tab_type_metadata

public setTabTypeMetadata(PropertyMetadata $tab_type_metadata) : $this
Parameters
$tab_type_metadata : PropertyMetadata

Metadata that indicates whether the tabType property is editable.

Return values
$this —

setTemplateLocked()

Sets template_locked

public setTemplateLocked(string|null $template_locked) : $this
Parameters
$template_locked : string|null

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

Return values
$this —

setTemplateLockedMetadata()

Sets template_locked_metadata

public setTemplateLockedMetadata(PropertyMetadata $template_locked_metadata) : $this
Parameters
$template_locked_metadata : PropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

Return values
$this —

setTemplateRequired()

Sets template_required

public setTemplateRequired(string|null $template_required) : $this
Parameters
$template_required : string|null

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

Return values
$this —

setTemplateRequiredMetadata()

Sets template_required_metadata

public setTemplateRequiredMetadata(PropertyMetadata $template_required_metadata) : $this
Parameters
$template_required_metadata : PropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

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

setTooltip()

Sets tooltip

public setTooltip(string|null $tooltip) : $this
Parameters
$tooltip : string|null
Return values
$this —

setTooltipMetadata()

Sets tooltip_metadata

public setTooltipMetadata(PropertyMetadata $tooltip_metadata) : $this
Parameters
$tooltip_metadata : PropertyMetadata

Metadata that indicates whether the tooltip property is editable.

Return values
$this —

setValue()

Sets value

public setValue(string|null $value) : $this
Parameters
$value : string|null

Specifies the value of the tab.

Return values
$this —

setValueMetadata()

Sets value_metadata

public setValueMetadata(PropertyMetadata $value_metadata) : $this
Parameters
$value_metadata : PropertyMetadata

Metadata that indicates whether the value property is editable.

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

Search results