CorrectViewRequest
in package
implements
ModelInterface, ArrayAccess
CorrectViewRequest Class Doc Comment
Tags
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
- getBeginOnTagger() : string|null
- Gets begin_on_tagger
- getModelName() : string
- The original name of the model.
- getReturnUrl() : string|null
- Gets return_url
- getSuppressNavigation() : string|null
- Gets suppress_navigation
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getViewUrl() : string|null
- Gets view_url
- 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.
- setBeginOnTagger() : $this
- Sets begin_on_tagger
- setReturnUrl() : $this
- Sets return_url
- setSuppressNavigation() : $this
- Sets suppress_navigation
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setViewUrl() : $this
- Sets view_url
- 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
= ['begin_on_tagger' => 'beginOnTagger', 'return_url' => 'returnUrl', 'suppress_navigation' => 'suppressNavigation', 'view_url' => 'viewUrl']
$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
= ['begin_on_tagger' => 'getBeginOnTagger', 'return_url' => 'getReturnUrl', 'suppress_navigation' => 'getSuppressNavigation', 'view_url' => 'getViewUrl']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['begin_on_tagger' => 'setBeginOnTagger', 'return_url' => 'setReturnUrl', 'suppress_navigation' => 'setSuppressNavigation', 'view_url' => 'setViewUrl']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['begin_on_tagger' => null, 'return_url' => null, 'suppress_navigation' => null, 'view_url' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'correctViewRequest'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['begin_on_tagger' => '?string', 'return_url' => '?string', 'suppress_navigation' => '?string', 'view_url' => '?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> —getBeginOnTagger()
Gets begin_on_tagger
public
getBeginOnTagger() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getReturnUrl()
Gets return_url
public
getReturnUrl() : string|null
Return values
string|null —getSuppressNavigation()
Gets suppress_navigation
public
getSuppressNavigation() : 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> —getViewUrl()
Gets view_url
public
getViewUrl() : 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 —setBeginOnTagger()
Sets begin_on_tagger
public
setBeginOnTagger(string|null $begin_on_tagger) : $this
Parameters
- $begin_on_tagger : string|null
Return values
$this —setReturnUrl()
Sets return_url
public
setReturnUrl(string|null $return_url) : $this
Parameters
- $return_url : string|null
-
The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are: * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.
Return values
$this —setSuppressNavigation()
Sets suppress_navigation
public
setSuppressNavigation(string|null $suppress_navigation) : $this
Parameters
- $suppress_navigation : string|null
-
Specifies whether the window is displayed with or without dressing.
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> —setViewUrl()
Sets view_url
public
setViewUrl(string|null $view_url) : $this
Parameters
- $view_url : string|null
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