TrustCenterEditSignersEx()

A TrustCenterEditSignersEx() rule function will edit signers of the document that was sent to Trust Center. If something goes wrong, the function will throw an exception, which has to be handled in try/catch block. In order to identify signers their email or external id has to be provided. A field to update has to start with „New” prefix (see examples below). Fields that can be edited are:

• FirstName,
• LastName,
• Company,
• CompanyRole,
• SignerRole,
• Phone,
• SignOrder.

Syntax

TrustCenterEditSignersEx(actionObject);

Function arguments

• actionObject – (Object) an action object containing required properties;
• actionObject.SignersToEdit – (ObjectList) a list of signers that will be edited in Trust Center;
• actionObject.Document – (File) a document sent to Trust Center, it can be: a document name, a document id, a document field or a file object.

Return value

This function returns NULL.

Examples

Example 1

Signers of the document from the field [pdf field], which was sent to Trust Center, will be updated with provided data.

actionObject.Document = [pdf field];
signersToEdit = "";
signerToEdit1.Email = "dsa@da.com";
signerToEdit1.NewFirstName = "John";
signerToEdit1.NewLastName="Doe";
signerToEdit1.NewPhone = 3292314421;
AddObjectToList(signersToEdit, signerToEdit1);
signerToEdit2.NewFirstName="Anna";
signerToEdit2.NewLastName="Malinowska";
signerToEdit2.Email="a.malinowska@amodit.com";
signerToEdit2.NewPhone = 823323213218;
AddObjectToList(signersToEdit, signerToEdit2);
actionObject.SignersToEdit = signersToEdit;
try
{
  TrustCenterEditSignersEx(actionObject);
}
catch
{
  ShowMessage(1,exception);
}

Example 2

A signer with email „john@doe.com” will have his phone number updated in Trust Center for the document from [pdf field].

actionObject.Document = [pdf field];
signersToEdit = "";
signerToEdit1.Email = "john@doe.com";
signerToEdit1.NewPhone = 3292314421;
AddObjectToList(signersToEdit, signerToEdit1);
TrustCenterEditSignersEx(actionObject);