Provides methods for working with SignDoc templates and packages. More...

Public Member Functions
void	DeleteSigningPackage (string sessionId, IntegrationSiteDetails signDocSite, string packageId)
	Deletes the signing package in SignDoc used to capture the document signature(s) of one of more users. More...

GeneratedDocumentTemplateSettings	GetGeneratedDocumentTemplate (string sessionId, IntegrationSiteIdentity2 signDocSite, string documentTemplateName)
	Gets a generated document template definition stored in KTA for use in a SignDoc activity. More...

SignDocTemplateSettings	GetSignDocTemplate (string sessionId, IntegrationSiteIdentity2 signDocSite, SignDocTemplateIdentity templateIdentity)
	Gets a document template definition from SignDoc. A document template defines how signing is configured for one or more documents. More...

SignDocTemplateIdentityCollection	GetSignDocTemplates (string sessionId, IntegrationSiteIdentity2 signDocSite)
	Get the list of available document templates from SignDoc. More...

Description

Provides methods for working with SignDoc templates and packages.

Member Functions

void DeleteSigningPackage	(	string	sessionId,
		IntegrationSiteDetails	signDocSite,
		string	packageId
	)

Deletes the signing package in SignDoc used to capture the document signature(s) of one of more users.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

signDocSite

A IntegrationSiteDetails object containing the details of sign document site.

Name	Type	Comment	Required
Name	string	A string that identifies the signing server Name. If Id is blank then signing server Name will be used for search.	No
Id	string	A string that uniquely identifies the signing server. If Id and Name both are blank or invalid then exception will be raised.	No

packageId A string that uniquely identifies the signing package. If the is invalid then an exception will be raised.

Security: No restrictions apply.

GeneratedDocumentTemplateSettings GetGeneratedDocumentTemplate	(	string	sessionId,
		IntegrationSiteIdentity2	signDocSite,
		string	documentTemplateName
	)

Gets a generated document template definition stored in KTA for use in a SignDoc activity.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

signDocSite

A IntegrationSiteIdentity2 object containing the identity of sign document site.

Name	Type	Comment	Required
Name	string	A string that identifies the signing server Name. If Id is blank then signing server Name will be used for search.	No
Id	string	A string that uniquely identifies the signing server. If Id and Name both are blank or invalid then exception will be raised.	No
AddInId	Identity	An IntegrationAddInIdentity object describing the SignDoc integration site add-in identity	No
Location	string	Gets or sets the location	No
categoryIdentity	Identity	Gets or sets the sites category	No

documentTemplateName Name of the document template.

Returns

A GeneratedDocumentTemplateSettings object containing the settings for the specified generated SignDoc docemnt template.

Name	Type	Comment
DocumentTemplateName	string	The document template name
Recipients	Collection	A collection of DocumentRecipient objects identifying the document signers
InputDocument	Identity	The VariableIdentity identifying the document variable
SigningMethods	Collection	A collection of SigningMethodFilters. See Remarks for more details
SigningOrder	Int16	Indicates the roder for the signing
EmailSubject	DynamicInlineText	Subject of generated email
EmailBody	DynamicInlineText	Body of generated email

Remarks

The enumeration for SigningMethodType member of the SigningMethodFilter setting follows.

Enumeration	Description
0	Click2Sign
1	Photo
2	Handwritten

Security: No restrictions apply.

SignDocTemplateSettings GetSignDocTemplate	(	string	sessionId,
		IntegrationSiteIdentity2	signDocSite,
		SignDocTemplateIdentity	templateIdentity
	)

Gets a document template definition from SignDoc. A document template defines how signing is configured for one or more documents.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

signDocSite

A IntegrationSiteIdentity2 object containing the identity of sign document site.

Name	Type	Comment	Required
Name	string	A string that identifies the signing server Name. If Id is blank then signing server Name will be used for search.	No
Id	string	A string that uniquely identifies the signing server. If Id and Name both are blank or invalid then exception will be raised.	No
AddInId	Identity	An IntegrationAddInIdentity object describing the SignDoc integration site add-in identity	No
Location	string	Gets or sets the location	No
categoryIdentity	Identity	Gets or sets the sites category	No

templateIdentity

The template identity.

Name	Type	Comment
Id	String	SignDoc template Id
Name	String	SignDoc template Name

Returns

A SignDocTemplateSettings object containing the settings for the specified SignDoc template.

Name	Type	Comment
Template	Identity	The SignDocTemplateIdentity object
Recipients	Collection	A collection of DocumentRecipient objects identifying the document signers
Documents	Collection	A collection of SigningDocument documents
EmailSubject	DynamicInlineText	Subject of generated email
EmailBody	DynamicInlineText	Body of generated email

Security: No restrictions apply.

SignDocTemplateIdentityCollection GetSignDocTemplates	(	string	sessionId,
		IntegrationSiteIdentity2	signDocSite
	)

Get the list of available document templates from SignDoc.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

signDocSite

A IntegrationSiteIdentity2 object containing the identity of sign document site.

Name	Type	Comment	Required
Name	string	A string that identifies the signing server Name. If Id is blank then signing server Name will be used for search.	No
Id	string	A string that uniquely identifies the signing server. If Id and Name both are blank or invalid then exception will be raised.	No
AddInId	Identity	An IntegrationAddInIdentity object describing the SignDoc integration site add-in identity	No
Location	string	Gets or sets the location	No
categoryIdentity	Identity	Gets or sets the sites category	No

Returns

A collection of type SignDocTemplateIdentity identifying the templates.

Name	Type	Comment
Id	String	SignDoc template Id
Name	String	SignDoc template Name

Security: No restrictions apply.

Public Member Functions

Description

Member Functions