TooleapMiniApp (Tooleap SDK Reference (v0.9.7))

java.lang.Object
- com.tooleap.sdk.TooleapMiniApp

Direct Known Subclasses:

TooleapHomeMiniApp, TooleapNotificationMiniApp, TooleapPersistentMiniApp, TooleapPopOutMiniApp
```
public class TooleapMiniApp
extends java.lang.Object
```
A class that represents a Mini-App.

This is the base class for all types of Mini-Apps.

Since:

0.9.1

See Also:
TooleapPopOutMiniApp, TooleapPersistentMiniApp, TooleapNotificationMiniApp, TooleapHomeMiniApp

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`bubbleBackgroundColor` The Bubble's background color for this Mini-App in ARGB format.
`java.lang.CharSequence`	`contentText` The text to be displayed at second line of text in the applications menu.
`java.lang.CharSequence`	`contentTitle` The text to be displayed as the title of the Mini-App.
`static int`	`FLAG_AVAILABLE_ON_LOCK_SCREEN` A flag that indicates the bubble should appear even while while the device lock screen is on
`static int`	`FLAG_AVAILABLE_ONLY_ON_LOCK_SCREEN` A flag that indicates the bubble should appear only while the device lock screen is on
`static int`	`FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN` A flag that indicates the bubble should hide itself while the device lock screen is on
`byte[]`	`icon` byte array representing the icon data.
`int`	`notificationBadgeNumber` The numeric value of the notification badge
`long`	`notificationSnoozeDuration` After the user dismisses a notification text balloon, the mini app can opt in silence all further notifications for a duration.
`java.lang.CharSequence`	`notificationText` The text to be displayed in the text balloon when the notification first arrives.
`java.util.Date`	`when` The timestamp pertaining to the notification (usually the time the event occurred).

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getAppId()` Get the unique Mini-App ID (identifier) generated for this Mini-App.
`int`	`getBubbleSize()` Get the bubble size (The bubble radius in dp)
`android.content.Intent`	`getContentIntent()` Get the intent to execute when the user wants open the Mini-App
`int`	`getIconOpacity()` Get the bubble opacity (Alpha channel)
`int`	`getLockScreenAvailability()` Returns whether the bubble should appear also/exclusively on the lock screen.
`void`	`setBubbleSize(int bubbleRadius)` Set the bubble radius size in dp.
`TooleapMiniApp`	`setContentIntent(android.content.Intent contentIntent)` The intent to execute when the user wants open the Mini-App
`TooleapMiniApp`	`setIcon(android.graphics.Bitmap icon)` Set the Mini-App icon.
`TooleapMiniApp`	`setIcon(byte[] icon)` Set the Mini-App icon.
`TooleapMiniApp`	`setIcon(android.content.Context context, int resourceId)` Set the Mini-App icon.
`void`	`setIconOpacity(int alphaChannel)` Set the icon opacity (The icon alpha channel).
`void`	`setLockScreenAvailability(int lockScreenAvailability)` Sets whether the bubble should appear also/exclusively on the lock screen Set FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN if you want the bubble to hide itself while the device lock screen is on Set FLAG_AVAILABLE_ON_LOCK_SCREEN if you want the bubble to appear even while while the device lock screen is on Set FLAG_AVAILABLE_ONLY_ON_LOCK_SCREEN if you want the bubble to appear only while the device lock screen is on

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN
```
public static final int FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN
```
    A flag that indicates the bubble should hide itself while the device lock screen is on
    
    See Also:
    setLockScreenAvailability(int), Constant Field Values
  - FLAG_AVAILABLE_ON_LOCK_SCREEN
```
public static final int FLAG_AVAILABLE_ON_LOCK_SCREEN
```
    A flag that indicates the bubble should appear even while while the device lock screen is on
    
    See Also:
    setLockScreenAvailability(int), Constant Field Values
  - FLAG_AVAILABLE_ONLY_ON_LOCK_SCREEN
```
public static final int FLAG_AVAILABLE_ONLY_ON_LOCK_SCREEN
```
    A flag that indicates the bubble should appear only while the device lock screen is on
    
    See Also:
    setLockScreenAvailability(int), Constant Field Values
  - bubbleBackgroundColor
```
public int bubbleBackgroundColor
```
    The Bubble's background color for this Mini-App in ARGB format. e.g. 0x99AAFFCC
    
    Since:
    
    0.9.1
  - contentText
```
public java.lang.CharSequence contentText
```
    The text to be displayed at second line of text in the applications menu.
    
    Since:
    
    0.9.1
    
    See Also:
    TooleapNotificationHelper.setContentText(CharSequence)
  - contentTitle
```
public java.lang.CharSequence contentTitle
```
    The text to be displayed as the title of the Mini-App.
    
    Since:
    
    0.9.1
  - icon
```
public byte[] icon
```
    byte array representing the icon data.
    
    Since:
    
    0.9.1
    
    See Also:
    setIcon(android.content.Context, int), setIcon(android.graphics.Bitmap), setIcon(byte[])
  - notificationBadgeNumber
```
public int notificationBadgeNumber
```
    The numeric value of the notification badge
    
    Since:
    
    0.9.1
    
    See Also:
    Tooleap.getMiniAppNotificationBadge(long), TooleapNotificationHelper.incrementBadge()
  - notificationText
```
public java.lang.CharSequence notificationText
```
    The text to be displayed in the text balloon when the notification first arrives.
    
    Since:
    
    0.9.1
    
    See Also:
    TooleapNotificationHelper.setNotificationText(CharSequence)
  - when
```
public java.util.Date when
```
    The timestamp pertaining to the notification (usually the time the event occurred).
    
    Since:
    
    0.9.1
    
    See Also:
    TooleapNotificationHelper.setWhen(java.util.Date)
  - notificationSnoozeDuration
```
public long notificationSnoozeDuration
```
    After the user dismisses a notification text balloon, the mini app can opt in silence all further notifications for a duration. All updates to the mini app will still occur, but the bubble animation won't (i.e the bubble won't pop out). The snooze duration is in milliseconds. Default value is 0 (no snooze duration)
    
    Since:
    
    0.9.7
- Method Detail
  - setIcon
```
public TooleapMiniApp setIcon(byte[] icon)
```
    Set the Mini-App icon.
    
    Parameters:
    icon - byte array representing the icon data.
    Since:
    
    0.9.1
    
    See Also:
    icon, setIcon(android.content.Context, int), setIcon(android.graphics.Bitmap)
  - setIcon
```
public TooleapMiniApp setIcon(android.graphics.Bitmap icon)
```
    Set the Mini-App icon.
    
    Since:
    
    0.9.1
    
    See Also:
    icon, setIcon(android.content.Context, int), setIcon(byte[])
  - setIcon
```
public TooleapMiniApp setIcon(android.content.Context context,
                     int resourceId)
```
    Set the Mini-App icon.
    
    Since:
    
    0.9.1
    
    See Also:
    icon, setIcon(byte[]), setIcon(android.graphics.Bitmap)
  - setContentIntent
```
public TooleapMiniApp setContentIntent(android.content.Intent contentIntent)
```
    The intent to execute when the user wants open the Mini-App
    
    Since:
    
    0.9.1
    
    See Also:
    getContentIntent()
  - getContentIntent
```
public android.content.Intent getContentIntent()
```
    Get the intent to execute when the user wants open the Mini-App
    
    Since:
    
    0.9.1
    
    See Also:
    setContentIntent(android.content.Intent)
  - getAppId
```
public long getAppId()
```
    Get the unique Mini-App ID (identifier) generated for this Mini-App.
    
    Since:
    
    0.9.1
  - setIconOpacity
```
public void setIconOpacity(int alphaChannel)
```
    Set the icon opacity (The icon alpha channel). Use this if you want to make the bubble transparent. Default value is 255 (solid icon)
    
    Parameters:
    alphaChannel - The icon alpha channel (0 - 255)
    Since:
    
    0.9.7
  - getIconOpacity
```
public int getIconOpacity()
```
    Get the bubble opacity (Alpha channel)
    
    Returns:
    The icon opacity (Alpha channel value between 0 - 255)
    Since:
    
    0.9.7
  - setBubbleSize
```
public void setBubbleSize(int bubbleRadius)
```
    Set the bubble radius size in dp. Accepts values between 10 - 50. Default value is 25;
    
    Parameters:
    bubbleRadius - The bubble radius size in dp (10 - 50)
    Since:
    
    0.9.7
  - getBubbleSize
```
public int getBubbleSize()
```
    Get the bubble size (The bubble radius in dp)
    
    Returns:
    The bubble radius size in dp
    Since:
    
    0.9.7
  - setLockScreenAvailability
```
public void setLockScreenAvailability(int lockScreenAvailability)
```
    Sets whether the bubble should appear also/exclusively on the lock screen Set FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN if you want the bubble to hide itself while the device lock screen is on Set FLAG_AVAILABLE_ON_LOCK_SCREEN if you want the bubble to appear even while while the device lock screen is on Set FLAG_AVAILABLE_ONLY_ON_LOCK_SCREEN if you want the bubble to appear only while the device lock screen is on
    
    Parameters:
    lockScreenAvailability - Where should the bubble appear
    Since:
    
    0.9.7
    
    See Also:
    FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN, FLAG_AVAILABLE_ON_LOCK_SCREEN, FLAG_AVAILABLE_ONLY_ON_LOCK_SCREEN
  - getLockScreenAvailability
```
public int getLockScreenAvailability()
```
    Returns whether the bubble should appear also/exclusively on the lock screen. Default value is #FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN
    
    Returns:
    Flag value indication whether the bubble should appear also/exclusively on the lock screen
    Since:
    
    0.9.7
    
    See Also:
    FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN, FLAG_AVAILABLE_ON_LOCK_SCREEN, FLAG_AVAILABLE_ONLY_ON_LOCK_SCREEN

Class TooleapMiniApp

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLAG_NOT_AVAILABLE_ON_LOCK_SCREEN

FLAG_AVAILABLE_ON_LOCK_SCREEN

FLAG_AVAILABLE_ONLY_ON_LOCK_SCREEN

bubbleBackgroundColor

contentText

contentTitle

icon

notificationBadgeNumber

notificationText

when

notificationSnoozeDuration

Method Detail

setIcon

setIcon

setIcon

setContentIntent

getContentIntent

getAppId

setIconOpacity

getIconOpacity

setBubbleSize

getBubbleSize

setLockScreenAvailability

getLockScreenAvailability