NotificationOptions (Straas Android SDK 0.24.0 API)

java.lang.Object
- io.straas.android.sdk.media.notification.NotificationOptions

All Implemented Interfaces:

Parcelable
```
public class NotificationOptions
extends Object
implements Parcelable
```
This provides some options for setting your Notification. Set this as the value of StraasMediaCore.KEY_NOTIFICATION_OPTIONS.

See Also:

StraasMediaCore.KEY_NOTIFICATION_OPTIONS

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NotificationOptions.Builder` Builder of `NotificationOptions`.
`static interface`	`NotificationOptions.NOTIFICATION_ACTIONS` This indicates the actions that can be used in `NotificationOptions.Builder.setActions(List, int[])`.

Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_CLEAR` This action will trigger `stop()` and clear current `Notification`.
`static String`	`ACTION_NEXT` This action will trigger `skipToNext()`.
`static String`	`ACTION_PREV` This action will trigger `skipToPrevious()`.
`static String`	`ACTION_TOGGLE_PLAYBACK` This action will depend on playback state to trigger `play()` or `pause()`.
`static Parcelable.Creator<NotificationOptions>`	`CREATOR`

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Modifier Constructor and Description

protected NotificationOptions(Parcel in)

Constructors
Modifier	Constructor and Description
`protected`	`NotificationOptions(Parcel in)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`List<String>`	`getActions()` Returns the list of actions to show in the `Notification`.
`NotificationChannel`	`getChannel()` Returns the `NotificationChannel` that will be set to this `Notification`.
`int`	`getClearDrawableResId()` Returns the resource ID of the icon that indicates `ACTION_CLEAR`.
`int`	`getColor()` Returns the color that will be use to build the `Notification`.
`int[]`	`getCompatActionIndices()` Returns a copy of the indices of the actions which should be shown in the compact form of the notification.
`Bitmap`	`getLargeIcon()` Returns the bitmap of the large icon that will be used to build the `Notification`.
`int`	`getPauseDrawableResId()` Returns the resource ID of the icon that indicates "pause".
`int`	`getPlayDrawableResId()` Returns the resource ID of the icon that indicates "play".
`int`	`getSkipNextDrawableResId()` Returns the resource ID of the icon that indicates `ACTION_NEXT`.
`int`	`getSkipPrevDrawableResId()` Returns the resource ID of the icon that indicates `ACTION_PREV`.
`int`	`getSmallIcon()` Returns the resource ID of the small icon that will be used to build the `Notification`.
`String`	`getTargetClassName()` Returns the name of the `Activity` that will be launched when user clicks the content area of the `Notification`.
`void`	`writeToParcel(Parcel dest, int flags)`

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

- Field Detail
  - ACTION_TOGGLE_PLAYBACK
```
public static final String ACTION_TOGGLE_PLAYBACK
```
    This action will depend on playback state to trigger play() or pause().
    
    See Also:
    
    Constant Field Values
  - ACTION_PREV
```
public static final String ACTION_PREV
```
    This action will trigger skipToPrevious().
    
    See Also:
    
    Constant Field Values
  - ACTION_NEXT
```
public static final String ACTION_NEXT
```
    This action will trigger skipToNext().
    
    See Also:
    
    Constant Field Values
  - ACTION_CLEAR
```
public static final String ACTION_CLEAR
```
    This action will trigger stop() and clear current Notification.
    
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final Parcelable.Creator<NotificationOptions> CREATOR
```
- Constructor Detail
  - NotificationOptions
```
protected NotificationOptions(Parcel in)
```
- Method Detail
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface Parcelable
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface Parcelable
  - getActions
```
public List<String> getActions()
```
    Returns the list of actions to show in the Notification.
    
    Returns:
    
    actions
    
    See Also:
    
    NotificationOptions.Builder.setActions(List, int[])
  - getCompatActionIndices
```
public int[] getCompatActionIndices()
```
    Returns a copy of the indices of the actions which should be shown in the compact form of the notification.
    
    Returns:
    
    indices
    
    See Also:
    
    NotificationOptions.Builder.setActions(List, int[])
  - getPauseDrawableResId
```
public int getPauseDrawableResId()
```
    Returns the resource ID of the icon that indicates "pause".
    
    Returns:
    
    resource ID
    
    See Also:
    
    NotificationOptions.Builder.setPauseDrawableResId(int)
  - getPlayDrawableResId
```
@DrawableRes
public int getPlayDrawableResId()
```
    Returns the resource ID of the icon that indicates "play".
    
    Returns:
    
    resource ID
    
    See Also:
    
    NotificationOptions.Builder.setPlayDrawableResId(int)
  - getSkipPrevDrawableResId
```
public int getSkipPrevDrawableResId()
```
    Returns the resource ID of the icon that indicates ACTION_PREV.
    
    Returns:
    
    resource ID
    
    See Also:
    
    NotificationOptions.Builder.setSkipPrevDrawableResId(int)
  - getSkipNextDrawableResId
```
public int getSkipNextDrawableResId()
```
    Returns the resource ID of the icon that indicates ACTION_NEXT.
    
    Returns:
    
    resource ID
    
    See Also:
    
    NotificationOptions.Builder.setSkipNextDrawableResId(int)
  - getClearDrawableResId
```
public int getClearDrawableResId()
```
    Returns the resource ID of the icon that indicates ACTION_CLEAR.
    
    Returns:
    
    resource ID
    
    See Also:
    
    NotificationOptions.Builder.setClearDrawableResId(int)
  - getSmallIcon
```
public int getSmallIcon()
```
    Returns the resource ID of the small icon that will be used to build the Notification.
    
    Returns:
    
    resource id
    
    See Also:
    
    NotificationOptions.Builder.setSmallIconResId(int)
  - getLargeIcon
```
public Bitmap getLargeIcon()
```
    Returns the bitmap of the large icon that will be used to build the Notification.
    
    Returns:
    
    bitmap
    
    See Also:
    
    NotificationOptions.Builder.setLargeIcon(Bitmap)
  - getColor
```
public int getColor()
```
    Returns the color that will be use to build the Notification.
    
    Returns:
    
    color in ColorInt
    
    See Also:
    
    NotificationOptions.Builder.setColor(int)
  - getTargetClassName
```
public String getTargetClassName()
```
    Returns the name of the Activity that will be launched when user clicks the content area of the Notification.
    
    Returns:
    
    class name of Activity
    
    See Also:
    
    NotificationOptions.Builder.setTargetClassName(String)
  - getChannel
```
public NotificationChannel getChannel()
```
    Returns the NotificationChannel that will be set to this Notification.
    
    Returns:
    
    the NotificationChannel
    
    See Also:
    
    NotificationOptions.Builder.setChannel(NotificationChannel)

Class NotificationOptions

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION_TOGGLE_PLAYBACK

ACTION_PREV

ACTION_NEXT

ACTION_CLEAR

CREATOR

Constructor Detail

NotificationOptions

Method Detail

writeToParcel

describeContents

getActions

getCompatActionIndices

getPauseDrawableResId

getPlayDrawableResId

getSkipPrevDrawableResId

getSkipNextDrawableResId

getClearDrawableResId

getSmallIcon

getLargeIcon

getColor

getTargetClassName

getChannel