com.tooleap.sdk

Class Tooleap

java.lang.Object

com.tooleap.sdk.Tooleap

public final class Tooleap
extends java.lang.Object

Tooleap API class.

This class exposes APIs for managing Tooleap Mini-Apps and getting information about the existing mini-apps.

Since:

0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tooleap.Consts Static class of constant variables - for use with various methods of Tooleap

Method Summary

Methods

Modifier and Type	Method and Description
long	addMiniApp(TooleapMiniApp miniApp) Add a new Mini-App to Tooleap.
TooleapNotificationHelper	buildNotification(long appId) Get the notification helper for the Mini-App
java.util.ArrayList<TooleapMiniApp>	getAllMiniApps() Get a list containing all of the Mini-Apps added to Tooleap.
static Tooleap	getInstance(android.content.Context context) Get the single instance of the Tooleap API class (singleton).
TooleapMiniApp	getMiniApp(long appId) Get the Mini-App data
int	getMiniAppNotificationBadge(long appId) Get the current numeric value of the notification badge
long	getVisibleAppId() Get the Mini-App ID of the Mini-App currently visible to the user.
void	removeAllMiniApps() Remove all the Mini-Apps added to Tooleap.
void	removeMiniApp(long appId) Remove an existing Mini-App from Tooleap.
void	showMiniApp(long appId) Opens the side-screen with the Mini-App
boolean	updateMiniApp(long appId, TooleapMiniApp miniApp) Update the Mini-App
boolean	updateMiniAppAndNotify(long appId, TooleapMiniApp miniApp) Update the Mini-App and post a notification to be shown.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Tooleap getInstance(android.content.Context context)

Get the single instance of the Tooleap API class (singleton).

Since:

0.9.1

addMiniApp

public long addMiniApp(TooleapMiniApp miniApp)

Add a new Mini-App to Tooleap.

Returns:

A unique Mini-App ID (identifier) generated for this Mini-App.

Since:

0.9.1

removeMiniApp

public void removeMiniApp(long appId)

Remove an existing Mini-App from Tooleap.

Parameters:

appId - The unique Mini-App ID.

Since:

0.9.1

removeAllMiniApps

public void removeAllMiniApps()

Remove all the Mini-Apps added to Tooleap.

Since:

0.9.1

showMiniApp

public void showMiniApp(long appId)

Opens the side-screen with the Mini-App

Parameters:

appId - The unique Mini-App ID.

Since:

0.9.6

getAllMiniApps

public java.util.ArrayList<TooleapMiniApp> getAllMiniApps()

Get a list containing all of the Mini-Apps added to Tooleap.

Since:

0.9.1

getMiniAppNotificationBadge

public int getMiniAppNotificationBadge(long appId)

Get the current numeric value of the notification badge

Parameters:

appId - The unique Mini-App ID.

Since:

0.9.1

See Also:

TooleapMiniApp.notificationBadgeNumber, TooleapNotificationHelper.incrementBadge()

getMiniApp

public TooleapMiniApp getMiniApp(long appId)

Get the Mini-App data

Parameters:

appId - The unique Mini-App ID.

Since:

0.9.1

updateMiniApp

public boolean updateMiniApp(long appId,
                    TooleapMiniApp miniApp)

Update the Mini-App

Parameters:

appId - The unique Mini-App ID.

miniApp - The updated Mini-App data.

Since:

0.9.1

updateMiniAppAndNotify

public boolean updateMiniAppAndNotify(long appId,
                             TooleapMiniApp miniApp)

Update the Mini-App and post a notification to be shown.

Parameters:

appId - The unique Mini-App ID.

miniApp - The updated Mini-App data.

Since:

0.9.1

See Also:

TooleapNotificationHelper.buildAndNotify()

buildNotification

public TooleapNotificationHelper buildNotification(long appId)

Get the notification helper for the Mini-App

Parameters:

appId - The unique Mini-App ID.

Since:

0.9.1

See Also:

TooleapNotificationHelper

getVisibleAppId

public long getVisibleAppId()

Get the Mini-App ID of the Mini-App currently visible to the user.

Returns:

The Mini-App ID of the current visible Mini-App. If currently there's no visible Mini-App, 0 will be returned.

Since:

0.9.1