CloudStorageProvider
in package
implements
ModelInterface, ArrayAccess
CloudStorageProvider 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
- getAuthenticationUrl() : string|null
- Gets authentication_url
- getErrorDetails() : ErrorDetails
- Gets error_details
- getModelName() : string
- The original name of the model.
- getRedirectUrl() : string|null
- Gets redirect_url
- getService() : string|null
- Gets service
- getServiceId() : string|null
- Gets service_id
- 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.
- setAuthenticationUrl() : $this
- Sets authentication_url
- setErrorDetails() : $this
- Sets error_details
- setRedirectUrl() : $this
- Sets redirect_url
- setService() : $this
- Sets service
- setServiceId() : $this
- Sets service_id
- 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
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
= ['authentication_url' => 'authenticationUrl', 'error_details' => 'errorDetails', 'redirect_url' => 'redirectUrl', 'service' => 'service', 'service_id' => 'serviceId']
$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
= ['authentication_url' => 'getAuthenticationUrl', 'error_details' => 'getErrorDetails', 'redirect_url' => 'getRedirectUrl', 'service' => 'getService', 'service_id' => 'getServiceId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['authentication_url' => 'setAuthenticationUrl', 'error_details' => 'setErrorDetails', 'redirect_url' => 'setRedirectUrl', 'service' => 'setService', 'service_id' => 'setServiceId']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['authentication_url' => null, 'error_details' => null, 'redirect_url' => null, 'service' => null, 'service_id' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'cloudStorageProvider'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['authentication_url' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'redirect_url' => '?string', 'service' => '?string', 'service_id' => '?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> —getAuthenticationUrl()
Gets authentication_url
public
getAuthenticationUrl() : string|null
Return values
string|null —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRedirectUrl()
Gets redirect_url
public
getRedirectUrl() : string|null
Return values
string|null —getService()
Gets service
public
getService() : string|null
Return values
string|null —getServiceId()
Gets service_id
public
getServiceId() : 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 —setAuthenticationUrl()
Sets authentication_url
public
setAuthenticationUrl(string|null $authentication_url) : $this
Parameters
- $authentication_url : string|null
-
The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl.
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setRedirectUrl()
Sets redirect_url
public
setRedirectUrl(string|null $redirect_url) : $this
Parameters
- $redirect_url : string|null
-
The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.
Return values
$this —setService()
Sets service
public
setService(string|null $service) : $this
Parameters
- $service : string|null
-
The service name for the cloud storage provider.
Return values
$this —setServiceId()
Sets service_id
public
setServiceId(string|null $service_id) : $this
Parameters
- $service_id : string|null
-
The DocuSign generated ID for the cloud storage provider
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