| Package | Description |
|---|---|
| com.hellosign.sdk | |
| com.hellosign.sdk.http | |
| com.hellosign.sdk.resource | |
| com.hellosign.sdk.resource.support |
| Modifier and Type | Method and Description |
|---|---|
Template |
HelloSignClient.addTemplateUser(String templateId,
String idOrEmail)
Adds the provided user to the template indicated by the provided template
ID.
|
boolean |
HelloSignClient.cancelSignatureRequest(String id)
Cancels an existing signature request.
|
Account |
HelloSignClient.createAccount(String email)
Creates a new HelloSign account.
|
Account |
HelloSignClient.createAccount(String email,
String clientId,
String clientSecret)
Creates a new HelloSign account and provides OAuth app credentials to
automatically generate an OAuth token with the user Account response.
|
ApiApp |
HelloSignClient.createApiApp(ApiApp app)
Creates a new ApiApp using the properties set on the provided ApiApp.
|
AbstractRequest |
HelloSignClient.createEmbeddedRequest(EmbeddedRequest embeddedReq)
Creates a signature request that can be embedded within your website.
|
TemplateDraft |
HelloSignClient.createEmbeddedTemplateDraft(EmbeddedRequest req)
Creates a template draft that can be used for embedded template creation.
|
Team |
HelloSignClient.createTeam(String teamName)
Creates a new team for the current user with the given name.
|
UnclaimedDraft |
HelloSignClient.createUnclaimedDraft(UnclaimedDraft draft)
Creates an unclaimed draft using the provided request draft object.
|
boolean |
HelloSignClient.deleteApiApp(String clientId)
Attempts to delete the API app with the given client ID.
|
boolean |
HelloSignClient.deleteTemplate(String templateId)
Delete the template designated by the template id
|
boolean |
HelloSignClient.destroyTeam()
Destroys the current user's team.
|
Account |
HelloSignClient.getAccount()
Returns the current user's account information.
|
ApiApp |
HelloSignClient.getApiApp(String clientId)
Retrieves the API app configuration for the given Client ID.
|
ApiAppList |
HelloSignClient.getApiApps()
Retrieves a paged list of API apps for the authenticated account.
|
EmbeddedResponse |
HelloSignClient.getEmbeddedSignUrl(String signatureId)
Retrieves the necessary information to build an embedded signature
request.
|
EmbeddedResponse |
HelloSignClient.getEmbeddedTemplateEditUrl(String templateId)
Retrieves the necessary information to edit an embedded template.
|
EmbeddedResponse |
HelloSignClient.getEmbeddedTemplateEditUrl(String templateId,
boolean skipSignerRoles,
boolean skipSubjectMessage)
Retrieves the necessary information to edit an embedded template.
|
EmbeddedResponse |
HelloSignClient.getEmbeddedTemplateEditUrl(String templateId,
boolean skipSignerRoles,
boolean skipSubjectMessage,
boolean testMode)
Retrieves the necessary information to edit an embedded template.
|
EmbeddedResponse |
HelloSignClient.getEmbeddedTemplateEditUrl(String templateId,
boolean skipSignerRoles,
boolean skipSubjectMessage,
boolean testMode,
Map<String,FieldType> mergeFields,
List<String> ccRoles)
Big kahuna method for editing an embedded template.
|
File |
HelloSignClient.getFiles(String requestId)
Retrieves a PDF copy of the files associated with a signature request.
|
File |
HelloSignClient.getFiles(String requestId,
String format)
Retrieves the file associated with a signature request.
|
FileUrlResponse |
HelloSignClient.getFilesUrl(String requestId)
Retrieves a URL for a file associated with a signature request.
|
File |
HelloSignClient.getFinalCopy(String requestId)
Deprecated.
|
OauthData |
HelloSignClient.getOauthData(String code,
String clientId,
String secret,
String state,
boolean autoSetRequestToken)
Performs an OAuth request and returns the necessary data for authorizing
an API application, and will automatically set the access token and code
for making authenticated requests with this client.
|
SignatureRequest |
HelloSignClient.getSignatureRequest(String id)
Retrieves a Signature Request with the given ID.
|
SignatureRequestList |
HelloSignClient.getSignatureRequests()
Retrieves the current user's signature requests.
|
SignatureRequestList |
HelloSignClient.getSignatureRequests(int page)
Retrieves a specific page of the current user's signature requests.
|
Team |
HelloSignClient.getTeam()
Retrieves the Team for the current user account.
|
Template |
HelloSignClient.getTemplate(String templateId)
Retrieves a specific Template based on the provided Template ID.
|
File |
HelloSignClient.getTemplateFile(String templateId)
Retrieves the PDF file backing the Template specified by the provided
Template ID.
|
String |
HelloSignClient.getTemplateFileUrl(String templateId)
Returns a signed URL that can be used to retrieve the file backing a
template.
|
TemplateList |
HelloSignClient.getTemplates()
Retrieves the templates for the current user account.
|
TemplateList |
HelloSignClient.getTemplates(int page)
Retreives a page of templates for the current user account.
|
Team |
HelloSignClient.inviteTeamMember(String idOrEmail)
Adds the user to the current user's team.
|
boolean |
HelloSignClient.isAccountValid(String email)
Returns true if an account exists with the provided email address.
|
boolean |
HelloSignClient.isOnline()
Performs an OPTIONS call to the HelloSign API to see if it's online.
|
OauthData |
HelloSignClient.refreshOauthData(String refreshToken)
Refreshes the OauthData for this client with the provided refresh token.
|
Team |
HelloSignClient.removeTeamMember(String idOrEmail)
Removes the team member indicated by the user account ID or email
address.
|
Template |
HelloSignClient.removeTemplateUser(String templateId,
String idOrEmail)
Adds the provided user to the template indicated by the provided template
ID.
|
SignatureRequest |
HelloSignClient.requestEmailReminder(String requestId,
String email)
Instructs HelloSign to email the given address with a reminder to sign
the SignatureRequest referenced by the given request ID.
|
SignatureRequest |
HelloSignClient.sendSignatureRequest(SignatureRequest req)
Sends the provided signature request to HelloSign.
|
SignatureRequest |
HelloSignClient.sendTemplateSignatureRequest(TemplateSignatureRequest req)
Creates a new Signature Request based on the template provided.
|
void |
HelloSignClient.setAccessToken(String accessToken,
String tokenType)
Sets the access token for the OAuth user that this client will use to
perform requests.
|
Account |
HelloSignClient.setCallback(String callback)
Update your account callback URL.
|
ApiApp |
HelloSignClient.updateApiApp(ApiApp app)
Updates the API app with the given ApiApp object properties.
|
SignatureRequest |
HelloSignClient.updateSignatureRequest(String signatureRequestId,
String signatureId,
String newEmailAddress)
Update a signer's email address.
|
Team |
HelloSignClient.updateTeamName(String teamName)
Updates the current user's team name.
|
String |
HelloSignClient.updateTemplateFiles(String existingTemplateId,
TemplateDraft newTemplate,
String clientId)
Replaces the backing documents for the given template with the given
files.
|
| Constructor and Description |
|---|
HelloSignClient(Authentication auth)
Creates a new HelloSign client using then given Authentication object.
|
HelloSignClient(String apiKey)
Creates a new HelloSign client using your API key.
|
| Modifier and Type | Method and Description |
|---|---|
File |
HttpClient.asFile(String fileName)
Executes the request and returns the response as a File.
|
int |
HttpClient.asHttpCode()
Executes the request and returns the HTTP response code.
|
org.json.JSONObject |
HttpClient.asJson()
Executes the request and returns the response as a JSONObject.
|
HttpClient |
HttpClient.delete(String url)
Initializes a DELETE request to the given URL.
|
void |
AbstractHttpRequest.execute()
Executes this HTTP request and preserves the response stream and HTTP
response code for processing.
|
HttpClient |
HttpClient.get(String url)
Initializes a GET request to the given URL.
|
protected HttpURLConnection |
HttpPostRequest.getConnection()
Helper method to make an HTTP POST request.
|
protected HttpURLConnection |
HttpOptionsRequest.getConnection() |
protected HttpURLConnection |
HttpGetRequest.getConnection() |
protected HttpURLConnection |
HttpDeleteRequest.getConnection() |
protected abstract HttpURLConnection |
AbstractHttpRequest.getConnection()
The method class will create the appropriate connection with an endpoint,
parameters, etc.
|
long |
HttpClient.getLastResponseAsFile(File f)
Returns the last HTTP request body as a file.
|
long |
AbstractHttpRequest.getResponseAsFile(File f)
Write the last response to a file.
|
HttpClient |
HttpClient.options(String url)
Makes an OPTIONS request to the given URL
|
HttpClient |
HttpClient.post(String url)
Initializes a POST request to the given URL.
|
HttpClient |
HttpClient.put(String url)
Makes a PUT request to the given URL
|
void |
Authentication.setAccessToken(String accessToken,
String tokenType)
Sets the access token for the HelloSign client authentication.
|
| Constructor and Description |
|---|
Authentication(Authentication clone) |
HttpDeleteRequest(String url) |
HttpDeleteRequest(String url,
Authentication auth) |
HttpGetRequest(String url)
Constructor
|
HttpGetRequest(String url,
Authentication auth)
Constructor
|
HttpGetRequest(String url,
Map<String,String> parameters)
Constructor
|
HttpGetRequest(String url,
Map<String,String> parameters,
Authentication auth)
Constructor
|
HttpPostRequest(String url)
Constructor
|
HttpPostRequest(String url,
Authentication auth)
Constructor
|
HttpPostRequest(String url,
Map<String,Serializable> fields)
Constructor
|
HttpPostRequest(String url,
Map<String,Serializable> fields,
Authentication auth)
Constructor
|
HttpPutRequest(String url) |
HttpPutRequest(String url,
Authentication auth) |
HttpPutRequest(String url,
Map<String,Serializable> fields) |
HttpPutRequest(String url,
Map<String,Serializable> fields,
Authentication auth) |
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractRequest.addDocument(Document doc)
Adds a Document to the signature request.
|
void |
AbstractRequest.addDocument(Document doc,
int order)
Adds a Document to the signature request at the specific order.
|
void |
UnclaimedDraft.addFile(File file)
Adds a file to the unclaimed draft.
|
void |
AbstractRequest.addFile(File file)
Adds the file to the request.
|
void |
UnclaimedDraft.addFile(File file,
int order)
Adds a file to the unclaimed draft at the given document order.
|
void |
AbstractRequest.addFile(File file,
Integer order)
Adds the file to the request in the given order.
|
void |
TemplateDraft.addMergeField(String name,
FieldType type)
Add merge fields to the template draft.
|
void |
SignatureRequest.addSigner(Signer signer)
Adds the signer to the list of signers for this request.
|
void |
SignatureRequest.addSigner(String email,
String name)
Adds the signer to the list of signers for this request.
|
void |
SignatureRequest.addSigner(String email,
String name,
int order)
Adds the signer with the given order to the list of signers for this
request.
|
void |
TemplateDraft.addSignerRole(String role,
int order)
Adds the signer role with the given order to the list of signers for this
request.
|
void |
TemplateSignatureRequest.addTemplateId(String id)
Adds the template ID to be used in this request.
|
void |
TemplateSignatureRequest.addTemplateId(String id,
Integer index)
Add the template ID to be used at the specified index.
|
protected void |
AbstractResource.addToList(String key,
AbstractResource listItem) |
void |
UnclaimedDraft.clearFiles()
Removes all files from this request.
|
protected void |
AbstractResource.clearList(String key) |
List<E> |
AbstractResourceList.filterCurrentPageBy(String columnName,
Serializable filterValue)
Filters the current page of results by the given column and value.
|
String |
Event.getAccountId()
Returns the account ID that this event is reporting for.
|
String |
Event.getAppId()
Returns the API app ID for which this event is reported.
|
List<E> |
AbstractResourceList.getCurrentPageList()
Returns the current page of results for this list object.
|
String |
Event.getEventMessage()
Returns the message if any from the event
|
OauthData |
Account.getOauthData() |
Map<String,Serializable> |
UnclaimedDraft.getPostFields() |
Map<String,Serializable> |
TemplateSignatureRequest.getPostFields()
Internal method used to retrieve the necessary POST fields to submit the
signature request.
|
Map<String,Serializable> |
TemplateDraft.getPostFields()
Internal method used to retrieve the necessary POST fields.
|
Map<String,Serializable> |
SignatureRequest.getPostFields()
Internal method used to retrieve the necessary POST fields to submit the
signature request.
|
Map<String,Serializable> |
EmbeddedRequest.getPostFields() |
Map<String,Serializable> |
ApiApp.getPostFields()
Internal method used to retrieve the necessary POST fields to submit the
API app to HelloSign.
|
protected Map<String,Serializable> |
AbstractRequest.getPostFields() |
Signature |
Event.getRelatedSignature()
Returns the associated Signature object with this event, if the event is
associated with a Signature Request.
|
String |
Event.getRelatedSignatureId()
Returns the signature ID to which this event is associated.
|
RoleType |
Account.getRoleCode() |
Signature |
SignatureRequest.getSignature(String email,
String name)
Returns the signature for the given email/name combination, or null if
not found on this request.
|
String |
TemplateSignatureRequest.getTemplateId()
Get the template ID that will be used with this request.
|
boolean |
Event.hasAccountId()
Returns true if this event has a "reported_for_account_id" field.
|
boolean |
Event.hasAppId()
Returns true if this event has a "reported_for_app_id" field.
|
boolean |
Event.isValid(String apiKey)
Returns true if the event hash matches the computed hash using the
provided API key.
|
void |
SignatureRequest.removeSigner(String email)
Removes the signer from the list.
|
void |
TemplateSignatureRequest.removeSignerByEmail(String email)
Removes signer(s) from this request by email address.
|
boolean |
TemplateDraft.removeSignerRole(String signerRole)
Removes the signer role.
|
static String |
TemplateDraft.serializeMergeFields(Map<String,FieldType> mergeFields)
Helper method to convert a Java Map into the JSON string required
by the HelloSign API.
|
void |
AbstractRequest.setClientId(String clientId)
Associates this request with an API app.
|
void |
ApiApp.setHeaderBackgroundColor(String color)
Set the signer page header background color.
|
void |
ApiApp.setLinkColor(String color)
Set the signer page link color.
|
void |
ApiApp.setPageBackgroundColor(String color)
Set the signer page background color.
|
void |
ApiApp.setPrimaryButtonColor(String color)
Set the signer page primary button color.
|
void |
ApiApp.setPrimaryButtonHoverColor(String color)
Set the signer page primary button hover color.
|
void |
ApiApp.setPrimaryButtonTextColor(String color)
Set the signer page primary button text color.
|
void |
ApiApp.setPrimaryButtonTextHoverColor(String color)
Set the signer page primary button text hover color.
|
void |
ApiApp.setSecondaryButtonColor(String color)
Set the signer page secondary button color.
|
void |
ApiApp.setSecondaryButtonHoverColor(String color)
Set the signer page secondary button hover color.
|
void |
ApiApp.setSecondaryButtonTextColor(String color)
Set the signer page secondary button text color.
|
void |
ApiApp.setSecondaryButtonTextHoverColor(String color)
Set the signer page secondary button text hover color.
|
void |
TemplateSignatureRequest.setSigner(String role,
String email,
String name)
Adds the signer to the list of signers for this request.
|
void |
TemplateSignatureRequest.setTemplateId(String id)
Set the template ID of the template that should be used with this
request.
|
void |
ApiApp.setTextColor1(String color)
Set the signer page text 1 color.
|
void |
ApiApp.setTextColor2(String color)
Set the signer page text 2 color.
|
| Constructor and Description |
|---|
AbstractRequest(org.json.JSONObject json,
String optionalKey) |
AbstractResource(org.json.JSONObject json,
String optionalKey) |
AbstractResourceList(org.json.JSONObject json,
String listKey) |
Account(org.json.JSONObject json) |
Account(org.json.JSONObject json,
String custom_key) |
ApiApp(org.json.JSONObject json)
Constructor that instantiates an ApiApp object based on the JSON response
from the HelloSign API.
|
EmbeddedResponse(org.json.JSONObject json) |
Event(org.json.JSONObject json)
Default constructor.
|
FileUrlResponse(org.json.JSONObject jsonObject) |
SignatureRequest(org.json.JSONObject json) |
SignatureRequest(org.json.JSONObject json,
String key) |
Team(org.json.JSONObject json) |
Template(org.json.JSONObject json) |
TemplateDraft(org.json.JSONObject json) |
TemplateSignatureRequest(List<Template> templates)
Convenience constructor that accepts a list of Templates.
|
TemplateSignatureRequest(Template template)
Convenience constructor that accepts a single Template.
|
UnclaimedDraft(org.json.JSONObject json)
Constructor to provide a way to store the API response JSON information.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Document.addFormField(FormField formField)
Adds the form field to this document.
|
void |
Signer.setEmail(String email) |
void |
Document.setFormFields(List<FormField> formFields)
Overwrites the form fields for this document.
|
void |
WhiteLabelingOptions.setHeaderBackgroundColor(String color)
Set the signer page header background color.
|
void |
WhiteLabelingOptions.setLinkColor(String color)
Set the signer page link color.
|
void |
WhiteLabelingOptions.setPageBackgroundColor(String color)
Set the signer page background color.
|
void |
WhiteLabelingOptions.setPrimaryButtonColor(String color)
Set the signer page primary button color.
|
void |
WhiteLabelingOptions.setPrimaryButtonHoverColor(String color)
Set the signer page primary button hover color.
|
void |
WhiteLabelingOptions.setPrimaryButtonTextColor(String color)
Set the signer page primary button text color.
|
void |
WhiteLabelingOptions.setPrimaryButtonTextHoverColor(String color)
Set the signer page primary button text hover color.
|
void |
WhiteLabelingOptions.setSecondaryButtonColor(String color)
Set the signer page secondary button color.
|
void |
WhiteLabelingOptions.setSecondaryButtonHoverColor(String color)
Set the signer page secondary button hover color.
|
void |
WhiteLabelingOptions.setSecondaryButtonTextColor(String color)
Set the signer page secondary button text color.
|
void |
WhiteLabelingOptions.setSecondaryButtonTextHoverColor(String color)
Set the signer page secondary button text hover color.
|
void |
WhiteLabelingOptions.setTextColor1(String color)
Set the signer page text 1 color.
|
void |
WhiteLabelingOptions.setTextColor2(String color)
Set the signer page text 2 color.
|
| Constructor and Description |
|---|
ApiAppList(org.json.JSONObject json) |
ApiAppOauth(org.json.JSONObject json)
Constructor that instantiates an ApiApp OAuth object based on the JSON
response from the HelloSign API.
|
CustomField(org.json.JSONObject json) |
Document(org.json.JSONObject json) |
FormField(org.json.JSONObject json) |
Metadata(org.json.JSONObject json) |
OauthData(org.json.JSONObject json) |
Quotas(org.json.JSONObject json) |
ResponseData(org.json.JSONObject json) |
Signature(org.json.JSONObject json) |
SignatureRequestList(org.json.JSONObject json) |
Signer(String email,
String nameOrRole) |
TemplateList(org.json.JSONObject json) |
TemplateRole(org.json.JSONObject json) |
Warning(org.json.JSONObject json) |
WhiteLabelingOptions(org.json.JSONObject json) |
Copyright © 2017 HelloSign. All rights reserved.