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... | |
GeneratedDocumentTemplateSettings2 | GetGeneratedDocumentTemplate2 (string sessionId, IntegrationSiteIdentity2 signDocSite, string documentTemplateName) |
Gets the generated document template. 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... | |
SignDocTemplateSettings2 | GetSignDocTemplate2 (string sessionId, IntegrationSiteIdentity2 signDocSite, SignDocTemplateIdentity templateIdentity) |
Gets the softpro template. More... | |
SignDocTemplateIdentityCollection | GetSignDocTemplates (string sessionId, IntegrationSiteIdentity2 signDocSite) |
Get the list of available document templates from SignDoc. More... | |
Provides methods for working with SignDoc templates and packages.
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.
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.
| ||||||||||||
packageId | A string that uniquely identifies the signing package. If the is invalid then an exception will be raised. |
GeneratedDocumentTemplateSettings GetGeneratedDocumentTemplate | ( | string | sessionId, |
IntegrationSiteIdentity2 | signDocSite, | ||
string | documentTemplateName | ||
) |
Gets a generated document template definition stored in KTA for use in a SignDoc activity.
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.
| ||||||||||||||||||||||||
documentTemplateName | Name of the document 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 |
Enumeration | Description |
---|---|
0 | Click2Sign |
1 | Photo |
2 | Handwritten |
GeneratedDocumentTemplateSettings2 GetGeneratedDocumentTemplate2 | ( | string | sessionId, |
IntegrationSiteIdentity2 | signDocSite, | ||
string | documentTemplateName | ||
) |
Gets the generated document template.
sessionId | The session identifier. |
signDocSite | The sign document site. |
documentTemplateName | Name of the document template. |
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.
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.
| ||||||||||||||||||||||||
templateIdentity | The template identity.
|
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 |
SignDocTemplateSettings2 GetSignDocTemplate2 | ( | string | sessionId, |
IntegrationSiteIdentity2 | signDocSite, | ||
SignDocTemplateIdentity | templateIdentity | ||
) |
Gets the softpro template.
sessionId | The session identifier. |
signDocSite | The sign document site. |
templateIdentity | The template identity. |
SignDocTemplateIdentityCollection GetSignDocTemplates | ( | string | sessionId, |
IntegrationSiteIdentity2 | signDocSite | ||
) |
Get the list of available document templates from SignDoc.
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 |
---|---|---|
Id | String | SignDoc template Id |
Name | String | SignDoc template Name |