SDKSample (sdk 11.54 API)

java.lang.Object
- com.silanis.esl.sdk.examples.SDKSample

Direct Known Subclasses:

AccountDesignerSettingsExample, AccountEmailReminderSettingsExample, AccountSettingsExample, AccountSystemSettingPropertiesExample, AccountUploadSettingsExample, AdaPackageExample, AdditionalRequestHeadersExample, ApplicationVersionExample, ApplyLayoutByNameExample, AttachmentFileExample, AttachmentRequirementExample, AuthenticationMethodsExample, BasicPackageCreationExample, BrandingBarConfigurationExample, ChangePackageStatusExample, ChangePlaceholderNameExample, ChangeSignerExample, ConditionalFieldExample, ConfigureHandoverUrlExample, ConsentExample, CreateAndGetLayoutExample, CreateAndUpdateSubAccountExample, CreatePackageFromInputStreamExample, CreatePackageFromTemplateExample, CreatePackageFromTemplateWithAttachmentExample, CreatePackageFromTemplateWithFieldsExample, CreatePackageFromTemplateWithReplacingPlaceholderExample, CreateSenderTemplateExample, CreateTemplateExample, CreateTemplateFromPackageExample, CreateTemplateOnBehalfOfAnotherSenderExample, CustomFieldExample, CustomSenderInfoExample, DataManagementPolicyExample, DeclineReasonExample, DelegationExample, DeleteDocumentsExample, DeletePackageExample, DeliverSignedDocumentsByEmailExample, DesignerRedirectForApiKeyExample, DesignerRedirectForPackageSenderExample, DisabledSignaturesExample, DocumentAttributesExample, DocumentExtractionExample, DocumentLayoutExample, DocumentOperationsExample, DocumentPackageAttributesExample, DocumentPackageSettingsExample, DocumentRetrievalExample, DocumentUploadExample, DocumentVisibilityExample, DocumentWorkflowExample, DownloadReportExample, EventNotificationRegistrationExample, ExceptionHandlingExample, ExpiryTimeConfigurationExample, ExternalDocumentExample, FieldInjectionAndExtractionExample, FieldInjectionExample, FieldManipulationExample, FieldPositionExtractionExample, FieldValidatorsExample, FromFileCaptureSignatureExample, GenericFieldsExample, GetCompletedPackagesWithinDateRangeExample, GetGroupSummariesExample, GetPackageExample, GetPackageFieldsListExample, GetPackageListExample, GetPackageMessageExample, GetSigningStatusExample, GetSigningUrlExample, GroupManagementExample, IdvAuthExample, InPersonExample, InviteAccountMemberExample, ListTemplatesExample, LocalLanguageExample, MergeFieldValidationExample, MixedSignerAuthenticationExample, MixingSignatureAndAcceptanceOnOnedocumentExample, MobileCaptureSignatureStyleExample, NotaryJournalExample, NotifySignerExample, OptionalSignaturesExample, PackageInformationExample, PackageLanguageConfigurationExample, PackageReferencedConditionsExample, PackageViewRedirectForPackageSenderExample, ProxyConfigurationExample, ReminderExample, RetrieveFieldValuesExample, SDKSampleWithRolesAndPermission, SenderAuthenticationTokenExample, SenderImageSignatureExample, SenderManipulationExample, SendSmsToSignerExample, SessionCreationExample, SignableSignaturesExample, SignatureImageExample, SignatureManipulationExample, SignatureStylesExample, SignDocumentsExample, SignerAuthenticationTokenExample, SignerBoundFieldsExample, SignerInformationForEquifaxCanadaExample, SignerInformationForEquifaxUSAExample, SignerInformationForLexisNexisExample, SignerManipulationExample, SignerOrderingExample, SignerQnAChallengeExample, SignerSMSAuthenticationExample, SignerSpecificEmailMessageExample, SignerVerificationExample, SignerVerificationTypesExample, SigningRedirectForSignerExample, SigningRedirectForSignerForSingleUseExample, SigningStyleExample, StampFieldValueExample, StartFastTrackExample, TemplateExample, TextAnchorExtractionExample, TextTagsExample, ThankYouDialogExample, UpdateInjectedFieldsFromTemplateExample, UpdatePackageExample, UpdateSignerExample, UpdateTemplateWithPlaceholderExample, UserAuthenticationTokenExample, VirtualRoomExample
```
public abstract class SDKSample
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected InputStream`	`documentInputStream1`
`protected InputStream`	`documentInputStream2`
`String`	`email1`
`String`	`email2`
`String`	`email3`
`String`	`email4`
`String`	`email5`
`String`	`email6`
`protected EslClient`	`eslClient`
`protected PackageId`	`packageId`
`protected String`	`packageName`
`protected Properties`	`props`
`String`	`proxyHost`
`String`	`proxyPassword`
`int`	`proxyPort`
`String`	`proxyUserName`
`String`	`proxyWithCredentialsHost`
`int`	`proxyWithCredentialsPort`
`protected DocumentPackage`	`retrievedPackage`
`String`	`senderEmail`
`String`	`senderUID`
`String`	`webpageUrl`

Constructor Summary

Constructors
Constructor and Description

SDKSample()

SDKSample(String apiKey, String apiUrl)

Constructors
Constructor and Description
`SDKSample()`
`SDKSample(String apiKey, String apiUrl)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`execute()`
`protected EslClient`	`getEslClient()`
`protected PackageId`	`getPackageId()`
`protected String`	`getPackageName()`
`protected String`	`getRandomEmail()`
`protected DocumentPackage`	`getRetrievedPackage()`
`void`	`run()`
`EslClient`	`setupEslClientFromProps(Map<String,String> additionalHeaders, ProxyConfiguration proxyConfiguration)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

eslClient
```
protected EslClient eslClient
```

packageId
```
protected PackageId packageId
```

packageName
```
protected String packageName
```

retrievedPackage

protected DocumentPackage retrievedPackage

documentInputStream1

protected InputStream documentInputStream1

documentInputStream2

protected InputStream documentInputStream2

props
```
protected Properties props
```

email1
```
public String email1
```

email2
```
public String email2
```

email3
```
public String email3
```

email4
```
public String email4
```

email5
```
public String email5
```

email6
```
public String email6
```

senderEmail
```
public String senderEmail
```

webpageUrl
```
public String webpageUrl
```

senderUID
```
public String senderUID
```

proxyHost
```
public String proxyHost
```

proxyWithCredentialsHost
```
public String proxyWithCredentialsHost
```

proxyUserName
```
public String proxyUserName
```

proxyPassword
```
public String proxyPassword
```

proxyPort
```
public int proxyPort
```

proxyWithCredentialsPort
```
public int proxyWithCredentialsPort
```

Constructor Detail

SDKSample
```
public SDKSample()
```

SDKSample

public SDKSample(String apiKey,
                 String apiUrl)

Method Detail

setupEslClientFromProps

public EslClient setupEslClientFromProps(Map<String,String> additionalHeaders,
                                         ProxyConfiguration proxyConfiguration)

execute
```
protected abstract void execute()
```

run
```
public void run()
```

getEslClient
```
protected EslClient getEslClient()
```

getPackageId
```
protected PackageId getPackageId()
```

getRetrievedPackage

protected DocumentPackage getRetrievedPackage()

getPackageName
```
protected String getPackageName()
```

getRandomEmail
```
protected String getRandomEmail()
```

Class SDKSample

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

eslClient

packageId

packageName

retrievedPackage

documentInputStream1

documentInputStream2

props

email1

email2

email3

email4

email5

email6

senderEmail

webpageUrl

senderUID

proxyHost

proxyWithCredentialsHost

proxyUserName

proxyPassword

proxyPort

proxyWithCredentialsPort

Constructor Detail

SDKSample

SDKSample

Method Detail

setupEslClientFromProps

execute

run

getEslClient

getPackageId

getRetrievedPackage

getPackageName

getRandomEmail