com.hellosign.sdk.resource

Class Event

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.Event

public class Event
extends AbstractResource

This is a utility class for assisting with the development of callback services to respond to HelloSign events.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_HASH
static String	EVENT_KEY
static String	EVENT_MESSAGE
static String	EVENT_METADATA
static String	EVENT_TIME
static String	EVENT_TYPE
static String	HASH_ALGORITHM
protected static char[]	hexArray
static String	RELATED_SIGNATURE_ID
static String	REPORTED_FOR_ACCOUNT_ID
static String	REPORTED_FOR_APP_ID

Fields inherited from class com.hellosign.sdk.resource.AbstractResource

dataObj, warnings

Constructor Summary

Constructors

Constructor and Description
Event(org.json.JSONObject json) Default constructor.

Method Summary

Modifier and Type	Method and Description
String	getAccountId() Returns the account ID that this event is reporting for.
String	getAppId() Returns the API app ID for which this event is reported.
Date	getEventDate() Returns the event time as a Java Date object.
String	getEventMessage() Returns the message if any from the event
String	getHash() Returns the unique hash string identifying this event.
Signature	getRelatedSignature() Returns the associated Signature object with this event, if the event is associated with a Signature Request.
String	getRelatedSignatureId() Returns the signature ID to which this event is associated.
SignatureRequest	getSignatureRequest() Returns a reference to the SignatureRequest that is attached to the Event.
Template	getTemplate() Returns a reference to the Template that is attached to the Event.
EventType	getType() Returns the EventType for this event.
String	getTypeString() Returns the event type String.
boolean	hasAccountId() Returns true if this event has a "reported_for_account_id" field.
boolean	hasAppId() Returns true if this event has a "reported_for_app_id" field.
boolean	hasRelatedSignatureId() Utility method to determine if this event has a related signature ID.
boolean	hasSignatureRequest() Returns true if this Event is associated with a Signature Request.
boolean	hasTemplate() Returns true if this event is associated with a Template.
boolean	isValid(String apiKey) Returns true if the event hash matches the computed hash using the provided API key.
String	toString() Displays the Signature Request in addition to the Event data.

Methods inherited from class com.hellosign.sdk.resource.AbstractResource

add, addToList, clearList, get, getBoolean, getConstructor, getDate, getInteger, getJSONObject, getList, getList, getLong, getString, getWarnings, has, hasString, set, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_KEY

public static final String EVENT_KEY

See Also:

Constant Field Values

EVENT_METADATA

public static final String EVENT_METADATA

See Also:

Constant Field Values

REPORTED_FOR_ACCOUNT_ID

public static final String REPORTED_FOR_ACCOUNT_ID

See Also:

Constant Field Values

REPORTED_FOR_APP_ID

public static final String REPORTED_FOR_APP_ID

See Also:

Constant Field Values

RELATED_SIGNATURE_ID

public static final String RELATED_SIGNATURE_ID

See Also:

Constant Field Values

EVENT_TYPE

public static final String EVENT_TYPE

See Also:

Constant Field Values

EVENT_TIME

public static final String EVENT_TIME

See Also:

Constant Field Values

EVENT_HASH

public static final String EVENT_HASH

See Also:

Constant Field Values

EVENT_MESSAGE

public static final String EVENT_MESSAGE

See Also:

Constant Field Values

HASH_ALGORITHM

public static final String HASH_ALGORITHM

See Also:

Constant Field Values

hexArray

protected static final char[] hexArray

Constructor Detail

Event

public Event(org.json.JSONObject json)
      throws HelloSignException

Default constructor. Provide this constructor with the JSONObject created from the API response.

Parameters:

json - JSONObject

Throws:

HelloSignException - thrown if there is a problem parsing the JSONObject.

Method Detail

getAccountId

public String getAccountId()
                    throws HelloSignException

Returns the account ID that this event is reporting for.

Returns:

String

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSON object.

hasAccountId

public boolean hasAccountId()
                     throws HelloSignException

Returns true if this event has a "reported_for_account_id" field.

Returns:

true or false if it does not have an account ID

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSONObject.

getAppId

public String getAppId()
                throws HelloSignException

Returns the API app ID for which this event is reported.

Returns:

String

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSONObject.

hasAppId

public boolean hasAppId()
                 throws HelloSignException

Returns true if this event has a "reported_for_app_id" field.

Returns:

boolean

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSONObject.

getEventDate

public Date getEventDate()

Returns the event time as a Java Date object.

Returns:

Date

getEventMessage

public String getEventMessage()
                       throws HelloSignException

Returns the message if any from the event

Returns:

String

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSONObject.

getRelatedSignatureId

public String getRelatedSignatureId()
                             throws HelloSignException

Returns the signature ID to which this event is associated.

Returns:

String

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSONObject.

hasRelatedSignatureId

public boolean hasRelatedSignatureId()

Utility method to determine if this event has a related signature ID.

Returns:

true if this field exists and is set, false otherwise

getRelatedSignature

public Signature getRelatedSignature()
                              throws HelloSignException

Returns the associated Signature object with this event, if the event is associated with a Signature Request.

Returns:

Signature

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSONObject.

getSignatureRequest

public SignatureRequest getSignatureRequest()

Returns a reference to the SignatureRequest that is attached to the Event.

Returns:

SignatureRequest

hasSignatureRequest

public boolean hasSignatureRequest()

Returns true if this Event is associated with a Signature Request.

Returns:

boolean

getTemplate

public Template getTemplate()

Returns a reference to the Template that is attached to the Event.

Returns:

Template

hasTemplate

public boolean hasTemplate()

Returns true if this event is associated with a Template.

Returns:

boolean

getType

public EventType getType()

Returns the EventType for this event.

Returns:

EventType enum

getTypeString

public String getTypeString()

Returns the event type String.

Returns:

String event type

getHash

public String getHash()

Returns the unique hash string identifying this event.

Returns:

String hash

isValid

public boolean isValid(String apiKey)
                throws HelloSignException

Returns true if the event hash matches the computed hash using the provided API key.

Parameters:

apiKey - String api key.

Returns:

true if the hashes match, false otherwise

Throws:

HelloSignException - thrown if there is a problem parsing the API key.

toString

public String toString()

Displays the Signature Request in addition to the Event data.

Overrides:

toString in class AbstractResource