Documentation

Comment
in package
implements ModelInterface, ArrayAccess

Comment Class Doc Comment

Tags
category

Class

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
getEnvelopeId()  : string|null
Gets envelope_id
getHmac()  : string|null
Gets hmac
getId()  : string|null
Gets id
getMentions()  : array<string|int, ?string>
Gets mentions
getModelName()  : string
The original name of the model.
getRead()  : bool|null
Gets read
getSentByEmail()  : string|null
Gets sent_by_email
getSentByFullName()  : string|null
Gets sent_by_full_name
getSentByImageId()  : string|null
Gets sent_by_image_id
getSentByInitials()  : string|null
Gets sent_by_initials
getSentByRecipientId()  : string|null
Gets sent_by_recipient_id
getSentByUserId()  : string|null
Gets sent_by_user_id
getSigningGroupId()  : string|null
Gets signing_group_id
getSigningGroupName()  : string|null
Gets signing_group_name
getSubject()  : string|null
Gets subject
getTabId()  : string|null
Gets tab_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getText()  : string|null
Gets text
getThreadId()  : string|null
Gets thread_id
getThreadOriginatorId()  : string|null
Gets thread_originator_id
getTimestamp()  : string|null
Gets timestamp
getTimeStampFormatted()  : string|null
Gets time_stamp_formatted
getVisibleTo()  : array<string|int, ?string>
Gets visible_to
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.
setEnvelopeId()  : $this
Sets envelope_id
setHmac()  : $this
Sets hmac
setId()  : $this
Sets id
setMentions()  : $this
Sets mentions
setRead()  : $this
Sets read
setSentByEmail()  : $this
Sets sent_by_email
setSentByFullName()  : $this
Sets sent_by_full_name
setSentByImageId()  : $this
Sets sent_by_image_id
setSentByInitials()  : $this
Sets sent_by_initials
setSentByRecipientId()  : $this
Sets sent_by_recipient_id
setSentByUserId()  : $this
Sets sent_by_user_id
setSigningGroupId()  : $this
Sets signing_group_id
setSigningGroupName()  : $this
Sets signing_group_name
setSubject()  : $this
Sets subject
setTabId()  : $this
Sets tab_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setText()  : $this
Sets text
setThreadId()  : $this
Sets thread_id
setThreadOriginatorId()  : $this
Sets thread_originator_id
setTimestamp()  : $this
Sets timestamp
setTimeStampFormatted()  : $this
Sets time_stamp_formatted
setVisibleTo()  : $this
Sets visible_to
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 = ['envelope_id' => 'envelopeId', 'hmac' => 'hmac', 'id' => 'id', 'mentions' => 'mentions', 'read' => 'read', 'sent_by_email' => 'sentByEmail', 'sent_by_full_name' => 'sentByFullName', 'sent_by_image_id' => 'sentByImageId', 'sent_by_initials' => 'sentByInitials', 'sent_by_recipient_id' => 'sentByRecipientId', 'sent_by_user_id' => 'sentByUserId', 'signing_group_id' => 'signingGroupId', 'signing_group_name' => 'signingGroupName', 'subject' => 'subject', 'tab_id' => 'tabId', 'text' => 'text', 'thread_id' => 'threadId', 'thread_originator_id' => 'threadOriginatorId', 'timestamp' => 'timestamp', 'time_stamp_formatted' => 'timeStampFormatted', 'visible_to' => 'visibleTo']

$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 = ['envelope_id' => 'getEnvelopeId', 'hmac' => 'getHmac', 'id' => 'getId', 'mentions' => 'getMentions', 'read' => 'getRead', 'sent_by_email' => 'getSentByEmail', 'sent_by_full_name' => 'getSentByFullName', 'sent_by_image_id' => 'getSentByImageId', 'sent_by_initials' => 'getSentByInitials', 'sent_by_recipient_id' => 'getSentByRecipientId', 'sent_by_user_id' => 'getSentByUserId', 'signing_group_id' => 'getSigningGroupId', 'signing_group_name' => 'getSigningGroupName', 'subject' => 'getSubject', 'tab_id' => 'getTabId', 'text' => 'getText', 'thread_id' => 'getThreadId', 'thread_originator_id' => 'getThreadOriginatorId', 'timestamp' => 'getTimestamp', 'time_stamp_formatted' => 'getTimeStampFormatted', 'visible_to' => 'getVisibleTo']

$setters

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

protected static array<string|int, string> $setters = ['envelope_id' => 'setEnvelopeId', 'hmac' => 'setHmac', 'id' => 'setId', 'mentions' => 'setMentions', 'read' => 'setRead', 'sent_by_email' => 'setSentByEmail', 'sent_by_full_name' => 'setSentByFullName', 'sent_by_image_id' => 'setSentByImageId', 'sent_by_initials' => 'setSentByInitials', 'sent_by_recipient_id' => 'setSentByRecipientId', 'sent_by_user_id' => 'setSentByUserId', 'signing_group_id' => 'setSigningGroupId', 'signing_group_name' => 'setSigningGroupName', 'subject' => 'setSubject', 'tab_id' => 'setTabId', 'text' => 'setText', 'thread_id' => 'setThreadId', 'thread_originator_id' => 'setThreadOriginatorId', 'timestamp' => 'setTimestamp', 'time_stamp_formatted' => 'setTimeStampFormatted', 'visible_to' => 'setVisibleTo']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['envelope_id' => null, 'hmac' => null, 'id' => null, 'mentions' => null, 'read' => null, 'sent_by_email' => null, 'sent_by_full_name' => null, 'sent_by_image_id' => null, 'sent_by_initials' => null, 'sent_by_recipient_id' => null, 'sent_by_user_id' => null, 'signing_group_id' => null, 'signing_group_name' => null, 'subject' => null, 'tab_id' => null, 'text' => null, 'thread_id' => null, 'thread_originator_id' => null, 'timestamp' => null, 'time_stamp_formatted' => null, 'visible_to' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'comment'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['envelope_id' => '?string', 'hmac' => '?string', 'id' => '?string', 'mentions' => '?string[]', 'read' => '?bool', 'sent_by_email' => '?string', 'sent_by_full_name' => '?string', 'sent_by_image_id' => '?string', 'sent_by_initials' => '?string', 'sent_by_recipient_id' => '?string', 'sent_by_user_id' => '?string', 'signing_group_id' => '?string', 'signing_group_name' => '?string', 'subject' => '?string', 'tab_id' => '?string', 'text' => '?string', 'thread_id' => '?string', 'thread_originator_id' => '?string', 'timestamp' => '?string', 'time_stamp_formatted' => '?string', 'visible_to' => '?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> —

getEnvelopeId()

Gets envelope_id

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

getHmac()

Gets hmac

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

getId()

Gets id

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

getMentions()

Gets mentions

public getMentions() : array<string|int, ?string>
Return values
array<string|int, ?string> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getRead()

Gets read

public getRead() : bool|null
Return values
bool|null —

getSentByEmail()

Gets sent_by_email

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

getSentByFullName()

Gets sent_by_full_name

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

getSentByImageId()

Gets sent_by_image_id

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

getSentByInitials()

Gets sent_by_initials

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

getSentByRecipientId()

Gets sent_by_recipient_id

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

getSentByUserId()

Gets sent_by_user_id

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

getSigningGroupId()

Gets signing_group_id

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

getSigningGroupName()

Gets signing_group_name

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

getSubject()

Gets subject

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

getTabId()

Gets tab_id

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

getText()

Gets text

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

getThreadId()

Gets thread_id

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

getThreadOriginatorId()

Gets thread_originator_id

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

getTimestamp()

Gets timestamp

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

getTimeStampFormatted()

Gets time_stamp_formatted

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

getVisibleTo()

Gets visible_to

public getVisibleTo() : array<string|int, ?string>
Return values
array<string|int, ?string> —

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 —

setEnvelopeId()

Sets envelope_id

public setEnvelopeId(string|null $envelope_id) : $this
Parameters
$envelope_id : string|null

The envelope ID of the envelope status that failed to post.

Return values
$this —

setHmac()

Sets hmac

public setHmac(string|null $hmac) : $this
Parameters
$hmac : string|null
Return values
$this —

setId()

Sets id

public setId(string|null $id) : $this
Parameters
$id : string|null
Return values
$this —

setMentions()

Sets mentions

public setMentions(array<string|int, ?string> $mentions) : $this
Parameters
$mentions : array<string|int, ?string>
Return values
$this —

setRead()

Sets read

public setRead(bool|null $read) : $this
Parameters
$read : bool|null
Return values
$this —

setSentByEmail()

Sets sent_by_email

public setSentByEmail(string|null $sent_by_email) : $this
Parameters
$sent_by_email : string|null
Return values
$this —

setSentByFullName()

Sets sent_by_full_name

public setSentByFullName(string|null $sent_by_full_name) : $this
Parameters
$sent_by_full_name : string|null
Return values
$this —

setSentByImageId()

Sets sent_by_image_id

public setSentByImageId(string|null $sent_by_image_id) : $this
Parameters
$sent_by_image_id : string|null
Return values
$this —

setSentByInitials()

Sets sent_by_initials

public setSentByInitials(string|null $sent_by_initials) : $this
Parameters
$sent_by_initials : string|null
Return values
$this —

setSentByRecipientId()

Sets sent_by_recipient_id

public setSentByRecipientId(string|null $sent_by_recipient_id) : $this
Parameters
$sent_by_recipient_id : string|null
Return values
$this —

setSentByUserId()

Sets sent_by_user_id

public setSentByUserId(string|null $sent_by_user_id) : $this
Parameters
$sent_by_user_id : string|null
Return values
$this —

setSigningGroupId()

Sets signing_group_id

public setSigningGroupId(string|null $signing_group_id) : $this
Parameters
$signing_group_id : string|null

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).

Return values
$this —

setSigningGroupName()

Sets signing_group_name

public setSigningGroupName(string|null $signing_group_name) : $this
Parameters
$signing_group_name : string|null

The display name for the signing group. Maximum Length: 100 characters.

Return values
$this —

setSubject()

Sets subject

public setSubject(string|null $subject) : $this
Parameters
$subject : string|null
Return values
$this —

setTabId()

Sets tab_id

public setTabId(string|null $tab_id) : $this
Parameters
$tab_id : string|null

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].

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

setText()

Sets text

public setText(string|null $text) : $this
Parameters
$text : string|null
Return values
$this —

setThreadId()

Sets thread_id

public setThreadId(string|null $thread_id) : $this
Parameters
$thread_id : string|null
Return values
$this —

setThreadOriginatorId()

Sets thread_originator_id

public setThreadOriginatorId(string|null $thread_originator_id) : $this
Parameters
$thread_originator_id : string|null
Return values
$this —

setTimestamp()

Sets timestamp

public setTimestamp(string|null $timestamp) : $this
Parameters
$timestamp : string|null
Return values
$this —

setTimeStampFormatted()

Sets time_stamp_formatted

public setTimeStampFormatted(string|null $time_stamp_formatted) : $this
Parameters
$time_stamp_formatted : string|null
Return values
$this —

setVisibleTo()

Sets visible_to

public setVisibleTo(array<string|int, ?string> $visible_to) : $this
Parameters
$visible_to : array<string|int, ?string>
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