Documentation

RecipientSignatureInformation
in package
implements ModelInterface, ArrayAccess

RecipientSignatureInformation Class Doc Comment

Tags
category

Class

description

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.

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
getFontStyle()  : string|null
Gets font_style
getModelName()  : string
The original name of the model.
getSignatureInitials()  : string|null
Gets signature_initials
getSignatureName()  : string|null
Gets signature_name
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.
setFontStyle()  : $this
Sets font_style
setSignatureInitials()  : $this
Sets signature_initials
setSignatureName()  : $this
Sets signature_name
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

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 = ['font_style' => 'fontStyle', 'signature_initials' => 'signatureInitials', 'signature_name' => 'signatureName']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['font_style' => 'getFontStyle', 'signature_initials' => 'getSignatureInitials', 'signature_name' => 'getSignatureName']

$setters

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

protected static array<string|int, string> $setters = ['font_style' => 'setFontStyle', 'signature_initials' => 'setSignatureInitials', 'signature_name' => 'setSignatureName']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['font_style' => null, 'signature_initials' => null, 'signature_name' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'recipientSignatureInformation'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['font_style' => '?string', 'signature_initials' => '?string', 'signature_name' => '?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 —

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

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 —

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 —

setFontStyle()

Sets font_style

public setFontStyle(string|null $font_style) : $this
Parameters
$font_style : string|null
Return values
$this —

setSignatureInitials()

Sets signature_initials

public setSignatureInitials(string|null $signature_initials) : $this
Parameters
$signature_initials : string|null
Return values
$this —

setSignatureName()

Sets signature_name

public setSignatureName(string|null $signature_name) : $this
Parameters
$signature_name : string|null

Specifies the user signature name.

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

Search results