AppNotificationMessage (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- org.cyclos.impl.utils.appnotifications.AppNotificationMessage

```
public class AppNotificationMessage
extends Object
```
A notification sent to an application.
Instances of this class are thread-safe and immutable.

See Also:

AppNotificationHandler

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AppNotificationMessage.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AppNotificationMessage.Builder`	`builder()`
`String`	`getAndroidIconColor()`	The color in #rrggbb format (e.g: #23AB34) used to colorize the small notification icon shown in Android devices.
`String`	`getBody()`
`String`	`getCustomUrl()`	The URL inside the mobile app which will be opened when the user opens the app notification
`String`	`getImageUrl()`	The url of the image associated with the push notification.
`String`	`getTitle()`
`BasicUser`	`getUser()`
`Map<String,String>`	`getVariables()`
`boolean`	`isIosUseBadge()`	A boolean flag indicating if a badge must be shown for iOS notifications.

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

- Method Detail
  - builder
```
public static AppNotificationMessage.Builder builder()
```
  - getAndroidIconColor
```
public String getAndroidIconColor()
```
    The color in #rrggbb format (e.g: #23AB34) used to colorize the small notification icon shown in Android devices. By default, no color is sent. Device support depends on the Android version;
  - getBody
```
public String getBody()
```
  - getCustomUrl
```
public String getCustomUrl()
```
    The URL inside the mobile app which will be opened when the user opens the app notification
  - getImageUrl
```
public String getImageUrl()
```
    The url of the image associated with the push notification. If not given, the user's profile image is used (only for users, not operators);
  - getTitle
```
public String getTitle()
```
  - getUser
```
public BasicUser getUser()
```
  - getVariables
```
public Map<String,String> getVariables()
```
  - isIosUseBadge
```
public boolean isIosUseBadge()
```
    A boolean flag indicating if a badge must be shown for iOS notifications. Default is true;