Index (HelloSign Java SDK 3.2.2 API)

A C D E F G H I L M N O P Q R S T U V W

A

AbstractHttpRequest - Class in com.hellosign.sdk.http
AbstractHttpRequest() - Constructor for class com.hellosign.sdk.http.AbstractHttpRequest
AbstractRequest - Class in com.hellosign.sdk.resource: Requests to HelloSign will have common fields such as a request title, subject, and message.
AbstractRequest() - Constructor for class com.hellosign.sdk.resource.AbstractRequest
AbstractRequest(JSONObject, String) - Constructor for class com.hellosign.sdk.resource.AbstractRequest
AbstractResource - Class in com.hellosign.sdk.resource: A nice place to put code that is common to all HelloSign resource classes.
AbstractResource() - Constructor for class com.hellosign.sdk.resource.AbstractResource
AbstractResource(JSONObject, String) - Constructor for class com.hellosign.sdk.resource.AbstractResource
AbstractResourceList<E> - Class in com.hellosign.sdk.resource
AbstractResourceList(JSONObject, String) - Constructor for class com.hellosign.sdk.resource.AbstractResourceList
Account - Class in com.hellosign.sdk.resource: Stores HelloSign Account information.
Account() - Constructor for class com.hellosign.sdk.resource.Account
Account(JSONObject) - Constructor for class com.hellosign.sdk.resource.Account
Account(JSONObject, String) - Constructor for class com.hellosign.sdk.resource.Account
ACCOUNT_CALLBACK_URL - Static variable in class com.hellosign.sdk.resource.Account
ACCOUNT_EMAIL_ADDRESS - Static variable in class com.hellosign.sdk.resource.Account
ACCOUNT_ID - Static variable in class com.hellosign.sdk.resource.Account
ACCOUNT_IS_PAID_HF - Static variable in class com.hellosign.sdk.resource.Account
ACCOUNT_IS_PAID_HS - Static variable in class com.hellosign.sdk.resource.Account
ACCOUNT_KEY - Static variable in class com.hellosign.sdk.resource.Account
ACCOUNT_PASSWORD - Static variable in class com.hellosign.sdk.resource.Account
ACCOUNT_ROLE_CODE - Static variable in class com.hellosign.sdk.resource.Account
add(String, T) - Method in class com.hellosign.sdk.resource.AbstractResource
addCC(String) - Method in class com.hellosign.sdk.resource.SignatureRequest: Adds a CC'd email address to this request.
addCCRole(String) - Method in class com.hellosign.sdk.resource.TemplateDraft: Adds a named role for a CC recipient that must be specified when the template is used.
addDocument(Document) - Method in class com.hellosign.sdk.resource.AbstractRequest: Adds a Document to the signature request.
addDocument(Document, int) - Method in class com.hellosign.sdk.resource.AbstractRequest: Adds a Document to the signature request at the specific order.
addFile(File) - Method in class com.hellosign.sdk.resource.AbstractRequest: Adds the file to the request.
addFile(File, Integer) - Method in class com.hellosign.sdk.resource.AbstractRequest: Adds the file to the request in the given order.
addFile(File) - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Adds a file to the unclaimed draft.
addFile(File, int) - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Adds a file to the unclaimed draft at the given document order.
addFileUrl(String) - Method in class com.hellosign.sdk.resource.AbstractRequest: Add a file_url to this request.
addFormField(FormField) - Method in class com.hellosign.sdk.resource.support.Document: Adds the form field to this document.
addMergeField(String, FieldType) - Method in class com.hellosign.sdk.resource.TemplateDraft: Add merge fields to the template draft.
addMetadata(String, String) - Method in class com.hellosign.sdk.resource.AbstractRequest
addScope(ApiAppOauthScopeType) - Method in class com.hellosign.sdk.resource.ApiApp: Add a scope to this API App's OAuth scope list.
addScope(ApiAppOauthScopeType) - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: Add a scope to this API App's OAuth scope list.
addSigner(Signer) - Method in class com.hellosign.sdk.resource.SignatureRequest: Adds the signer to the list of signers for this request.
addSigner(String, String) - Method in class com.hellosign.sdk.resource.SignatureRequest: Adds the signer to the list of signers for this request.
addSigner(String, String, int) - Method in class com.hellosign.sdk.resource.SignatureRequest: Adds the signer with the given order to the list of signers for this request.
addSignerRole(String) - Method in class com.hellosign.sdk.resource.TemplateDraft: Adds the signer role to the template draft.
addSignerRole(String, int) - Method in class com.hellosign.sdk.resource.TemplateDraft: Adds the signer role with the given order to the list of signers for this request.
addTemplateId(String) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Adds the template ID to be used in this request.
addTemplateId(String, Integer) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Add the template ID to be used at the specified index.
addTemplateUser(String, String) - Method in class com.hellosign.sdk.HelloSignClient: Adds the provided user to the template indicated by the provided template ID.
addToList(String, AbstractResource) - Method in class com.hellosign.sdk.resource.AbstractResource
ApiApp - Class in com.hellosign.sdk.resource: Contains information about an API App
ApiApp() - Constructor for class com.hellosign.sdk.resource.ApiApp: Default constructor.
ApiApp(JSONObject) - Constructor for class com.hellosign.sdk.resource.ApiApp: Constructor that instantiates an ApiApp object based on the JSON response from the HelloSign API.
APIAPP_CALLBACK_URL - Static variable in class com.hellosign.sdk.resource.ApiApp
APIAPP_CLIENT_ID - Static variable in class com.hellosign.sdk.resource.ApiApp
APIAPP_CREATED_AT - Static variable in class com.hellosign.sdk.resource.ApiApp
APIAPP_DOMAIN - Static variable in class com.hellosign.sdk.resource.ApiApp
APIAPP_IS_APPROVED - Static variable in class com.hellosign.sdk.resource.ApiApp
APIAPP_KEY - Static variable in class com.hellosign.sdk.resource.ApiApp
APIAPP_NAME - Static variable in class com.hellosign.sdk.resource.ApiApp
APIAPP_OAUTH_CALLBACK_URL - Static variable in class com.hellosign.sdk.resource.support.ApiAppOauth
APIAPP_OAUTH_KEY - Static variable in class com.hellosign.sdk.resource.support.ApiAppOauth
APIAPP_OAUTH_SCOPES - Static variable in class com.hellosign.sdk.resource.support.ApiAppOauth
APIAPP_OAUTH_SECRET - Static variable in class com.hellosign.sdk.resource.support.ApiAppOauth
APIAPP_OWNER_ACCOUNT - Static variable in class com.hellosign.sdk.resource.ApiApp
ApiAppList - Class in com.hellosign.sdk.resource.support
ApiAppList(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.ApiAppList
ApiAppOauth - Class in com.hellosign.sdk.resource.support: An object describing an API app's OAuth properties.
ApiAppOauth() - Constructor for class com.hellosign.sdk.resource.support.ApiAppOauth: Default constructor.
ApiAppOauth(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.ApiAppOauth: Constructor that instantiates an ApiApp OAuth object based on the JSON response from the HelloSign API.
ApiAppOauthScopeType - Enum in com.hellosign.sdk.resource.support.types: An enum of available OAuth scopes.
auth - Variable in class com.hellosign.sdk.http.AbstractHttpRequest
authenticate(HttpURLConnection, String) - Method in class com.hellosign.sdk.http.Authentication: Authorizes the HTTP connection using this instance's credentials.
Authentication - Class in com.hellosign.sdk.http: This class provides convenience methods for handling authentication information for a HelloSignClient instance.
Authentication() - Constructor for class com.hellosign.sdk.http.Authentication
Authentication(Authentication) - Constructor for class com.hellosign.sdk.http.Authentication

C

cancelSignatureRequest(String) - Method in class com.hellosign.sdk.HelloSignClient: Cancels an existing signature request.
canEdit() - Method in class com.hellosign.sdk.resource.Template
clearCCs() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Clears the list of current CC email addresses.
clearCustomFields() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Clears the current custom fields for this request.
clearDocuments() - Method in class com.hellosign.sdk.resource.AbstractRequest: Remove all documents from this request.
clearFiles() - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Removes all files from this request.
clearList(String) - Method in class com.hellosign.sdk.resource.AbstractResource
clearMergeFields() - Method in class com.hellosign.sdk.resource.TemplateDraft: Clears the current merge field map.
clearScopes() - Method in class com.hellosign.sdk.resource.ApiApp: Clear all OAuth scopes for this API App.
clearScopes() - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: Clear all OAuth scopes for this API App.
CLIENT_ID - Static variable in class com.hellosign.sdk.HelloSignClient
CLIENT_SECRET - Static variable in class com.hellosign.sdk.HelloSignClient
com.hellosign.sdk - package com.hellosign.sdk
com.hellosign.sdk.http - package com.hellosign.sdk.http
com.hellosign.sdk.resource - package com.hellosign.sdk.resource
com.hellosign.sdk.resource.support - package com.hellosign.sdk.resource.support
com.hellosign.sdk.resource.support.types - package com.hellosign.sdk.resource.support.types
convertStreamToString(InputStream) - Static method in class com.hellosign.sdk.http.AbstractHttpRequest
createAccount(String) - Method in class com.hellosign.sdk.HelloSignClient: Creates a new HelloSign account.
createAccount(String, String) - Method in class com.hellosign.sdk.HelloSignClient: Deprecated.
as of 3.1.1, replaced by HelloSignClient.createAccount(String)
createAccount(String, String, String) - Method in class com.hellosign.sdk.HelloSignClient: Creates a new HelloSign account and provides OAuth app credentials to automatically generate an OAuth token with the user Account response.
createAccount(String, String, String, String) - Method in class com.hellosign.sdk.HelloSignClient: Deprecated.
as of 3.1.1, replaced by HelloSignClient.createAccount(String, String, String)
createApiApp(ApiApp) - Method in class com.hellosign.sdk.HelloSignClient: Creates a new ApiApp using the properties set on the provided ApiApp.
createEmbeddedRequest(EmbeddedRequest) - Method in class com.hellosign.sdk.HelloSignClient: Creates a signature request that can be embedded within your website.
createEmbeddedTemplateDraft(EmbeddedRequest) - Method in class com.hellosign.sdk.HelloSignClient: Creates a template draft that can be used for embedded template creation.
createTeam(String) - Method in class com.hellosign.sdk.HelloSignClient: Creates a new team for the current user with the given name.
createUnclaimedDraft(UnclaimedDraft) - Method in class com.hellosign.sdk.HelloSignClient: Creates an unclaimed draft using the provided request draft object.
CUSTOM_FIELD_API_ID - Static variable in class com.hellosign.sdk.resource.support.CustomField
CUSTOM_FIELD_NAME - Static variable in class com.hellosign.sdk.resource.support.CustomField
CUSTOM_FIELD_TYPE - Static variable in class com.hellosign.sdk.resource.support.CustomField
CustomField - Class in com.hellosign.sdk.resource.support: This class represents a HelloSign Custom Field.
CustomField() - Constructor for class com.hellosign.sdk.resource.support.CustomField
CustomField(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.CustomField

D

dataObj - Variable in class com.hellosign.sdk.resource.AbstractResource
DEFAULT_ENCODING - Static variable in class com.hellosign.sdk.HelloSignClient
DEFAULT_ENCODING - Static variable in class com.hellosign.sdk.http.AbstractHttpRequest
deleteApiApp(String) - Method in class com.hellosign.sdk.HelloSignClient: Attempts to delete the API app with the given client ID.
deleteTemplate(String) - Method in class com.hellosign.sdk.HelloSignClient
destroyTeam() - Method in class com.hellosign.sdk.HelloSignClient: Destroys the current user's team.
Document - Class in com.hellosign.sdk.resource.support: Represents a document and its associated (optional) form fields and custom fields.
Document() - Constructor for class com.hellosign.sdk.resource.support.Document
Document(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.Document

E

EMBEDDED_CLIENT_ID - Static variable in class com.hellosign.sdk.resource.EmbeddedRequest
EmbeddedRequest - Class in com.hellosign.sdk.resource: Represents an Embedded signature request (either standard or templated).
EmbeddedRequest(String, AbstractRequest) - Constructor for class com.hellosign.sdk.resource.EmbeddedRequest: Creates an Embedded signature request using the client ID and the AbstractRequest object provided.
EmbeddedResponse - Class in com.hellosign.sdk.resource: Class to hold an embedded signature request response.
EmbeddedResponse(JSONObject) - Constructor for class com.hellosign.sdk.resource.EmbeddedResponse
Event - Class in com.hellosign.sdk.resource: This is a utility class for assisting with the development of callback services to respond to HelloSign events.
Event(JSONObject) - Constructor for class com.hellosign.sdk.resource.Event: Default constructor.
EVENT_HASH - Static variable in class com.hellosign.sdk.resource.Event
EVENT_KEY - Static variable in class com.hellosign.sdk.resource.Event
EVENT_METADATA - Static variable in class com.hellosign.sdk.resource.Event
EVENT_TIME - Static variable in class com.hellosign.sdk.resource.Event
EVENT_TYPE - Static variable in class com.hellosign.sdk.resource.Event
EventType - Enum in com.hellosign.sdk.resource.support.types: The MIT License (MIT) Copyright (C) 2015 hellosign.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

F

FieldType - Enum in com.hellosign.sdk.resource.support.types: Enumeration of allowable field types.
FILES_FILE_EXT - Static variable in class com.hellosign.sdk.HelloSignClient
FILES_FILE_NAME - Static variable in class com.hellosign.sdk.HelloSignClient
filterCurrentPageBy(String, Serializable) - Method in class com.hellosign.sdk.resource.AbstractResourceList: Filters the current page of results by the given column and value.
FINAL_COPY_FILE_EXT - Static variable in class com.hellosign.sdk.HelloSignClient
FINAL_COPY_FILE_NAME - Static variable in class com.hellosign.sdk.HelloSignClient
FormField - Class in com.hellosign.sdk.resource.support: This class represents a HelloSign Form Field object.
FormField() - Constructor for class com.hellosign.sdk.resource.support.FormField
FormField(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.FormField

G

get(String) - Method in class com.hellosign.sdk.resource.AbstractResource
get(String) - Method in class com.hellosign.sdk.resource.support.Metadata
getAccessCode() - Method in class com.hellosign.sdk.resource.support.Signer
getAccessToken() - Method in class com.hellosign.sdk.http.Authentication: Returns a protected copy of the access token.
getAccessToken() - Method in class com.hellosign.sdk.resource.support.OauthData
getAccessTokenType() - Method in class com.hellosign.sdk.http.Authentication: Returns a protected copy of the access token type string.
getAccount() - Method in class com.hellosign.sdk.HelloSignClient: Returns the current user's account information.
getAccountId() - Method in class com.hellosign.sdk.resource.Event: Returns the account ID that this event is reporting for.
getAccounts() - Method in class com.hellosign.sdk.resource.Team
getAccounts() - Method in class com.hellosign.sdk.resource.Template
getApiApp(String) - Method in class com.hellosign.sdk.HelloSignClient: Retrieves the API app configuration for the given Client ID.
getApiApps() - Method in class com.hellosign.sdk.HelloSignClient: Retrieves a paged list of API apps for the authenticated account.
getApiId() - Method in class com.hellosign.sdk.resource.support.CustomField
getApiId() - Method in class com.hellosign.sdk.resource.support.FormField
getApiId() - Method in class com.hellosign.sdk.resource.support.ResponseData
getApiKey() - Method in class com.hellosign.sdk.http.Authentication: Returns a protected copy of the API key String.
getApiSignatureRequestsLeft() - Method in class com.hellosign.sdk.resource.Account
getApiSignatureRequestsLeft() - Method in class com.hellosign.sdk.resource.support.Quotas
getApiUrl() - Method in class com.hellosign.sdk.HelloSignClient
getBoolean(String) - Method in class com.hellosign.sdk.resource.AbstractResource
getCallbackUrl() - Method in class com.hellosign.sdk.resource.Account
getCallbackUrl() - Method in class com.hellosign.sdk.resource.ApiApp: The app's callback URL (for events).
getCallbackUrl() - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: The app's OAuth callback URL.
getCCRoles() - Method in class com.hellosign.sdk.resource.Template
getCCRoles() - Method in class com.hellosign.sdk.resource.TemplateDraft: Returns the CC roles for this request.
getCCs() - Method in class com.hellosign.sdk.resource.SignatureRequest: Returns the CC email addresses for this request.
getCCs() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Returns a reference to the map of current roles to CC email addresses.
getClaimUrl() - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Gets the claim URL if the draft has been created.
getClientId() - Method in class com.hellosign.sdk.resource.ApiApp: The app's client ID.
getClientId() - Method in class com.hellosign.sdk.resource.EmbeddedRequest: Set the client ID of the web app you're using to create this embedded signature request.
getConstructor(Class<?>, Class<?>) - Method in class com.hellosign.sdk.resource.AbstractResource: Returns the first constructor that has exactly one parameter of the provided paramClass type.
getCreatedAt() - Method in class com.hellosign.sdk.resource.ApiApp: The time that the app was created.
getCurrentPageList() - Method in class com.hellosign.sdk.resource.AbstractResourceList: Returns the current page of results for this list object.
getCustomFields() - Method in class com.hellosign.sdk.resource.support.Document: Returns the custom fields for this document.
getCustomFields() - Method in class com.hellosign.sdk.resource.Template
getCustomFields() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Returns the map of custom fields for the template.
getDate(String) - Method in class com.hellosign.sdk.resource.AbstractResource
getDateSigned() - Method in class com.hellosign.sdk.resource.support.Signature
getDetailsUrl() - Method in class com.hellosign.sdk.resource.SignatureRequest
getDocuments() - Method in class com.hellosign.sdk.resource.AbstractRequest: Returns a reference to the list of documents for this request.
getDocuments() - Method in class com.hellosign.sdk.resource.Template
getDocumentsLeft() - Method in class com.hellosign.sdk.resource.Account
getDocumentsLeft() - Method in class com.hellosign.sdk.resource.support.Quotas
getDomain() - Method in class com.hellosign.sdk.resource.ApiApp: The domain name associated with the app.
getEditUrl() - Method in class com.hellosign.sdk.resource.EmbeddedResponse
getEditUrl() - Method in class com.hellosign.sdk.resource.TemplateDraft: Returns the edit URL for creating an embedded template draft.
getEmail() - Method in class com.hellosign.sdk.http.Authentication: Returns the email address for this client.
getEmail() - Method in class com.hellosign.sdk.resource.Account
getEmail() - Method in class com.hellosign.sdk.resource.support.Signature
getEmail() - Method in class com.hellosign.sdk.resource.support.Signer
getEmbeddedSignUrl(String) - Method in class com.hellosign.sdk.HelloSignClient: Retrieves the necessary information to build an embedded signature request.
getEmbeddedTemplateEditUrl(String) - Method in class com.hellosign.sdk.HelloSignClient: Retrieves the necessary information to edit an embedded template.
getEventDate() - Method in class com.hellosign.sdk.resource.Event: Returns the event time as a Java Date object.
getExpiresAt() - Method in class com.hellosign.sdk.resource.EmbeddedResponse
getExpiresAt() - Method in class com.hellosign.sdk.resource.TemplateDraft: Returns the expiration time for the edit URL of this template.
getExpiresIn() - Method in class com.hellosign.sdk.resource.support.OauthData
getFile() - Method in class com.hellosign.sdk.resource.support.Document: Returns the File associated with this document.
getFileResponse(String) - Method in class com.hellosign.sdk.http.HttpGetRequest: Execute the GET request and process the response as a file.
getFiles(String) - Method in class com.hellosign.sdk.HelloSignClient: Retrieves a PDF copy of the files associated with a signature request.
getFiles(String, String) - Method in class com.hellosign.sdk.HelloSignClient: Retrieves the file associated with a signature request.
getFilesUrl() - Method in class com.hellosign.sdk.resource.SignatureRequest: Returns the API URL to retrieve the PDF copy of this signature request.
getFileUrls() - Method in class com.hellosign.sdk.resource.AbstractRequest: Return the current file_url list.
getFinalCopy(String) - Method in class com.hellosign.sdk.HelloSignClient: Deprecated.
Use getFiles(requestId)
getFinalCopyUrl() - Method in class com.hellosign.sdk.resource.SignatureRequest: Deprecated.
use getFilesUrl()
getFormFields() - Method in class com.hellosign.sdk.resource.support.Document: Returns the form fields for this document.
getHash() - Method in class com.hellosign.sdk.resource.Event: Returns the unique hash string identifying this event.
getHeight() - Method in class com.hellosign.sdk.resource.support.FormField
getHttpCode() - Method in exception com.hellosign.sdk.HelloSignException: Returns the HTTP code associated with a HelloSign API call.
getHttpResponseCode() - Method in class com.hellosign.sdk.http.HttpDeleteRequest
getHttpResponseCode() - Method in class com.hellosign.sdk.http.HttpPostRequest: Performs a field-less POST request to the provided URL using basic auth and returns the HTTP code.
getId() - Method in class com.hellosign.sdk.resource.AbstractRequest
getId() - Method in class com.hellosign.sdk.resource.Account
getId() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
getId() - Method in class com.hellosign.sdk.resource.SignatureRequest: Returns the ID for this request.
getId() - Method in class com.hellosign.sdk.resource.support.Signature
getId() - Method in class com.hellosign.sdk.resource.Template
getId() - Method in class com.hellosign.sdk.resource.TemplateDraft: Returns the ID for this request.
getId() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest
getId() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
getIndex() - Method in class com.hellosign.sdk.resource.support.Document
getInteger(String) - Method in class com.hellosign.sdk.resource.AbstractResource
getInvitedAccounts() - Method in class com.hellosign.sdk.resource.Team
getJSONObject() - Method in class com.hellosign.sdk.resource.AbstractResource
getJsonResponse() - Method in class com.hellosign.sdk.http.HttpGetRequest: Executes the GET request and converts the response to a JSON object.
getJsonResponse() - Method in class com.hellosign.sdk.http.HttpPostRequest: Performs a POST request to the given URL, using the authentication details and POST fields provided.
getLastReminded() - Method in class com.hellosign.sdk.resource.support.Signature
getLastViewed() - Method in class com.hellosign.sdk.resource.support.Signature
getList(Class<T>, String) - Method in class com.hellosign.sdk.resource.AbstractResource
getList(Class<T>, String, Serializable, String) - Method in class com.hellosign.sdk.resource.AbstractResource
getLong(String) - Method in class com.hellosign.sdk.resource.AbstractResource
getMergeFields() - Method in class com.hellosign.sdk.resource.TemplateDraft: Returns the current map of merge field names->types.
getMessage() - Method in class com.hellosign.sdk.resource.AbstractRequest
getMessage() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
getMessage() - Method in class com.hellosign.sdk.resource.support.Warning
getMessage() - Method in class com.hellosign.sdk.resource.Template
getMessage() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
getMetadata() - Method in class com.hellosign.sdk.resource.AbstractRequest
getMetadata(String) - Method in class com.hellosign.sdk.resource.AbstractRequest
getName() - Method in class com.hellosign.sdk.resource.ApiApp: The name of the app.
getName() - Method in class com.hellosign.sdk.resource.support.CustomField
getName() - Method in class com.hellosign.sdk.resource.support.Document
getName() - Method in class com.hellosign.sdk.resource.support.FormField
getName() - Method in class com.hellosign.sdk.resource.support.ResponseData
getName() - Method in class com.hellosign.sdk.resource.support.Signature
getName() - Method in class com.hellosign.sdk.resource.support.Warning
getName() - Method in class com.hellosign.sdk.resource.Team
getNameOrRole() - Method in class com.hellosign.sdk.resource.support.Signer
getNumPages() - Method in class com.hellosign.sdk.resource.AbstractResourceList
getNumResults() - Method in class com.hellosign.sdk.resource.AbstractResourceList
getOauthData(String, String, String) - Method in class com.hellosign.sdk.HelloSignClient: Performs an OAuth request and returns the necessary data for authorizing an API application.
getOauthData(String, String, String, boolean) - Method in class com.hellosign.sdk.HelloSignClient: 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.
getOauthData() - Method in class com.hellosign.sdk.resource.Account
getOauthInfo() - Method in class com.hellosign.sdk.resource.ApiApp: An object describing the app's OAuth properties.
getOrder() - Method in class com.hellosign.sdk.resource.support.Signature
getOrder() - Method in class com.hellosign.sdk.resource.support.TemplateRole
getOrderMatters() - Method in class com.hellosign.sdk.resource.AbstractRequest: A flag that determines whether order of the signers list is enforced.
getOwnerAccount() - Method in class com.hellosign.sdk.resource.ApiApp: An object describing the app's owner.
getPage() - Method in class com.hellosign.sdk.resource.AbstractResourceList
getPageSize() - Method in class com.hellosign.sdk.resource.AbstractResourceList
getPassword() - Method in class com.hellosign.sdk.http.Authentication: Returns the password for this client.
getPostFields() - Method in class com.hellosign.sdk.resource.AbstractRequest
getPostFields() - Method in class com.hellosign.sdk.resource.ApiApp: Internal method used to retrieve the necessary POST fields to submit the API app to HelloSign.
getPostFields() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
getPostFields() - Method in class com.hellosign.sdk.resource.SignatureRequest: Internal method used to retrieve the necessary POST fields to submit the signature request.
getPostFields() - Method in class com.hellosign.sdk.resource.TemplateDraft: Internal method used to retrieve the necessary POST fields.
getPostFields() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Internal method used to retrieve the necessary POST fields to submit the signature request.
getPostFields() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
getQuotas() - Method in class com.hellosign.sdk.resource.Account
getRedirectUrl() - Method in class com.hellosign.sdk.resource.AbstractRequest
getRedirectUrl() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
getRedirectUrl() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
getRefreshToken() - Method in class com.hellosign.sdk.resource.support.OauthData
getRelatedSignature() - Method in class com.hellosign.sdk.resource.Event: Returns the associated Signature object with this event, if the event is associated with a Signature Request.
getRelatedSignatureId() - Method in class com.hellosign.sdk.resource.Event: Returns the signature ID to which this event is associated.
getRequest() - Method in class com.hellosign.sdk.resource.EmbeddedRequest: Get the AbstractRequest associated with this Embedded signature request.
getRequest() - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Gets the associated request object.
getRequesterEmail() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
getRequired() - Method in class com.hellosign.sdk.resource.support.FormField
getResponseData() - Method in class com.hellosign.sdk.resource.SignatureRequest
getRole() - Method in class com.hellosign.sdk.resource.support.TemplateRole
getRoleCode() - Method in class com.hellosign.sdk.resource.Account
getScopes() - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: Array of OAuth scopes used by the app.
getSecret() - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: The app's OAuth secret.
getSignature(String, String) - Method in class com.hellosign.sdk.resource.SignatureRequest: Returns the signature for the given email/name combination, or null if not found on this request.
getSignatureBySigner(String, String) - Method in class com.hellosign.sdk.resource.SignatureRequest: Utility method that allows you to search for a Signature object on this request by email and name.
getSignatureId() - Method in class com.hellosign.sdk.resource.support.ResponseData
getSignatureRequest(String) - Method in class com.hellosign.sdk.HelloSignClient: Retrieves a Signature Request with the given ID.
getSignatureRequest() - Method in class com.hellosign.sdk.resource.Event: Returns a reference to the SignatureRequest that is attached to the Event.
getSignatureRequestCancelUrl() - Method in class com.hellosign.sdk.HelloSignClient
getSignatureRequestId() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
getSignatureRequests() - Method in class com.hellosign.sdk.HelloSignClient: Retrieves the current user's signature requests.
getSignatureRequests(int) - Method in class com.hellosign.sdk.HelloSignClient: Retrieves a specific page of the current user's signature requests.
getSignatureRequestSendUrl() - Method in class com.hellosign.sdk.HelloSignClient
getSignatureRequestUrl() - Method in class com.hellosign.sdk.HelloSignClient
getSignatures() - Method in class com.hellosign.sdk.resource.SignatureRequest: Returns a list of signatures for this request.
getSigner() - Method in class com.hellosign.sdk.resource.support.FormField
getSignerRoles() - Method in class com.hellosign.sdk.resource.Template: Returns a list of SignerRoles.
getSignerRoles() - Method in class com.hellosign.sdk.resource.TemplateDraft: Returns the signer roles specified for this template draft.
getSigners() - Method in class com.hellosign.sdk.resource.SignatureRequest: Returns a reference to the signers list.
getSigners() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Returns a reference to the signers list.
getSigningUrl() - Method in class com.hellosign.sdk.resource.SignatureRequest
getSignUrl() - Method in class com.hellosign.sdk.resource.EmbeddedResponse
getStatus() - Method in class com.hellosign.sdk.resource.support.Signature
getStatusString() - Method in class com.hellosign.sdk.resource.support.Signature
getString(String) - Method in class com.hellosign.sdk.resource.AbstractResource
getSubject() - Method in class com.hellosign.sdk.resource.AbstractRequest
getSubject() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
getSubject() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
getTeam() - Method in class com.hellosign.sdk.HelloSignClient: Retrieves the Team for the current user account.
getTemplate(String) - Method in class com.hellosign.sdk.HelloSignClient: Retrieves a specific Template based on the provided Template ID.
getTemplate() - Method in class com.hellosign.sdk.resource.Event: Returns a reference to the Template that is attached to the Event.
getTemplateId() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Get the template ID that will be used with this request.
getTemplateIds() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Get the list of template IDs that are used for this request.
getTemplates() - Method in class com.hellosign.sdk.HelloSignClient: Retrieves the templates for the current user account.
getTemplates(int) - Method in class com.hellosign.sdk.HelloSignClient: Retreives a page of templates for the current user account.
getTemplateSignatureRequestUrl() - Method in class com.hellosign.sdk.HelloSignClient
getTemplatesLeft() - Method in class com.hellosign.sdk.resource.Account
getTemplatesLeft() - Method in class com.hellosign.sdk.resource.support.Quotas
getTitle() - Method in class com.hellosign.sdk.resource.AbstractRequest
getTitle() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
getTitle() - Method in class com.hellosign.sdk.resource.Template
getTitle() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
getTokenType() - Method in class com.hellosign.sdk.resource.support.OauthData
getType() - Method in exception com.hellosign.sdk.HelloSignException: Returns the HelloSign API error type.
getType() - Method in class com.hellosign.sdk.resource.Event: Returns the EventType for this event.
getType() - Method in class com.hellosign.sdk.resource.support.CustomField
getType() - Method in class com.hellosign.sdk.resource.support.FormField
getType() - Method in class com.hellosign.sdk.resource.support.ResponseData
getType() - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Gets the unclaimed draft type.
getTypeString() - Method in class com.hellosign.sdk.resource.Event: Returns the event type String.
getTypeString() - Method in class com.hellosign.sdk.resource.support.CustomField
getTypeString() - Method in class com.hellosign.sdk.resource.support.FormField
getTypeString() - Method in class com.hellosign.sdk.resource.support.ResponseData
getTypeString() - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Gets the string value of the unclaimed draft type.
getValue() - Method in class com.hellosign.sdk.resource.support.ResponseData
getWarnings() - Method in class com.hellosign.sdk.resource.AbstractResource
getWidth() - Method in class com.hellosign.sdk.resource.support.FormField
getX() - Method in class com.hellosign.sdk.resource.support.FormField
getY() - Method in class com.hellosign.sdk.resource.support.FormField

H

has(String) - Method in class com.hellosign.sdk.resource.AbstractResource
hasAccessToken() - Method in class com.hellosign.sdk.http.Authentication: Returns true if an access token and token type have been provided.
hasAccountId() - Method in class com.hellosign.sdk.resource.Event: Returns true if this event has a "reported_for_account_id" field.
hasApiKey() - Method in class com.hellosign.sdk.http.Authentication: Returns true if the API Key has been set.
hasCallbackUrl() - Method in class com.hellosign.sdk.resource.Account
hasCallbackUrl() - Method in class com.hellosign.sdk.resource.ApiApp: True if the callback URL is non-null.
hasCallbackUrl() - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: True if the OAuth callback is set.
hasClaimUrl() - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Returns true if the draft has been created and a claim URL exists.
hasClientId() - Method in class com.hellosign.sdk.resource.ApiApp: Returns true if this app has a client ID.
hasDomain() - Method in class com.hellosign.sdk.resource.ApiApp: True if the domain has been set.
hasEditUrl() - Method in class com.hellosign.sdk.resource.TemplateDraft: Utility method to detect whether the "edit_url" parameter is set on this template object.
hasEmail() - Method in class com.hellosign.sdk.resource.Account
hasEmail() - Method in class com.hellosign.sdk.resource.support.Signature
hasError() - Method in class com.hellosign.sdk.resource.SignatureRequest
hasExpiresAt() - Method in class com.hellosign.sdk.resource.TemplateDraft: Utility method to detect whether the "expires_at" parameter is set on this template object.
HASH_ALGORITHM - Static variable in class com.hellosign.sdk.resource.Event
hasHideTextTags() - Method in class com.hellosign.sdk.resource.AbstractRequest
hasHideTextTags() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Not implemented for templates.
hasId() - Method in class com.hellosign.sdk.resource.Account
hasId() - Method in class com.hellosign.sdk.resource.SignatureRequest: Returns true if this request has an ID.
hasId() - Method in class com.hellosign.sdk.resource.support.Signature
hasId() - Method in class com.hellosign.sdk.resource.Template
hasId() - Method in class com.hellosign.sdk.resource.TemplateDraft: Returns true if this request has an ID.
hasMessage() - Method in class com.hellosign.sdk.resource.AbstractRequest
hasMessage() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
hasMessage() - Method in class com.hellosign.sdk.resource.Template
hasMessage() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
hasName() - Method in class com.hellosign.sdk.resource.ApiApp: True if the name is set for this API App.
hasName() - Method in class com.hellosign.sdk.resource.support.Document
hasName() - Method in class com.hellosign.sdk.resource.support.FormField
hasName() - Method in class com.hellosign.sdk.resource.support.Signature
hasRedirectUrl() - Method in class com.hellosign.sdk.resource.AbstractRequest
hasRedirectUrl() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
hasRedirectUrl() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
hasRelatedSignatureId() - Method in class com.hellosign.sdk.resource.Event: Utility method to determine if this event has a related signature ID.
hasRequesterEmail() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
hasRoleCode() - Method in class com.hellosign.sdk.resource.Account
hasSignatureRequest() - Method in class com.hellosign.sdk.resource.Event: Returns true if this Event is associated with a Signature Request.
hasSignatureRequestId() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
hasString(String) - Static method in class com.hellosign.sdk.resource.AbstractResource
hasSubject() - Method in class com.hellosign.sdk.resource.AbstractRequest
hasSubject() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
hasSubject() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
hasTemplate() - Method in class com.hellosign.sdk.resource.Event: Returns true if this event is associated with a Template.
hasTitle() - Method in class com.hellosign.sdk.resource.AbstractRequest
hasTitle() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
hasTitle() - Method in class com.hellosign.sdk.resource.Template
hasTitle() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
hasUsePreexistingFields() - Method in class com.hellosign.sdk.resource.AbstractRequest
hasUseTextTags() - Method in class com.hellosign.sdk.resource.AbstractRequest
hasUseTextTags() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Not implemented for templates.
hasWebsiteCredentials() - Method in class com.hellosign.sdk.http.Authentication: Returns true if an email and password have been set.
HelloSignClient - Class in com.hellosign.sdk: You'll need the HelloSignClient to do just about everything, from creating signatures to updating account information.
HelloSignClient(String) - Constructor for class com.hellosign.sdk.HelloSignClient: Creates a new HelloSign client using your API key.
HelloSignClient(String, String) - Constructor for class com.hellosign.sdk.HelloSignClient: Creates a new HelloSign client using your website account's email address and password.
HelloSignClient(Authentication) - Constructor for class com.hellosign.sdk.HelloSignClient: Create a client with the provided authentication object.
HelloSignException - Exception in com.hellosign.sdk: This class wraps all hellosign-java-sdk exceptions.
HelloSignException(Exception) - Constructor for exception com.hellosign.sdk.HelloSignException
HelloSignException(String) - Constructor for exception com.hellosign.sdk.HelloSignException
HelloSignException(String, Throwable) - Constructor for exception com.hellosign.sdk.HelloSignException
HelloSignException(String, Integer, String) - Constructor for exception com.hellosign.sdk.HelloSignException
HelloSignException(String, Integer, String, Exception) - Constructor for exception com.hellosign.sdk.HelloSignException
hexArray - Static variable in class com.hellosign.sdk.resource.Event
HttpDeleteRequest - Class in com.hellosign.sdk.http
HttpDeleteRequest(String) - Constructor for class com.hellosign.sdk.http.HttpDeleteRequest
HttpDeleteRequest(String, Authentication) - Constructor for class com.hellosign.sdk.http.HttpDeleteRequest
HttpGetRequest - Class in com.hellosign.sdk.http
HttpGetRequest(String) - Constructor for class com.hellosign.sdk.http.HttpGetRequest
HttpGetRequest(String, Authentication) - Constructor for class com.hellosign.sdk.http.HttpGetRequest
HttpGetRequest(String, Map<String, String>) - Constructor for class com.hellosign.sdk.http.HttpGetRequest
HttpGetRequest(String, Map<String, String>, Authentication) - Constructor for class com.hellosign.sdk.http.HttpGetRequest
HttpPostRequest - Class in com.hellosign.sdk.http: This utility class provides an abstraction layer for sending multipart HTTP POST requests to a web server.
HttpPostRequest(String) - Constructor for class com.hellosign.sdk.http.HttpPostRequest
HttpPostRequest(String, Authentication) - Constructor for class com.hellosign.sdk.http.HttpPostRequest
HttpPostRequest(String, Map<String, Serializable>) - Constructor for class com.hellosign.sdk.http.HttpPostRequest
HttpPostRequest(String, Map<String, Serializable>, Authentication) - Constructor for class com.hellosign.sdk.http.HttpPostRequest
HttpPutRequest - Class in com.hellosign.sdk.http
HttpPutRequest(String) - Constructor for class com.hellosign.sdk.http.HttpPutRequest
HttpPutRequest(String, Authentication) - Constructor for class com.hellosign.sdk.http.HttpPutRequest
HttpPutRequest(String, Map<String, Serializable>, Authentication) - Constructor for class com.hellosign.sdk.http.HttpPutRequest
HttpPutRequest(String, Map<String, Serializable>) - Constructor for class com.hellosign.sdk.http.HttpPutRequest

I

inviteTeamMember(String) - Method in class com.hellosign.sdk.HelloSignClient: Adds the user to the current user's team.
isAccountValid(String) - Method in class com.hellosign.sdk.HelloSignClient: Returns true if an account exists with the provided email address.
isApproved() - Method in class com.hellosign.sdk.resource.ApiApp: Boolean to indicate if the app has been approved.
isComplete() - Method in class com.hellosign.sdk.resource.SignatureRequest: Returns the HelloSign-designated signature status, indicating whether all signers have signed the document.
isCreator() - Method in class com.hellosign.sdk.resource.Template
isEmbedded() - Method in class com.hellosign.sdk.resource.Template: Returns true if this template was created on a site other than hellosign.com.
isForEmbeddedSigning() - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Returns true if this Unclaimed Draft is to be embedded.
isHidingTextTags() - Method in class com.hellosign.sdk.resource.AbstractRequest
isHidingTextTags() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Not implemented for templates.
isOnline() - Method in class com.hellosign.sdk.HelloSignClient: Performs a simple call to the HelloSign API to see if it's available with the given credentials.
isPaidHF() - Method in class com.hellosign.sdk.resource.Account
isPaidHS() - Method in class com.hellosign.sdk.resource.Account
isTestMode() - Method in class com.hellosign.sdk.resource.AbstractRequest
isTestMode() - Method in class com.hellosign.sdk.resource.EmbeddedRequest
isTestMode() - Method in class com.hellosign.sdk.resource.UnclaimedDraft
isUsingPreexistingFields() - Method in class com.hellosign.sdk.resource.AbstractRequest
isUsingTextTags() - Method in class com.hellosign.sdk.resource.AbstractRequest
isUsingTextTags() - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Not implemented for templates.
isValid(String) - Method in class com.hellosign.sdk.resource.Event: Returns true if the event hash matches the computed hash using the provided API key.
iterator() - Method in class com.hellosign.sdk.resource.AbstractResourceList

L

LIST_INFO - Static variable in class com.hellosign.sdk.resource.AbstractResourceList

M

Metadata - Class in com.hellosign.sdk.resource.support
Metadata() - Constructor for class com.hellosign.sdk.resource.support.Metadata
Metadata(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.Metadata
METADATA_KEY - Static variable in class com.hellosign.sdk.resource.support.Metadata
method - Variable in class com.hellosign.sdk.http.HttpPostRequest
method - Variable in class com.hellosign.sdk.http.HttpPutRequest

N

NUM_PAGES - Static variable in class com.hellosign.sdk.resource.AbstractResourceList
NUM_RESULTS - Static variable in class com.hellosign.sdk.resource.AbstractResourceList

O

OAUTH_CODE - Static variable in class com.hellosign.sdk.HelloSignClient
OAUTH_DATA - Static variable in class com.hellosign.sdk.resource.Account
OAUTH_GRANT_TYPE - Static variable in class com.hellosign.sdk.HelloSignClient
OAUTH_GRANT_TYPE_AUTHORIZE_CODE - Static variable in class com.hellosign.sdk.HelloSignClient
OAUTH_GRANT_TYPE_REFRESH_TOKEN - Static variable in class com.hellosign.sdk.HelloSignClient
OAUTH_REFRESH_TOKEN - Static variable in class com.hellosign.sdk.HelloSignClient
OAUTH_STATE - Static variable in class com.hellosign.sdk.HelloSignClient
OauthData - Class in com.hellosign.sdk.resource.support
OauthData(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.OauthData

P

PAGE - Static variable in class com.hellosign.sdk.resource.AbstractResourceList
PAGE_SIZE - Static variable in class com.hellosign.sdk.resource.AbstractResourceList

Q

QUOTA_API_SIG_REQUESTS_LEFT - Static variable in class com.hellosign.sdk.resource.support.Quotas
QUOTA_DOCUMENTS_LEFT - Static variable in class com.hellosign.sdk.resource.support.Quotas
QUOTA_TEMPLATES_LEFT - Static variable in class com.hellosign.sdk.resource.support.Quotas
Quotas - Class in com.hellosign.sdk.resource.support
Quotas(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.Quotas
QUOTAS_KEY - Static variable in class com.hellosign.sdk.resource.support.Quotas

R

refreshOauthData(String) - Method in class com.hellosign.sdk.HelloSignClient: Refreshes the OauthData for this client with the provided refresh token.
RELATED_SIGNATURE_ID - Static variable in class com.hellosign.sdk.resource.Event
removeScope(ApiAppOauthScopeType) - Method in class com.hellosign.sdk.resource.ApiApp: Remove the specified OAuth scope from this API App.
removeScope(ApiAppOauthScopeType) - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: Remove the specified OAuth scope from this API App.
removeSigner(String) - Method in class com.hellosign.sdk.resource.SignatureRequest: Removes the signer from the list.
removeSignerByEmail(String) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Removes signer(s) from this request by email address.
removeSignerRole(String) - Method in class com.hellosign.sdk.resource.TemplateDraft: Removes the signer role.
removeTeamMember(String) - Method in class com.hellosign.sdk.HelloSignClient: Removes the team member indicated by the user account ID or email address.
removeTemplateUser(String, String) - Method in class com.hellosign.sdk.HelloSignClient: Adds the provided user to the template indicated by the provided template ID.
REPORTED_FOR_ACCOUNT_ID - Static variable in class com.hellosign.sdk.resource.Event
REQUEST_HIDE_TEXT_TAGS - Static variable in class com.hellosign.sdk.resource.AbstractRequest
REQUEST_MESSAGE - Static variable in class com.hellosign.sdk.resource.AbstractRequest
REQUEST_METADATA - Static variable in class com.hellosign.sdk.resource.AbstractRequest
REQUEST_REDIRECT_URL - Static variable in class com.hellosign.sdk.resource.AbstractRequest
REQUEST_SUBJECT - Static variable in class com.hellosign.sdk.resource.AbstractRequest
REQUEST_TEST_MODE - Static variable in class com.hellosign.sdk.resource.AbstractRequest
REQUEST_TITLE - Static variable in class com.hellosign.sdk.resource.AbstractRequest
REQUEST_USE_PREEXISTING_FIELDS - Static variable in class com.hellosign.sdk.resource.AbstractRequest
REQUEST_USE_TEXT_TAGS - Static variable in class com.hellosign.sdk.resource.AbstractRequest
requestEmailReminder(String, String) - Method in class com.hellosign.sdk.HelloSignClient: Instructs HelloSign to email the given address with a reminder to sign the SignatureRequest referenced by the given request ID.
ResponseData - Class in com.hellosign.sdk.resource.support: This class represents the "response_data" portion of SignatureRequest objects.
ResponseData() - Constructor for class com.hellosign.sdk.resource.support.ResponseData
ResponseData(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.ResponseData
RoleType - Enum in com.hellosign.sdk.resource.support.types: The MIT License (MIT) Copyright (C) 2015 hellosign.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

S

sendSignatureRequest(SignatureRequest) - Method in class com.hellosign.sdk.HelloSignClient: Sends the provided signature request to HelloSign.
sendTemplateSignatureRequest(TemplateSignatureRequest) - Method in class com.hellosign.sdk.HelloSignClient: Creates a new Signature Request based on the template provided.
set(String, Object) - Method in class com.hellosign.sdk.resource.AbstractResource
set(String, String) - Method in class com.hellosign.sdk.resource.support.Metadata
setAccessCode(String) - Method in class com.hellosign.sdk.resource.support.Signer
setAccessToken(String, String) - Method in class com.hellosign.sdk.HelloSignClient: Sets the access token for the OAuth user that this client will use to perform requests.
setAccessToken(String, String) - Method in class com.hellosign.sdk.http.Authentication: Sets the access token for the HelloSign client authentication.
setApiId(String) - Method in class com.hellosign.sdk.resource.support.FormField
setApiId(String) - Method in class com.hellosign.sdk.resource.support.ResponseData
setApiKey(String) - Method in class com.hellosign.sdk.http.Authentication: Sets the API key to use for authenticating this client.
setCallback(String) - Method in class com.hellosign.sdk.HelloSignClient: Updates the current user's callback URL.
setCallbackUrl(String) - Method in class com.hellosign.sdk.resource.ApiApp: Set the callback URL for this API app's events.
setCallbackUrl(String) - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: Set this API app OAuth callback.
setCC(String, String) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Sets the CC email address for the provided role.
setCCs(Map<String, String>) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Overwrites the map of roles to CC email addresses.
setClientId(String) - Method in class com.hellosign.sdk.resource.EmbeddedRequest: Set the client ID of the web app you're using to create this embedded signature request.
setCustomFields(Map<String, String>) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Overwrites the current map of custom fields to the provided map.
setCustomFieldValue(String, String) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Adds the value to fill in for a custom field with the given field name.
setCustomLogo(File) - Method in class com.hellosign.sdk.resource.ApiApp: Add a custom logo image to this API app.
setDocuments(List<Document>) - Method in class com.hellosign.sdk.resource.AbstractRequest: Overwrites this requests document list with the provided document list.
setDomain(String) - Method in class com.hellosign.sdk.resource.ApiApp: Set this API app's domain.
setEmail(String) - Method in class com.hellosign.sdk.resource.support.Signer
setFile(File) - Method in class com.hellosign.sdk.resource.support.Document: Sets the file associated with this document.
setFileUrls(List<String>) - Method in class com.hellosign.sdk.resource.AbstractRequest: Overwrite the current file_url list.
setFormFields(List<FormField>) - Method in class com.hellosign.sdk.resource.support.Document: Overwrites the form fields for this document.
setHeight(Integer) - Method in class com.hellosign.sdk.resource.support.FormField
setHideTextTags(boolean) - Method in class com.hellosign.sdk.resource.AbstractRequest
setHideTextTags(boolean) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Not implemented for templates.
setIndex(Integer) - Method in class com.hellosign.sdk.resource.support.Document
setIsForEmbeddedSigning(boolean) - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Sets whether this Unclaimed Draft is to be embedded.
setMessage(String) - Method in class com.hellosign.sdk.resource.AbstractRequest
setMessage(String) - Method in class com.hellosign.sdk.resource.EmbeddedRequest
setMessage(String) - Method in class com.hellosign.sdk.resource.UnclaimedDraft
setName(String) - Method in class com.hellosign.sdk.resource.ApiApp: Set this API app's name.
setName(String) - Method in class com.hellosign.sdk.resource.support.Document
setName(String) - Method in class com.hellosign.sdk.resource.support.FormField
setName(String) - Method in class com.hellosign.sdk.resource.support.ResponseData
setNameOrRole(String) - Method in class com.hellosign.sdk.resource.support.Signer
setOAuthCallbackUrl(String) - Method in class com.hellosign.sdk.resource.ApiApp
setOrderMatters(boolean) - Method in class com.hellosign.sdk.resource.AbstractRequest: Determines whether the order of the signers list is to be enforced.
setRedirectUrl(String) - Method in class com.hellosign.sdk.resource.AbstractRequest
setRedirectUrl(String) - Method in class com.hellosign.sdk.resource.EmbeddedRequest
setRedirectUrl(String) - Method in class com.hellosign.sdk.resource.UnclaimedDraft
setRequest(AbstractRequest) - Method in class com.hellosign.sdk.resource.EmbeddedRequest: Set the AbstractRequest associated with this Embedded signature request.
setRequest(AbstractRequest) - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Sets the associated request object from which this unclaimed draft will be created.
setRequesterEmail(String) - Method in class com.hellosign.sdk.resource.UnclaimedDraft
setRequired(Boolean) - Method in class com.hellosign.sdk.resource.support.FormField
setScopes(Set<ApiAppOauthScopeType>) - Method in class com.hellosign.sdk.resource.ApiApp: Set this API app's OAuth scopes.
setScopes(Set<ApiAppOauthScopeType>) - Method in class com.hellosign.sdk.resource.support.ApiAppOauth: Set this API app's OAuth scopes.
setSignatureId(String) - Method in class com.hellosign.sdk.resource.support.ResponseData
setSigner(Integer) - Method in class com.hellosign.sdk.resource.support.FormField
setSigner(String, String, String) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Adds the signer to the list of signers for this request.
setSignerRoles(List<String>) - Method in class com.hellosign.sdk.resource.TemplateDraft: Overwrites the current list of signer roles.
setSigners(List<Signer>) - Method in class com.hellosign.sdk.resource.SignatureRequest: Overwrites the current list of signers for this request with the given list.
setSigners(Map<String, Signer>) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Overwrites the current list of signers for this request with the given list.
setSubject(String) - Method in class com.hellosign.sdk.resource.AbstractRequest
setSubject(String) - Method in class com.hellosign.sdk.resource.EmbeddedRequest
setSubject(String) - Method in class com.hellosign.sdk.resource.UnclaimedDraft
setTemplateId(String) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Set the template ID of the template that should be used with this request.
setTestMode(boolean) - Method in class com.hellosign.sdk.resource.AbstractRequest
setTestMode(boolean) - Method in class com.hellosign.sdk.resource.EmbeddedRequest
setTestMode(boolean) - Method in class com.hellosign.sdk.resource.UnclaimedDraft
setTitle(String) - Method in class com.hellosign.sdk.resource.AbstractRequest
setTitle(String) - Method in class com.hellosign.sdk.resource.EmbeddedRequest
setTitle(String) - Method in class com.hellosign.sdk.resource.UnclaimedDraft
setType(FieldType) - Method in class com.hellosign.sdk.resource.support.FormField
setType(FieldType) - Method in class com.hellosign.sdk.resource.support.ResponseData
setType(UnclaimedDraftType) - Method in class com.hellosign.sdk.resource.UnclaimedDraft: Sets the unclaimed draft type.
setUsePreexistingFields(boolean) - Method in class com.hellosign.sdk.resource.AbstractRequest
setUseTextTags(boolean) - Method in class com.hellosign.sdk.resource.AbstractRequest
setUseTextTags(boolean) - Method in class com.hellosign.sdk.resource.TemplateSignatureRequest: Not implemented for templates.
setValue(Object) - Method in class com.hellosign.sdk.resource.support.ResponseData
setWebsiteCredentials(String, String) - Method in class com.hellosign.sdk.http.Authentication: Sets the email and password to use for authenticating the client.
setWidth(Integer) - Method in class com.hellosign.sdk.resource.support.FormField
setX(Integer) - Method in class com.hellosign.sdk.resource.support.FormField
setY(Integer) - Method in class com.hellosign.sdk.resource.support.FormField
Signature - Class in com.hellosign.sdk.resource.support: POJO that stores information related to a signature captured on a HelloSign SignatureRequest.
Signature() - Constructor for class com.hellosign.sdk.resource.support.Signature
Signature(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.Signature
SignatureRequest - Class in com.hellosign.sdk.resource: Represents a HelloSign signature request.
SignatureRequest() - Constructor for class com.hellosign.sdk.resource.SignatureRequest
SignatureRequest(JSONObject) - Constructor for class com.hellosign.sdk.resource.SignatureRequest
SignatureRequest(JSONObject, String) - Constructor for class com.hellosign.sdk.resource.SignatureRequest
SignatureRequestList - Class in com.hellosign.sdk.resource.support: Represents a paged list of SignatureRequests returned from HelloSign.
SignatureRequestList(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.SignatureRequestList
SignatureStatus - Enum in com.hellosign.sdk.resource.support.types: The MIT License (MIT) Copyright (C) 2015 hellosign.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
Signer - Class in com.hellosign.sdk.resource.support: Class that stores signer information for a signature request.
Signer() - Constructor for class com.hellosign.sdk.resource.support.Signer
Signer(String, String) - Constructor for class com.hellosign.sdk.resource.support.Signer
SIGNER_ROLE_NAME - Static variable in class com.hellosign.sdk.resource.support.TemplateRole
SIGNER_ROLE_ORDER - Static variable in class com.hellosign.sdk.resource.support.TemplateRole
SIGREQ_CCS - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_DETAILS_URL - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_FILES - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_FILES_URL - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_FINAL_COPY_URL - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_FORM_FIELDS - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_FORMAT_PDF - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_FORMAT_ZIP - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_HAS_ERROR - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_ID - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_IS_COMPLETE - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_KEY - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_RESPONSE_DATA - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_SIGNER_EMAIL - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_SIGNER_NAME - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_SIGNER_ORDER - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_SIGNER_PIN - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_SIGNERS - Static variable in class com.hellosign.sdk.resource.SignatureRequest
SIGREQ_SIGNING_URL - Static variable in class com.hellosign.sdk.resource.SignatureRequest

T

Team - Class in com.hellosign.sdk.resource
Team() - Constructor for class com.hellosign.sdk.resource.Team
Team(JSONObject) - Constructor for class com.hellosign.sdk.resource.Team
TEAM_ACCOUNTS - Static variable in class com.hellosign.sdk.resource.Team
TEAM_INVITEES - Static variable in class com.hellosign.sdk.resource.Team
TEAM_KEY - Static variable in class com.hellosign.sdk.resource.Team
TEAM_NAME - Static variable in class com.hellosign.sdk.resource.Team
Template - Class in com.hellosign.sdk.resource: POJO that represents a HelloSign Template resource.
Template() - Constructor for class com.hellosign.sdk.resource.Template
Template(JSONObject) - Constructor for class com.hellosign.sdk.resource.Template
TEMPLATE_ACCOUNTS - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_CAN_EDIT - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_CC_ROLES - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_CUSTOM_FIELDS - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_DOCUMENTS - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_DRAFT_ID - Static variable in class com.hellosign.sdk.resource.TemplateDraft
TEMPLATE_DRAFT_KEY - Static variable in class com.hellosign.sdk.resource.TemplateDraft
TEMPLATE_EDIT_URL - Static variable in class com.hellosign.sdk.resource.TemplateDraft
TEMPLATE_EXPIRES_AT - Static variable in class com.hellosign.sdk.resource.TemplateDraft
TEMPLATE_ID - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_IS_CREATOR - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_IS_EMBEDDED - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_KEY - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_MESSAGE - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_SIGNER_ROLES - Static variable in class com.hellosign.sdk.resource.Template
TEMPLATE_TITLE - Static variable in class com.hellosign.sdk.resource.Template
TemplateDraft - Class in com.hellosign.sdk.resource: Represents a HelloSign template draft.
TemplateDraft() - Constructor for class com.hellosign.sdk.resource.TemplateDraft
TemplateDraft(JSONObject) - Constructor for class com.hellosign.sdk.resource.TemplateDraft
TemplateList - Class in com.hellosign.sdk.resource.support: Represents a paged list of HelloSign Templates (a.k.a., ReusableForms).
TemplateList(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.TemplateList
TemplateRole - Class in com.hellosign.sdk.resource.support: Resource class that represents a signer or CC role for a Template.
TemplateRole(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.TemplateRole
TemplateSignatureRequest - Class in com.hellosign.sdk.resource: Represents a HelloSign signature request based on one or more Templates.
TemplateSignatureRequest() - Constructor for class com.hellosign.sdk.resource.TemplateSignatureRequest
TemplateSignatureRequest(Template) - Constructor for class com.hellosign.sdk.resource.TemplateSignatureRequest: Convenience constructor that accepts a single Template.
TemplateSignatureRequest(List<Template>) - Constructor for class com.hellosign.sdk.resource.TemplateSignatureRequest: Convenience constructor that accepts a list of Templates.
toString() - Method in class com.hellosign.sdk.resource.AbstractResource
toString() - Method in class com.hellosign.sdk.resource.Event: Displays the Signature Request in addition to the Event data.
toString() - Method in class com.hellosign.sdk.resource.support.Warning

U

UNCLAIMED_DRAFT_CLAIM_URL - Static variable in class com.hellosign.sdk.resource.UnclaimedDraft
UNCLAIMED_DRAFT_IS_FOR_EMBEDDED_SIGNING - Static variable in class com.hellosign.sdk.resource.UnclaimedDraft
UNCLAIMED_DRAFT_KEY - Static variable in class com.hellosign.sdk.resource.UnclaimedDraft
UNCLAIMED_DRAFT_REQUESTER_EMAIL - Static variable in class com.hellosign.sdk.resource.UnclaimedDraft
UNCLAIMED_DRAFT_SIGNATURE_REQUEST_ID - Static variable in class com.hellosign.sdk.resource.UnclaimedDraft
UNCLAIMED_DRAFT_TYPE - Static variable in class com.hellosign.sdk.resource.UnclaimedDraft
UnclaimedDraft - Class in com.hellosign.sdk.resource: Represents an unclaimed draft response and request.
UnclaimedDraft() - Constructor for class com.hellosign.sdk.resource.UnclaimedDraft: Default constructor.
UnclaimedDraft(AbstractRequest) - Constructor for class com.hellosign.sdk.resource.UnclaimedDraft: Creates an unclaimed draft with the provided AbstractRequest, and defaults the type to UnclaimedDraftType.send_document.
UnclaimedDraft(AbstractRequest, UnclaimedDraftType) - Constructor for class com.hellosign.sdk.resource.UnclaimedDraft: Creates an unclaimed draft with the provided AbstractRequest and UnclaimedDraftType.
UnclaimedDraft(JSONObject) - Constructor for class com.hellosign.sdk.resource.UnclaimedDraft: Constructor to provide a way to store the API response JSON information.
UnclaimedDraftType - Enum in com.hellosign.sdk.resource.support.types: The MIT License (MIT) Copyright (C) 2015 hellosign.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
updateApiApp(ApiApp) - Method in class com.hellosign.sdk.HelloSignClient: Updates the API app with the given ApiApp object properties.
updateTeamName(String) - Method in class com.hellosign.sdk.HelloSignClient: Updates the current user's team name.
url - Variable in class com.hellosign.sdk.http.AbstractHttpRequest
USER_AGENT - Static variable in class com.hellosign.sdk.http.AbstractHttpRequest

V

validate(JSONObject, int) - Static method in class com.hellosign.sdk.http.AbstractHttpRequest
valueOf(String) - Static method in enum com.hellosign.sdk.resource.support.types.ApiAppOauthScopeType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hellosign.sdk.resource.support.types.EventType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hellosign.sdk.resource.support.types.FieldType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hellosign.sdk.resource.support.types.RoleType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hellosign.sdk.resource.support.types.SignatureStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hellosign.sdk.resource.support.types.UnclaimedDraftType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.hellosign.sdk.resource.support.types.ApiAppOauthScopeType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hellosign.sdk.resource.support.types.EventType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hellosign.sdk.resource.support.types.FieldType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hellosign.sdk.resource.support.types.RoleType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hellosign.sdk.resource.support.types.SignatureStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hellosign.sdk.resource.support.types.UnclaimedDraftType: Returns an array containing the constants of this enum type, in the order they are declared.

W

Warning - Class in com.hellosign.sdk.resource.support
Warning(JSONObject) - Constructor for class com.hellosign.sdk.resource.support.Warning
WARNING_MESSAGE - Static variable in class com.hellosign.sdk.resource.support.Warning
WARNING_NAME - Static variable in class com.hellosign.sdk.resource.support.Warning
warnings - Variable in class com.hellosign.sdk.resource.AbstractResource

A C D E F G H I L M N O P Q R S T U V W