Documentation

RecipientViewRequest
in package
implements ModelInterface, ArrayAccess

RecipientViewRequest Class Doc Comment

Tags
category

Class

description

The request body for the EnvelopeViews: createRecipient and EnvelopeViews: createSharedRecipient methods.

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
getAssertionId()  : string|null
Gets assertion_id
getAuthenticationInstant()  : string|null
Gets authentication_instant
getAuthenticationMethod()  : string|null
Gets authentication_method
getClientUrLs()  : RecipientTokenClientURLs
Gets client_ur_ls
getClientUserId()  : string|null
Gets client_user_id
getDisplayFormat()  : string|null
Gets display_format
getEmail()  : string|null
Gets email
getFrameAncestors()  : array<string|int, ?string>
Gets frame_ancestors
getMessageOrigins()  : array<string|int, ?string>
Gets message_origins
getModelName()  : string
The original name of the model.
getPingFrequency()  : string|null
Gets ping_frequency
getPingUrl()  : string|null
Gets ping_url
getRecipientId()  : string|null
Gets recipient_id
getReturnUrl()  : string|null
Gets return_url
getSecurityDomain()  : string|null
Gets security_domain
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUserId()  : string|null
Gets user_id
getUserName()  : string|null
Gets user_name
getXFrameOptions()  : string|null
Gets x_frame_options
getXFrameOptionsAllowFromUrl()  : string|null
Gets x_frame_options_allow_from_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.
setAssertionId()  : $this
Sets assertion_id
setAuthenticationInstant()  : $this
Sets authentication_instant
setAuthenticationMethod()  : $this
Sets authentication_method
setClientUrLs()  : $this
Sets client_ur_ls
setClientUserId()  : $this
Sets client_user_id
setDisplayFormat()  : $this
Sets display_format
setEmail()  : $this
Sets email
setFrameAncestors()  : $this
Sets frame_ancestors
setMessageOrigins()  : $this
Sets message_origins
setPingFrequency()  : $this
Sets ping_frequency
setPingUrl()  : $this
Sets ping_url
setRecipientId()  : $this
Sets recipient_id
setReturnUrl()  : $this
Sets return_url
setSecurityDomain()  : $this
Sets security_domain
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUserId()  : $this
Sets user_id
setUserName()  : $this
Sets user_name
setXFrameOptions()  : $this
Sets x_frame_options
setXFrameOptionsAllowFromUrl()  : $this
Sets x_frame_options_allow_from_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

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 = ['assertion_id' => 'assertionId', 'authentication_instant' => 'authenticationInstant', 'authentication_method' => 'authenticationMethod', 'client_ur_ls' => 'clientURLs', 'client_user_id' => 'clientUserId', 'display_format' => 'displayFormat', 'email' => 'email', 'frame_ancestors' => 'frameAncestors', 'message_origins' => 'messageOrigins', 'ping_frequency' => 'pingFrequency', 'ping_url' => 'pingUrl', 'recipient_id' => 'recipientId', 'return_url' => 'returnUrl', 'security_domain' => 'securityDomain', 'user_id' => 'userId', 'user_name' => 'userName', 'x_frame_options' => 'xFrameOptions', 'x_frame_options_allow_from_url' => 'xFrameOptionsAllowFromUrl']

$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 = ['assertion_id' => 'getAssertionId', 'authentication_instant' => 'getAuthenticationInstant', 'authentication_method' => 'getAuthenticationMethod', 'client_ur_ls' => 'getClientUrLs', 'client_user_id' => 'getClientUserId', 'display_format' => 'getDisplayFormat', 'email' => 'getEmail', 'frame_ancestors' => 'getFrameAncestors', 'message_origins' => 'getMessageOrigins', 'ping_frequency' => 'getPingFrequency', 'ping_url' => 'getPingUrl', 'recipient_id' => 'getRecipientId', 'return_url' => 'getReturnUrl', 'security_domain' => 'getSecurityDomain', 'user_id' => 'getUserId', 'user_name' => 'getUserName', 'x_frame_options' => 'getXFrameOptions', 'x_frame_options_allow_from_url' => 'getXFrameOptionsAllowFromUrl']

$setters

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

protected static array<string|int, string> $setters = ['assertion_id' => 'setAssertionId', 'authentication_instant' => 'setAuthenticationInstant', 'authentication_method' => 'setAuthenticationMethod', 'client_ur_ls' => 'setClientUrLs', 'client_user_id' => 'setClientUserId', 'display_format' => 'setDisplayFormat', 'email' => 'setEmail', 'frame_ancestors' => 'setFrameAncestors', 'message_origins' => 'setMessageOrigins', 'ping_frequency' => 'setPingFrequency', 'ping_url' => 'setPingUrl', 'recipient_id' => 'setRecipientId', 'return_url' => 'setReturnUrl', 'security_domain' => 'setSecurityDomain', 'user_id' => 'setUserId', 'user_name' => 'setUserName', 'x_frame_options' => 'setXFrameOptions', 'x_frame_options_allow_from_url' => 'setXFrameOptionsAllowFromUrl']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['assertion_id' => null, 'authentication_instant' => null, 'authentication_method' => null, 'client_ur_ls' => null, 'client_user_id' => null, 'display_format' => null, 'email' => null, 'frame_ancestors' => null, 'message_origins' => null, 'ping_frequency' => null, 'ping_url' => null, 'recipient_id' => null, 'return_url' => null, 'security_domain' => null, 'user_id' => null, 'user_name' => null, 'x_frame_options' => null, 'x_frame_options_allow_from_url' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'recipientViewRequest'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['assertion_id' => '?string', 'authentication_instant' => '?string', 'authentication_method' => '?string', 'client_ur_ls' => '\\DocuSign\\eSign\\Model\\RecipientTokenClientURLs', 'client_user_id' => '?string', 'display_format' => '?string', 'email' => '?string', 'frame_ancestors' => '?string[]', 'message_origins' => '?string[]', 'ping_frequency' => '?string', 'ping_url' => '?string', 'recipient_id' => '?string', 'return_url' => '?string', 'security_domain' => '?string', 'user_id' => '?string', 'user_name' => '?string', 'x_frame_options' => '?string', 'x_frame_options_allow_from_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> —

getAssertionId()

Gets assertion_id

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

getAuthenticationInstant()

Gets authentication_instant

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

getAuthenticationMethod()

Gets authentication_method

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

getClientUserId()

Gets client_user_id

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

getDisplayFormat()

Gets display_format

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

getFrameAncestors()

Gets frame_ancestors

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

getMessageOrigins()

Gets message_origins

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPingFrequency()

Gets ping_frequency

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

getPingUrl()

Gets ping_url

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

getRecipientId()

Gets recipient_id

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

getReturnUrl()

Gets return_url

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

getSecurityDomain()

Gets security_domain

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

getUserId()

Gets user_id

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

getUserName()

Gets user_name

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

getXFrameOptions()

Gets x_frame_options

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

getXFrameOptionsAllowFromUrl()

Gets x_frame_options_allow_from_url

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

setAssertionId()

Sets assertion_id

public setAssertionId(string|null $assertion_id) : $this
Parameters
$assertion_id : string|null

A unique identifier of the authentication event executed by the client application.

Return values
$this —

setAuthenticationInstant()

Sets authentication_instant

public setAuthenticationInstant(string|null $authentication_instant) : $this
Parameters
$authentication_instant : string|null

A sender generated value that indicates the date/time that the signer was authenticated.

Return values
$this —

setAuthenticationMethod()

Sets authentication_method

public setAuthenticationMethod(string|null $authentication_method) : $this
Parameters
$authentication_method : string|null

A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion.

Return values
$this —

setClientUserId()

Sets client_user_id

public setClientUserId(string|null $client_user_id) : $this
Parameters
$client_user_id : string|null

A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters.

Return values
$this —

setDisplayFormat()

Sets display_format

public setDisplayFormat(string|null $display_format) : $this
Parameters
$display_format : string|null
Return values
$this —

setEmail()

Sets email

public setEmail(string|null $email) : $this
Parameters
$email : string|null

Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.

Return values
$this —

setFrameAncestors()

Sets frame_ancestors

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

setMessageOrigins()

Sets message_origins

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

setPingFrequency()

Sets ping_frequency

public setPingFrequency(string|null $ping_frequency) : $this
Parameters
$ping_frequency : string|null

Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.

Return values
$this —

setPingUrl()

Sets ping_url

public setPingUrl(string|null $ping_url) : $this
Parameters
$ping_url : string|null

A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received.

Return values
$this —

setRecipientId()

Sets recipient_id

public setRecipientId(string|null $recipient_id) : $this
Parameters
$recipient_id : string|null

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Return values
$this —

setReturnUrl()

Sets return_url

public setReturnUrl(string|null $return_url) : $this
Parameters
$return_url : string|null

The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.

Return values
$this —

setSecurityDomain()

Sets security_domain

public setSecurityDomain(string|null $security_domain) : $this
Parameters
$security_domain : string|null

The domain in which the user authenticated.

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

setUserId()

Sets user_id

public setUserId(string|null $user_id) : $this
Parameters
$user_id : string|null

Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the userId property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user.

Return values
$this —

setUserName()

Sets user_name

public setUserName(string|null $user_name) : $this
Parameters
$user_name : string|null

Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.

Return values
$this —

setXFrameOptions()

Sets x_frame_options

public setXFrameOptions(string|null $x_frame_options) : $this
Parameters
$x_frame_options : string|null
Return values
$this —

setXFrameOptionsAllowFromUrl()

Sets x_frame_options_allow_from_url

public setXFrameOptionsAllowFromUrl(string|null $x_frame_options_allow_from_url) : $this
Parameters
$x_frame_options_allow_from_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

Search results