This request object contains the information necessary to create a recipient preview. More...

Inheritance diagram for DocuSign.eSign.Model.RecipientPreviewRequest:

Public Member Functions
	RecipientPreviewRequest (string AssertionId=default(string), string AuthenticationInstant=default(string), string AuthenticationMethod=default(string), RecipientTokenClientURLs ClientURLs=default(RecipientTokenClientURLs), string PingFrequency=default(string), string PingUrl=default(string), string RecipientId=default(string), string ReturnUrl=default(string), string SecurityDomain=default(string), string XFrameOptions=default(string), string XFrameOptionsAllowFromUrl=default(string))
	Initializes a new instance of the RecipientPreviewRequest class. More...

override string	ToString ()
	Returns the string presentation of the object More...

string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object obj)
	Returns true if objects are equal More...

bool	Equals (RecipientPreviewRequest other)
	Returns true if RecipientPreviewRequest instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	AssertionId `[get, set]`
	Gets or Sets AssertionId More...

string	AuthenticationInstant `[get, set]`
	Gets or Sets AuthenticationInstant More...

string	AuthenticationMethod `[get, set]`
	Gets or Sets AuthenticationMethod More...

RecipientTokenClientURLs	ClientURLs `[get, set]`
	Gets or Sets ClientURLs More...

string	PingFrequency `[get, set]`
	Gets or Sets PingFrequency More...

string	PingUrl `[get, set]`
	Gets or Sets PingUrl More...

string	RecipientId `[get, set]`
	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. More...

string	ReturnUrl `[get, set]`
	Gets or Sets ReturnUrl More...

string	SecurityDomain `[get, set]`
	Gets or Sets SecurityDomain More...

string	XFrameOptions `[get, set]`
	Gets or Sets XFrameOptions More...

string	XFrameOptionsAllowFromUrl `[get, set]`
	Gets or Sets XFrameOptionsAllowFromUrl More...

Detailed Description

This request object contains the information necessary to create a recipient preview.

Constructor & Destructor Documentation

◆ RecipientPreviewRequest()

DocuSign.eSign.Model.RecipientPreviewRequest.RecipientPreviewRequest	(	string	AssertionId = `default(string)`,
		string	AuthenticationInstant = `default(string)`,
		string	AuthenticationMethod = `default(string)`,
		RecipientTokenClientURLs	ClientURLs = `default(RecipientTokenClientURLs)`,
		string	PingFrequency = `default(string)`,
		string	PingUrl = `default(string)`,
		string	RecipientId = `default(string)`,
		string	ReturnUrl = `default(string)`,
		string	SecurityDomain = `default(string)`,
		string	XFrameOptions = `default(string)`,
		string	XFrameOptionsAllowFromUrl = `default(string)`
	)

inline

Initializes a new instance of the RecipientPreviewRequest class.

Parameters

AssertionId	AssertionId.
AuthenticationInstant	AuthenticationInstant.
AuthenticationMethod	AuthenticationMethod.
ClientURLs	ClientURLs.
PingFrequency	PingFrequency.
PingUrl	PingUrl.
RecipientId	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
ReturnUrl	ReturnUrl.
SecurityDomain	SecurityDomain.
XFrameOptions	XFrameOptions.
XFrameOptionsAllowFromUrl	XFrameOptionsAllowFromUrl.

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.RecipientPreviewRequest.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.RecipientPreviewRequest.Equals ( RecipientPreviewRequest other )

inline

Returns true if RecipientPreviewRequest instances are equal

Parameters

other Instance of RecipientPreviewRequest to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.RecipientPreviewRequest.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.RecipientPreviewRequest.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.RecipientPreviewRequest.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AssertionId

string DocuSign.eSign.Model.RecipientPreviewRequest.AssertionId

getset

Gets or Sets AssertionId

◆ AuthenticationInstant

string DocuSign.eSign.Model.RecipientPreviewRequest.AuthenticationInstant

getset

Gets or Sets AuthenticationInstant

◆ AuthenticationMethod

string DocuSign.eSign.Model.RecipientPreviewRequest.AuthenticationMethod

getset

Gets or Sets AuthenticationMethod

◆ ClientURLs

RecipientTokenClientURLs DocuSign.eSign.Model.RecipientPreviewRequest.ClientURLs

getset

Gets or Sets ClientURLs

◆ PingFrequency

string DocuSign.eSign.Model.RecipientPreviewRequest.PingFrequency

getset

Gets or Sets PingFrequency

◆ PingUrl

string DocuSign.eSign.Model.RecipientPreviewRequest.PingUrl

getset

Gets or Sets PingUrl

◆ RecipientId

string DocuSign.eSign.Model.RecipientPreviewRequest.RecipientId

getset

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

◆ ReturnUrl

string DocuSign.eSign.Model.RecipientPreviewRequest.ReturnUrl

getset

Gets or Sets ReturnUrl

◆ SecurityDomain

string DocuSign.eSign.Model.RecipientPreviewRequest.SecurityDomain

getset

Gets or Sets SecurityDomain

◆ XFrameOptions

string DocuSign.eSign.Model.RecipientPreviewRequest.XFrameOptions

getset

Gets or Sets XFrameOptions

◆ XFrameOptionsAllowFromUrl

string DocuSign.eSign.Model.RecipientPreviewRequest.XFrameOptionsAllowFromUrl

getset

Gets or Sets XFrameOptionsAllowFromUrl

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Model/RecipientPreviewRequest.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RecipientPreviewRequest()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AssertionId

◆ AuthenticationInstant

◆ AuthenticationMethod

◆ ClientURLs

◆ PingFrequency

◆ PingUrl

◆ RecipientId

◆ ReturnUrl

◆ SecurityDomain

◆ XFrameOptions

◆ XFrameOptionsAllowFromUrl