Documentation

OfflineAttributes
in package
implements ModelInterface, ArrayAccess

OfflineAttributes Class Doc Comment

Tags
category

Class

description

DocuSign internal use, but it is needed for swagger tools (go lang, Elixir/OTP) to generate client library.

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
getAccountEsignId()  : string|null
Gets account_esign_id
getDeviceModel()  : string|null
Gets device_model
getDeviceName()  : string|null
Gets device_name
getGpsLatitude()  : string|null
Gets gps_latitude
getGpsLongitude()  : string|null
Gets gps_longitude
getModelName()  : string
The original name of the model.
getOfflineSigningHash()  : string|null
Gets offline_signing_hash
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.
setAccountEsignId()  : $this
Sets account_esign_id
setDeviceModel()  : $this
Sets device_model
setDeviceName()  : $this
Sets device_name
setGpsLatitude()  : $this
Sets gps_latitude
setGpsLongitude()  : $this
Sets gps_longitude
setOfflineSigningHash()  : $this
Sets offline_signing_hash
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 = ['account_esign_id' => 'accountEsignId', 'device_model' => 'deviceModel', 'device_name' => 'deviceName', 'gps_latitude' => 'gpsLatitude', 'gps_longitude' => 'gpsLongitude', 'offline_signing_hash' => 'offlineSigningHash']

$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 = ['account_esign_id' => 'getAccountEsignId', 'device_model' => 'getDeviceModel', 'device_name' => 'getDeviceName', 'gps_latitude' => 'getGpsLatitude', 'gps_longitude' => 'getGpsLongitude', 'offline_signing_hash' => 'getOfflineSigningHash']

$setters

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

protected static array<string|int, string> $setters = ['account_esign_id' => 'setAccountEsignId', 'device_model' => 'setDeviceModel', 'device_name' => 'setDeviceName', 'gps_latitude' => 'setGpsLatitude', 'gps_longitude' => 'setGpsLongitude', 'offline_signing_hash' => 'setOfflineSigningHash']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['account_esign_id' => null, 'device_model' => null, 'device_name' => null, 'gps_latitude' => null, 'gps_longitude' => null, 'offline_signing_hash' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'offlineAttributes'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['account_esign_id' => '?string', 'device_model' => '?string', 'device_name' => '?string', 'gps_latitude' => '?string', 'gps_longitude' => '?string', 'offline_signing_hash' => '?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>

getAccountEsignId()

Gets account_esign_id

public getAccountEsignId() : string|null
Return values
string|null

getDeviceModel()

Gets device_model

public getDeviceModel() : string|null
Return values
string|null

getDeviceName()

Gets device_name

public getDeviceName() : string|null
Return values
string|null

getGpsLatitude()

Gets gps_latitude

public getGpsLatitude() : string|null
Return values
string|null

getGpsLongitude()

Gets gps_longitude

public getGpsLongitude() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getOfflineSigningHash()

Gets offline_signing_hash

public getOfflineSigningHash() : string|null
Return values
string|null

getters()

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

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void

setAccountEsignId()

Sets account_esign_id

public setAccountEsignId(string|null $account_esign_id) : $this
Parameters
$account_esign_id : string|null

A GUID identifying the account associated with the consumer disclosure

Return values
$this

setDeviceModel()

Sets device_model

public setDeviceModel(string|null $device_model) : $this
Parameters
$device_model : string|null

A string containing information about the model of the device used for offline signing.

Return values
$this

setDeviceName()

Sets device_name

public setDeviceName(string|null $device_name) : $this
Parameters
$device_name : string|null

A string containing information about the type of device used for offline signing.

Return values
$this

setGpsLatitude()

Sets gps_latitude

public setGpsLatitude(string|null $gps_latitude) : $this
Parameters
$gps_latitude : string|null

A string containing the latitude of the device location at the time of signing.

Return values
$this

setGpsLongitude()

Sets gps_longitude

public setGpsLongitude(string|null $gps_longitude) : $this
Parameters
$gps_longitude : string|null

A string containing the longitude of the device location at the time of signing.

Return values
$this

setOfflineSigningHash()

Sets offline_signing_hash

public setOfflineSigningHash(string|null $offline_signing_hash) : $this
Parameters
$offline_signing_hash : string|null
Return values
$this

setters()

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

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

swaggerFormats()

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

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

swaggerTypes()

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

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool

True if all properties are valid

Search results