com.hellosign.sdk.resource

Class ApiApp

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.ApiApp

public class ApiApp
extends AbstractResource

Contains information about an API App

Author:

"Chris Paul ([email protected])"

Field Summary

Fields

Modifier and Type	Field and Description
static String	APIAPP_CALLBACK_URL
static String	APIAPP_CLIENT_ID
static String	APIAPP_CREATED_AT
static String	APIAPP_DOMAIN
static String	APIAPP_IS_APPROVED
static String	APIAPP_KEY
static String	APIAPP_NAME
static String	APIAPP_OWNER_ACCOUNT

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

dataObj, warnings

Constructor Summary

Constructors

Constructor and Description
ApiApp() Default constructor.
ApiApp(org.json.JSONObject json) Constructor that instantiates an ApiApp object based on the JSON response from the HelloSign API.

Method Summary

Methods

Modifier and Type	Method and Description
void	addScope(ApiAppOauthScopeType scope) Add a scope to this API App's OAuth scope list.
void	clearScopes() Clear all OAuth scopes for this API App.
String	getCallbackUrl() The app's callback URL (for events).
String	getClientId() The app's client ID.
Date	getCreatedAt() The time that the app was created.
String	getDomain() The domain name associated with the app.
String	getName() The name of the app.
ApiAppOauth	getOauthInfo() An object describing the app's OAuth properties.
Account	getOwnerAccount() An object describing the app's owner.
Map<String,Serializable>	getPostFields() Internal method used to retrieve the necessary POST fields to submit the API app to HelloSign.
Boolean	hasCallbackUrl() True if the callback URL is non-null.
boolean	hasClientId() Returns true if this app has a client ID.
Boolean	hasDomain() True if the domain has been set.
Boolean	hasName() True if the name is set for this API App.
Boolean	isApproved() Boolean to indicate if the app has been approved.
void	removeScope(ApiAppOauthScopeType scope) Remove the specified OAuth scope from this API App.
void	setCallbackUrl(String url) Set the callback URL for this API app's events.
void	setCustomLogo(File f) Add a custom logo image to this API app.
void	setDomain(String domain) Set this API app's domain.
void	setName(String name) Set this API app's name.
void	setOAuthCallbackUrl(String url)
void	setScopes(Set<ApiAppOauthScopeType> scopes) Set this API app's OAuth scopes.

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

APIAPP_KEY

public static final String APIAPP_KEY

See Also:

Constant Field Values

APIAPP_CALLBACK_URL

public static final String APIAPP_CALLBACK_URL

See Also:

Constant Field Values

APIAPP_CLIENT_ID

public static final String APIAPP_CLIENT_ID

See Also:

Constant Field Values

APIAPP_CREATED_AT

public static final String APIAPP_CREATED_AT

See Also:

Constant Field Values

APIAPP_DOMAIN

public static final String APIAPP_DOMAIN

See Also:

Constant Field Values

APIAPP_IS_APPROVED

public static final String APIAPP_IS_APPROVED

See Also:

Constant Field Values

APIAPP_NAME

public static final String APIAPP_NAME

See Also:

Constant Field Values

APIAPP_OWNER_ACCOUNT

public static final String APIAPP_OWNER_ACCOUNT

See Also:

Constant Field Values

Constructor Detail

ApiApp

public ApiApp()

Default constructor.

ApiApp

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

Constructor that instantiates an ApiApp object based on the JSON response from the HelloSign API.

Parameters:

json - JSONObject

Throws:

HelloSignException

Method Detail

getCallbackUrl

public String getCallbackUrl()

The app's callback URL (for events).

Returns:

String callback URL or null

hasCallbackUrl

public Boolean hasCallbackUrl()

True if the callback URL is non-null.

Returns:

Boolean

setCallbackUrl

public void setCallbackUrl(String url)

Set the callback URL for this API app's events.

Parameters:

url - String

getClientId

public String getClientId()

The app's client ID.

Returns:

String client ID

hasClientId

public boolean hasClientId()

Returns true if this app has a client ID.

Returns:

boolean

getCreatedAt

public Date getCreatedAt()

The time that the app was created.

Returns:

Date

getDomain

public String getDomain()

The domain name associated with the app.

Returns:

String domain name

hasDomain

public Boolean hasDomain()

True if the domain has been set.

Returns:

Boolean

setDomain

public void setDomain(String domain)

Set this API app's domain.

Parameters:

domain - String

isApproved

public Boolean isApproved()

Boolean to indicate if the app has been approved.

Returns:

Boolean

getName

public String getName()

The name of the app.

Returns:

String name

hasName

public Boolean hasName()

True if the name is set for this API App.

Returns:

Boolean

setName

public void setName(String name)

Set this API app's name.

Parameters:

name - String

getOauthInfo

public ApiAppOauth getOauthInfo()

An object describing the app's OAuth properties.

Returns:

ApiAppOauth

setOAuthCallbackUrl

public void setOAuthCallbackUrl(String url)

setScopes

public void setScopes(Set<ApiAppOauthScopeType> scopes)

Set this API app's OAuth scopes.

Parameters:

scopes - List

addScope

public void addScope(ApiAppOauthScopeType scope)

Add a scope to this API App's OAuth scope list. Duplicates will be ignored.

Parameters:

scope - ApiAppOauthScopeType

clearScopes

public void clearScopes()

Clear all OAuth scopes for this API App.

removeScope

public void removeScope(ApiAppOauthScopeType scope)

Remove the specified OAuth scope from this API App.

Parameters:

scope - ApiAppOauthScopeType

getOwnerAccount

public Account getOwnerAccount()

An object describing the app's owner. NOTE: This Account object will only have the owner's account ID and email address. All other values will be null.

Returns:

Account

setCustomLogo

public void setCustomLogo(File f)

Add a custom logo image to this API app.

Parameters:

f - File

getPostFields

public Map<String,Serializable> getPostFields()
                                       throws HelloSignException

Internal method used to retrieve the necessary POST fields to submit the API app to HelloSign.

Returns:

Map

Throws:

HelloSignException