ApiApp (HelloSign Java SDK 4.0.12 API)

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_CUSTOM_LOGO`
`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`	`getHeaderBackgroundColor()` Get the signer page header background color.
`String`	`getLinkColor()` Get the signer page link color.
`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.
`String`	`getPageBackgroundColor()` Get the signer page background color.
`Map<String,Serializable>`	`getPostFields()` Internal method used to retrieve the necessary POST fields to submit the API app to HelloSign.
`String`	`getPrimaryButtonColor()` Get the signer page primary button color.
`String`	`getPrimaryButtonHoverColor()` Get the signer page primary button hover color.
`String`	`getPrimaryButtonTextColor()` Get the signer page primary button text color.
`String`	`getPrimaryButtonTextHoverColor()` Get the signer page primary button text hover color.
`String`	`getSecondaryButtonColor()` Get the signer page secondary button color.
`String`	`getSecondaryButtonHoverColor()` Get the signer page secondary button hover color.
`String`	`getSecondaryButtonTextColor()` Get the signer page secondary button text color.
`String`	`getSecondaryButtonTextHoverColor()` Get the signer page secondary button text hover color.
`String`	`getTextColor1()` Get the signer page text 1 color.
`String`	`getTextColor2()` Get the signer page text 2 color.
`WhiteLabelingOptions`	`getWhiteLabelingOptions()` Returns the current white labeling options for this API app.
`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`	`setHeaderBackgroundColor(String color)` Set the signer page header background color.
`void`	`setLinkColor(String color)` Set the signer page link color.
`void`	`setName(String name)` Set this API app's name.
`void`	`setOAuthCallbackUrl(String url)`
`void`	`setPageBackgroundColor(String color)` Set the signer page background color.
`void`	`setPrimaryButtonColor(String color)` Set the signer page primary button color.
`void`	`setPrimaryButtonHoverColor(String color)` Set the signer page primary button hover color.
`void`	`setPrimaryButtonTextColor(String color)` Set the signer page primary button text color.
`void`	`setPrimaryButtonTextHoverColor(String color)` Set the signer page primary button text hover color.
`void`	`setScopes(Set<ApiAppOauthScopeType> scopes)` Set this API app's OAuth scopes.
`void`	`setSecondaryButtonColor(String color)` Set the signer page secondary button color.
`void`	`setSecondaryButtonHoverColor(String color)` Set the signer page secondary button hover color.
`void`	`setSecondaryButtonTextColor(String color)` Set the signer page secondary button text color.
`void`	`setSecondaryButtonTextHoverColor(String color)` Set the signer page secondary button text hover color.
`void`	`setTextColor1(String color)` Set the signer page text 1 color.
`void`	`setTextColor2(String color)` Set the signer page text 2 color.
`void`	`setWhiteLabelingOptions(WhiteLabelingOptions options)` Overrides all white labeling options for this API app.

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, 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
  - APIAPP_CUSTOM_LOGO
```
public static final String APIAPP_CUSTOM_LOGO
```
    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 - thrown if there is a problem parsing the JSONObject
- 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 of ApiAppOauthScopeType
  - 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 - thrown if there is a problem serializing the POST fields.
  - setWhiteLabelingOptions
```
public void setWhiteLabelingOptions(WhiteLabelingOptions options)
```
    Overrides all white labeling options for this API app.
    
    Parameters:
    options - WhiteLabelingOptions
  - getWhiteLabelingOptions
```
public WhiteLabelingOptions getWhiteLabelingOptions()
```
    Returns the current white labeling options for this API app.
    
    Returns:
    WhiteLabelingOptions
  - getPageBackgroundColor
```
public String getPageBackgroundColor()
```
    Get the signer page background color.
    
    Returns:
    String hex color code
  - setPageBackgroundColor
```
public void setPageBackgroundColor(String color)
                            throws HelloSignException
```
    Set the signer page background color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getHeaderBackgroundColor
```
public String getHeaderBackgroundColor()
```
    Get the signer page header background color.
    
    Returns:
    String hex color code
  - setHeaderBackgroundColor
```
public void setHeaderBackgroundColor(String color)
                              throws HelloSignException
```
    Set the signer page header background color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getTextColor1
```
public String getTextColor1()
```
    Get the signer page text 1 color.
    
    Returns:
    String hex color code
  - setTextColor1
```
public void setTextColor1(String color)
                   throws HelloSignException
```
    Set the signer page text 1 color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getTextColor2
```
public String getTextColor2()
```
    Get the signer page text 2 color.
    
    Returns:
    String hex color code
  - setTextColor2
```
public void setTextColor2(String color)
                   throws HelloSignException
```
    Set the signer page text 2 color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getLinkColor
```
public String getLinkColor()
```
    Get the signer page link color.
    
    Returns:
    String hex color code
  - setLinkColor
```
public void setLinkColor(String color)
                  throws HelloSignException
```
    Set the signer page link color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getPrimaryButtonColor
```
public String getPrimaryButtonColor()
```
    Get the signer page primary button color.
    
    Returns:
    String hex color code
  - setPrimaryButtonColor
```
public void setPrimaryButtonColor(String color)
                           throws HelloSignException
```
    Set the signer page primary button color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getPrimaryButtonTextColor
```
public String getPrimaryButtonTextColor()
```
    Get the signer page primary button text color.
    
    Returns:
    String hex color code
  - setPrimaryButtonTextColor
```
public void setPrimaryButtonTextColor(String color)
                               throws HelloSignException
```
    Set the signer page primary button text color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getPrimaryButtonHoverColor
```
public String getPrimaryButtonHoverColor()
```
    Get the signer page primary button hover color.
    
    Returns:
    String hex color code
  - setPrimaryButtonHoverColor
```
public void setPrimaryButtonHoverColor(String color)
                                throws HelloSignException
```
    Set the signer page primary button hover color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getPrimaryButtonTextHoverColor
```
public String getPrimaryButtonTextHoverColor()
```
    Get the signer page primary button text hover color.
    
    Returns:
    String hex color code
  - setPrimaryButtonTextHoverColor
```
public void setPrimaryButtonTextHoverColor(String color)
                                    throws HelloSignException
```
    Set the signer page primary button text hover color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getSecondaryButtonColor
```
public String getSecondaryButtonColor()
```
    Get the signer page secondary button color.
    
    Returns:
    String hex color code
  - setSecondaryButtonColor
```
public void setSecondaryButtonColor(String color)
                             throws HelloSignException
```
    Set the signer page secondary button color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getSecondaryButtonTextColor
```
public String getSecondaryButtonTextColor()
```
    Get the signer page secondary button text color.
    
    Returns:
    String hex color code
  - setSecondaryButtonTextColor
```
public void setSecondaryButtonTextColor(String color)
                                 throws HelloSignException
```
    Set the signer page secondary button text color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getSecondaryButtonHoverColor
```
public String getSecondaryButtonHoverColor()
```
    Get the signer page secondary button hover color.
    
    Returns:
    String hex color code
  - setSecondaryButtonHoverColor
```
public void setSecondaryButtonHoverColor(String color)
                                  throws HelloSignException
```
    Set the signer page secondary button hover color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string
  - getSecondaryButtonTextHoverColor
```
public String getSecondaryButtonTextHoverColor()
```
    Get the signer page secondary button text hover color.
    
    Returns:
    String hex color code
  - setSecondaryButtonTextHoverColor
```
public void setSecondaryButtonTextHoverColor(String color)
                                      throws HelloSignException
```
    Set the signer page secondary button text hover color.
    
    Parameters:
    color - String hex color code
    
    Throws:
    
    HelloSignException - thrown if the color string is an invalid hex string

Class ApiApp

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

APIAPP_KEY

APIAPP_CALLBACK_URL

APIAPP_CLIENT_ID

APIAPP_CREATED_AT

APIAPP_DOMAIN

APIAPP_IS_APPROVED

APIAPP_NAME

APIAPP_OWNER_ACCOUNT

APIAPP_CUSTOM_LOGO

Constructor Detail

ApiApp

ApiApp

Method Detail

getCallbackUrl

hasCallbackUrl

setCallbackUrl

getClientId

hasClientId

getCreatedAt

getDomain

hasDomain

setDomain

isApproved

getName

hasName

setName

getOauthInfo

setOAuthCallbackUrl

setScopes

addScope

clearScopes

removeScope

getOwnerAccount

setCustomLogo

getPostFields

setWhiteLabelingOptions

getWhiteLabelingOptions

getPageBackgroundColor

setPageBackgroundColor

getHeaderBackgroundColor

setHeaderBackgroundColor

getTextColor1

setTextColor1

getTextColor2

setTextColor2

getLinkColor

setLinkColor

getPrimaryButtonColor

setPrimaryButtonColor

getPrimaryButtonTextColor

setPrimaryButtonTextColor

getPrimaryButtonHoverColor

setPrimaryButtonHoverColor

getPrimaryButtonTextHoverColor

setPrimaryButtonTextHoverColor

getSecondaryButtonColor

setSecondaryButtonColor

getSecondaryButtonTextColor

setSecondaryButtonTextColor

getSecondaryButtonHoverColor

setSecondaryButtonHoverColor

getSecondaryButtonTextHoverColor

setSecondaryButtonTextHoverColor