com.deploygate.sdk

Class DeployGate

java.lang.Object

com.deploygate.sdk.DeployGate

public class DeployGate
extends java.lang.Object

This is DeployGate SDK library. Import this library to the application package and call install(Application) on the onCreate() of application class to enable crash reporting and application launch notification.

In order to get working Remote LogCat feature, you also have to add <uses-permission android:name="android.permission.READ_LOGS" /> in AndroidManifest.xml of your application.

Method Summary

Modifier and Type	Method and Description
static void	composeComment() Open comment composer screen for the distribution of the app installed.
static void	composeComment(java.lang.String defaultComment) Open comment composer screen for the distribution of the app installed with pre filled string.
static java.lang.String	getAuthorUsername() Get current app's author (e.g., User or Organzation) name on DeployGate.
static int	getCurrentRevision() Returns the revision of the app on DeployGate.
static int	getDeployGateVersionCode() Returns android:versionCode of DeployGate app.
static java.lang.String	getDistributionId() Returns the ID (40 digits hex string appears in URL) of the distribution if the app was installed through Distribution Page.
static java.lang.String	getDistributionTitle() Returns the title of the distribution if the app was installed through Distribution Page.
static java.lang.String	getDistributionUrl() Returns the URL of the distribution if the app was installed through Distribution Page.
static java.lang.String	getDistributionUserName() Get current user's name on Distribution Page.
static java.lang.String	getLoginUsername() Get current DeployGate username.
static java.lang.String	getUpdateMessage() Returns the message attached to the build.
int	getUpdateRevision() Returns the revision number of the update.
int	getUpdateVersionCode() Returns the android:versionCode of the update.
java.lang.String	getUpdateVersionName() Returns the android:versionName of the update.
boolean	hasUpdate() Check whether there's update of the app.
static void	install(android.app.Application app) Install DeployGate on your application instance.
static void	install(android.app.Application app, DeployGateCallback callback) Install DeployGate on your application instance and register a callback listener.
static void	install(android.app.Application app, DeployGateCallback callback, boolean forceApplyOnReleaseBuild) Install DeployGate on your application instance and register a callback listener.
static void	install(android.app.Application app, java.lang.String author) Install DeployGate on your application instance.
static void	install(android.app.Application app, java.lang.String author, DeployGateCallback callback) Install DeployGate on your application instance and register a callback listener.
static void	install(android.app.Application app, java.lang.String author, DeployGateCallback callback, boolean forceApplyOnReleaseBuild) Install DeployGate on your application instance and register a callback listener.
static void	installUpdate() Start the installation of the latest version of the app if available.
static boolean	isAuthorized() Get whether current DeployGate user has this application in his/her available list.
static boolean	isDeployGateAvaliable() Get whether DeployGate client service is available on this device.
static boolean	isInitialized() Get whether SDK is completed its intialization process and ready after install(Application).
static boolean	isManaged() Get whether this application and its package is known and managed under the DeployGate.
static void	logDebug(java.lang.String message) Record DEBUG level event on DeployGate.
static void	logError(java.lang.String message) Record ERROR level event on DeployGate.
static void	logInfo(java.lang.String message) Record INFO level event on DeployGate.
static void	logVerbose(java.lang.String message) Record VERBOSE level event on DeployGate.
static void	logWarn(java.lang.String message) Record WARN level event on DeployGate.
static void	openComments() Open comments screen for the distribution of the app installed.
static void	refresh() Request refreshing cached session values (e.g., isAuthorized, etc.) to the DeployGate service.
static void	registerCallback(DeployGateCallback listener, boolean refreshImmediately) Register a DeployGate event callback listener.
static void	requestLogCat() Capture current LogCat and send it.
static void	unregisterCallback(DeployGateCallback listener) Unregister a callback listener.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

install

public static void install(android.app.Application app)

Install DeployGate on your application instance. Call this method inside of your Application.onCreate() once.

On a release build, which has android:isDebuggable set false on AndroidManifest.xml, this function will do nothing. If you want to enable DeployGate on a release build, consider using install(Application, String, DeployGateCallback, boolean) instead.

Note: To make isAuthorized() more effective, you should call install(Application, String) instead and specify authorId explicitly to ensure the authority of this app to prevent casual redistribution via DeployGate.

Parameters:

app - Application instance, typically just pass this.

Throws:

java.lang.IllegalStateException - if this called twice

Since:

r1

install

public static void install(android.app.Application app,
                           java.lang.String author)

Install DeployGate on your application instance. Call this method inside of your Application.onCreate() once.

On a release build, which has android:isDebuggable set false on AndroidManifest.xml, this function will do nothing. If you want to enable DeployGate on a release build, consider using install(Application, String, DeployGateCallback, boolean) instead.

Parameters:

app - Application instance, typically just pass this.

author - author username of this app.

Throws:

java.lang.IllegalStateException - if this called twice

Since:

r2

install

public static void install(android.app.Application app,
                           DeployGateCallback callback)

Install DeployGate on your application instance and register a callback listener. Call this method inside of your Application.onCreate() once.

On a release build, which has android:isDebuggable set false on AndroidManifest.xml, this function will do nothing. If you want to enable DeployGate on a release build, consider using install(Application, String, DeployGateCallback, boolean) instead.

Note: To make isAuthorized() more effective, you should call install(Application, String) instead and specify authorId explicitly to ensure the authority of this app to prevent casual redistribution via DeployGate.

Parameters:

app - Application instance, typically just pass this.

callback - Callback interface to listen events.

Throws:

java.lang.IllegalStateException - if this called twice

Since:

r1

install

public static void install(android.app.Application app,
                           java.lang.String author,
                           DeployGateCallback callback)

Install DeployGate on your application instance and register a callback listener. Call this method inside of your Application.onCreate() once.

On a release build, which has android:isDebuggable set false on AndroidManifest.xml, this function will do nothing. If you want to enable DeployGate on a release build, consider using install(Application, String, DeployGateCallback, boolean) instead.

Parameters:

app - Application instance, typically just pass this.

author - author username of this app.

callback - Callback interface to listen events.

Throws:

java.lang.IllegalStateException - if this called twice

Since:

r2

install

public static void install(android.app.Application app,
                           DeployGateCallback callback,
                           boolean forceApplyOnReleaseBuild)

Install DeployGate on your application instance and register a callback listener. Call this method inside of your Application.onCreate() once.

Note: To make isAuthorized() more effective, you should call install(Application, String) instead and specify authorId explicitly to ensure the authority of this app to prevent casual redistribution via DeployGate.

Parameters:

app - Application instance, typically just pass this.

callback - Callback interface to listen events. Can be null.

forceApplyOnReleaseBuild - if you want to keep DeployGate alive on the release build, set this true.

Throws:

java.lang.IllegalStateException - if this called twice

Since:

r1

install

public static void install(android.app.Application app,
                           java.lang.String author,
                           DeployGateCallback callback,
                           boolean forceApplyOnReleaseBuild)

Install DeployGate on your application instance and register a callback listener. Call this method inside of your Application.onCreate() once.

Parameters:

app - Application instance, typically just pass this.

author - author username of this app. Can be null.

callback - Callback interface to listen events. Can be null.

forceApplyOnReleaseBuild - if you want to keep DeployGate alive on the release build, set this true.

Since:

r2

refresh

public static void refresh()

Request refreshing cached session values (e.g., isAuthorized, etc.) to the DeployGate service. Nothing happens if this called before install(Application) or when refreshing is already in progress. Note that after calling this, isInitialized() will changed to false immediately and any call to is*() will be blocked until refreshing get finished.

Since:

r1

registerCallback

public static void registerCallback(DeployGateCallback listener,
                                    boolean refreshImmediately)

Register a DeployGate event callback listener. Don't forget to call unregisterCallback(DeployGateCallback) when the callback is no longer needed (e.g., on destroying an activity.) If the listener has already in the callback list, just ignored.

Parameters:

listener - callback listener

refreshImmediately - if you want to receive current states, set this true.

Since:

r1

unregisterCallback

public static void unregisterCallback(DeployGateCallback listener)

Unregister a callback listener. If the listener was not registered, just ignored.

Parameters:

listener - callback listener to be removed

Since:

r1

isInitialized

public static boolean isInitialized()

Get whether SDK is completed its intialization process and ready after install(Application). This call will never blocked.

Returns:

true if SDK is ready. false otherwise. If no install() called ever, this always returns false.

Since:

r1

isDeployGateAvaliable

public static boolean isDeployGateAvaliable()

Get whether DeployGate client service is available on this device.

Note this function will block until SDK get ready after install(Application) called. So if you want to call this function from the main thread, you should confirm that isInitialized() is true before calling this. (Or consider using DeployGateCallback.onInitialized(boolean) callback.)

Returns:

true if valid DeployGate client is available. false otherwise. If no install() called ever, this always returns false.

Since:

r1

isManaged

public static boolean isManaged()

Get whether this application and its package is known and managed under the DeployGate.

Note this function will block until SDK get ready after install(Application) called. So if you want to call this function from the main thread, you should confirm that isInitialized() is true before calling this. (Or consider using DeployGateCallback.onInitialized(boolean) callback.)

Returns:

true if DeployGate knows and manages this package. false otherwise. If no install() called ever, this always returns false.

Since:

r1

isAuthorized

public static boolean isAuthorized()

Get whether current DeployGate user has this application in his/her available list. You may want to check this value on initialization process of the main activity if you want to limit user of this application to only who you explicitly allowed.

Note this function will block until SDK get ready after install(Application) called. So if you want to call this function from the main thread, you should confirm that isInitialized() is true before calling this. (Or consider using DeployGateCallback.onInitialized(boolean) callback.)

Returns:

true if current DeployGate user has available list which contains this application. false otherwise. If no install() called ever, this always returns false.

Since:

r1

getLoginUsername

public static java.lang.String getLoginUsername()

Get current DeployGate username. This function only available when isAuthorized() is true.

Note this function will block until SDK get ready after install(Application) called. So if you want to call this function from the main thread, you should confirm that isInitialized() is true before calling this. (Or consider using DeployGateCallback.onInitialized(boolean) callback.)

Returns:

Current user of DeployGate. May be null.

Since:

r1

getAuthorUsername

public static java.lang.String getAuthorUsername()

Get current app's author (e.g., User or Organzation) name on DeployGate. You may use this value to check the app was distributed by yourself or someone else.

Tip: If you want to prevent distributing your app by someone else on the DeployGate, consider using install(Application, String).

Note this function will block until SDK get ready after install(Application) called. So if you want to call this function from the main thread, you should confirm that isInitialized() is true before calling this. (Or consider using DeployGateCallback.onInitialized(boolean) callback.)

Returns:

Owner User or Organization of current app. May be null.

Since:

r2

logError

public static void logError(java.lang.String message)

Record ERROR level event on DeployGate. Log message will immediately send to the server so you may see it on your dashboard. Nothing happen when DeployGate is not available, i.e. isAuthorized() is not true.

Parameters:

message - Message body to be send. May be truncated if it's too long.

Since:

r1

logWarn

public static void logWarn(java.lang.String message)

Record WARN level event on DeployGate. Log message will immediately send to the server so you may see it on your dashboard. Nothing happen when DeployGate is not available, i.e. isAuthorized() is not true.

Parameters:

message - Message body to be send. May be truncated if it's too long.

Since:

r1

logDebug

public static void logDebug(java.lang.String message)

Record DEBUG level event on DeployGate. Log message will immediately send to the server so you may see it on your dashboard. Nothing happen when DeployGate is not available, i.e. isAuthorized() is not true.

Parameters:

message - Message body to be send. May be truncated if it's too long.

Since:

r1

logInfo

public static void logInfo(java.lang.String message)

Record INFO level event on DeployGate. Log message will immediately send to the server so you may see it on your dashboard. Nothing happen when DeployGate is not available, i.e. isAuthorized() is not true.

Parameters:

message - Message body to be send. May be truncated if it's too long.

Since:

r1

logVerbose

public static void logVerbose(java.lang.String message)

Record VERBOSE level event on DeployGate. Log message will immediately send to the server so you may see it on your dashboard. Nothing happen when DeployGate is not available, i.e. isAuthorized() is not true.

Parameters:

message - Message body to be send. May be truncated if it's too long.

Since:

r1

requestLogCat

public static void requestLogCat()

Capture current LogCat and send it. This call will work asynchronously. Capturing LogCat requires android.permission.READ_LOGS is declared on your app AndroidManifest.xml, or your app is running on Android 4.1 or higher. If LogCat is not available, this function simply does nothing.

Since:

r3

getCurrentRevision

public static int getCurrentRevision()

Returns the revision of the app on DeployGate. The revision number is automatically incremented integer value every time you upload a build to DeployGate, so you can identify the build explicitly. Requires DeployGate v1.7.0 or higher installed, otherwise this function always returns 0.

Returns:

revision number of the app, or 0 if DeployGate is older than v1.7.0 (39)

Since:

r4

getDistributionUrl

public static java.lang.String getDistributionUrl()

Returns the URL of the distribution if the app was installed through Distribution Page. Requires DeployGate v1.7.0 or higher installed, otherwise this function always returns null.

Returns:

URL of the distribution page, null if the app was not installed through Distribution Page or DeployGate is older than v1.7.0 (39)

Since:

r4

getDistributionId

public static java.lang.String getDistributionId()

Returns the ID (40 digits hex string appears in URL) of the distribution if the app was installed through Distribution Page. Requires DeployGate v1.7.0 or higher installed, otherwise this function always returns null.

Returns:

ID of the distribution page, null if the app was not installed through Distribution Page or DeployGate is older than v1.7.0 (39)

Since:

r4

getDistributionTitle

public static java.lang.String getDistributionTitle()

Returns the title of the distribution if the app was installed through Distribution Page. Requires DeployGate v1.7.0 or higher installed, otherwise this function always returns null.

Returns:

Title of the distribution page, null if the app was not installed through Distribution Page or DeployGate is older than v1.7.0 (39)

Since:

r4

getDeployGateVersionCode

public static int getDeployGateVersionCode()

Returns android:versionCode of DeployGate app.

Returns:

Version code of DeployGate, or 0 if DeployGate is older than v1.7.0 (39)

Since:

r4

hasUpdate

public boolean hasUpdate()

Check whether there's update of the app. You can get detailed information via getUpdateRevision(), getUpdateVersionCode(), getUpdateVersionName(), and getUpdateMessage().

Returns:

true if there's an update, false otherwise.

Since:

r4

getUpdateRevision

public int getUpdateRevision()

Returns the revision number of the update. The value is only valid when hasUpdate() is true.

Returns:

Revision number of the update.

Since:

r4

getUpdateVersionCode

public int getUpdateVersionCode()

Returns the android:versionCode of the update. The value is only valid when hasUpdate() is true.

Returns:

Revision number of the update.

Since:

r4

getUpdateVersionName

public java.lang.String getUpdateVersionName()

Returns the android:versionName of the update. The value is only valid when hasUpdate() is true.

Returns:

Revision number of the update.

Since:

r4

getUpdateMessage

public static java.lang.String getUpdateMessage()

Returns the message attached to the build. If the app was installed via Distribution Page (i.e. is not null, this method returns Release Note that was entered when you published a new version on the page. Otherwise this method returns the message that was entered when you upload a new build to DeployGate. Requires DeployGate v1.7.0 or higher installed, otherwise this function always returns null.

Returns:

The message attached to the build

Since:

r4

installUpdate

public static void installUpdate()

Start the installation of the latest version of the app if available. No effects if there's no update. Requires DeployGate v1.7.0 or higher installed, otherwise this function produces no effect.

Since:

r4

openComments

public static void openComments()

Open comments screen for the distribution of the app installed. No effect if the app was installed via Distribution Page (i.e. is null. Requires DeployGate v1.7.0 or higher installed, otherwise this function produces no effect.

Since:

r4

composeComment

public static void composeComment()

Open comment composer screen for the distribution of the app installed. No effect if the app was installed via Distribution Page (i.e. is null. Requires DeployGate v1.7.0 or higher installed, otherwise this function produces no effect.

Since:

r4

composeComment

public static void composeComment(java.lang.String defaultComment)

Open comment composer screen for the distribution of the app installed with pre filled string. No effect if the app was installed via Distribution Page (i.e. is null. Requires DeployGate v1.7.0 or higher installed, otherwise this function produces no effect.

Parameters:

defaultComment - Default comment set to the editor

Since:

r4

getDistributionUserName

public static java.lang.String getDistributionUserName()

Get current user's name on Distribution Page. Default name is randomly generated string (like "[abcd1234]"). Requires DeployGate v1.7.0 or higher installed, otherwise this function returns null.

Returns:

User's display name on DeployGate. May be null.

Since:

r4