com.wonderpush.sdk

Class WonderPushChannel

java.lang.Object

com.wonderpush.sdk.WonderPushChannel

All Implemented Interfaces:

java.lang.Cloneable

public class WonderPushChannel
extends java.lang.Object
implements java.lang.Cloneable

A representation of settings that apply to a collection of similarly themed notifications.

BETA - This API is marked beta and may change without prior notice to reflect any changes made to the Android O APIs.

This class mimicks the android.app.android.app.NotificationChannel class to permit exposing its benefits to devices prior to Android O. Contrary to the latter, this class permits to override only a few aspects of the notification.

It also contains some additions that may no longer be available under Android O where the user is in full control of these settings, such as preventing a notification that usually makes a sound or vibrates to vibrate while the device is in silent mode.
Some feature like the color should remain configurable using this class under Android O.

See Also:

android.app.android.app.NotificationChannel

Constructor Summary

Constructors

Constructor and Description
WonderPushChannel(java.lang.String id, java.lang.String groupId) Create a notification channel.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	equals(java.lang.Object o)
java.lang.Integer	getColor() Returns the color to impose on all notifications posted to this channel.
java.lang.String	getDescription() Returns the user visible description of this channel.
java.lang.String	getGroupId() Returns what group this channel belongs to.
java.lang.String	getId() Returns the id of this channel.
java.lang.Integer	getImportance() Returns the user specified importance for notifications posted to this channel.
java.lang.Integer	getLightColor() Sets the notification light color for notifications posted to this channel, if lights are enabled on this channel and the device supports that feature.
java.lang.Boolean	getLights() Returns whether notifications posted to this channel trigger notification lights.
java.lang.Boolean	getLocalOnly() Returns whether notifications posted to this channel should be local to this device.
java.lang.Integer	getLockscreenVisibility() Returns whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.
java.lang.String	getName() Returns the user visible name of this channel.
java.lang.Boolean	getSound() Returns whether a sound should be played for notifications posted to this channel.
android.net.Uri	getSoundUri() Returns the notification sound for this channel.
java.lang.Boolean	getVibrate() Returns whether notifications posted to this channel always vibrate.
java.lang.Boolean	getVibrateInSilentMode() Returns whether notifications posted to this channel vibrate if the device is in silent mode.
long[]	getVibrationPattern() Returns the vibration pattern for notifications posted to this channel.
int	hashCode()
WonderPushChannel	setColor(java.lang.Integer color) Sets the color to impose on all notifications posted to this channel.
WonderPushChannel	setDescription(java.lang.String description) Sets the user visible description of this channel.
WonderPushChannel	setImportance(java.lang.Integer importance) Sets the level of interruption of this notification channel.
WonderPushChannel	setLightColor(java.lang.Integer lightColor) Returns the notification light color for notifications posted to this channel.
WonderPushChannel	setLights(java.lang.Boolean lights) Sets whether notifications posted to this channel should display notification lights, on devices that support that feature.
WonderPushChannel	setLocalOnly(java.lang.Boolean localOnly) Sets whether notifications posted to this channel should be local to this device.
WonderPushChannel	setLockscreenVisibility(java.lang.Integer lockscreenVisibility) Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form.
WonderPushChannel	setName(java.lang.String name) Sets the user visible name of this channel.
WonderPushChannel	setSound(java.lang.Boolean sound) Sets whether a sound should be played for notifications posted to this channel.
WonderPushChannel	setSoundUri(android.net.Uri soundUri) Sets the sound that should be played for notifications posted to this channel and its audio attributes.
WonderPushChannel	setVibrate(java.lang.Boolean vibrate) Sets whether notification posted to this channel should vibrate.
WonderPushChannel	setVibrateInSilentMode(java.lang.Boolean vibrateInSilentMode) Sets whether notifications posted to this channel vibrate if the device is in silent mode.
WonderPushChannel	setVibrationPattern(long[] vibrationPattern) Sets the vibration pattern for notifications posted to this channel.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WonderPushChannel

public WonderPushChannel(@NonNull
                         java.lang.String id,
                         java.lang.String groupId)

Create a notification channel.

Parameters:

id - The id of the channel. Must be unique per package. The value may be truncated if it is too long.

groupId - The id of a channel group. You should create the group prior to creating this channel.

See Also:

android.app.NotificationChannel#NotificationChannel(java.lang.String, java.lang.CharSequence, int)

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getId

public java.lang.String getId()

Returns the id of this channel.

See Also:

android.app.NotificationChannel#getId()

getGroupId

public java.lang.String getGroupId()

Returns what group this channel belongs to. This is used only for visually grouping channels in the UI. Can be null.

Returns:

The id of the group this channel belongs to, if any.

See Also:

android.app.NotificationChannel#setGroup(String)

getName

public java.lang.String getName()

Returns the user visible name of this channel.

See Also:

android.app.NotificationChannel#getName()

setName

public WonderPushChannel setName(java.lang.String name)

Sets the user visible name of this channel. The recommended maximum length is 40 characters; the value may be truncated if it is too long.

Parameters:

name - The user visible name of this channel.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#setName(CharSequence)

getDescription

public java.lang.String getDescription()

Returns the user visible description of this channel.

Returns:

The user visible description of this channel.

See Also:

android.app.NotificationChannel#getDescription()

setDescription

public WonderPushChannel setDescription(java.lang.String description)

Sets the user visible description of this channel. The recommended maximum length is 300 characters; the value may be truncated if it is too long.

Parameters:

description - The user visible description of this channel.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#setDescription(String)

getImportance

public java.lang.Integer getImportance()

Returns the user specified importance for notifications posted to this channel. Example: NotificationManager.IMPORTANCE_DEFAULT

Returns:

The user specified importance for notifications posted to this channel. Returns null if this setting does not override the received notifications setting.

See Also:

android.app.NotificationChannel#getImportance()

setImportance

public WonderPushChannel setImportance(java.lang.Integer importance)

Sets the level of interruption of this notification channel. Example: NotificationManager.IMPORTANCE_DEFAULT

Parameters:

importance - The level of interruption of this notification channel. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#setImportance(int)

getLights

public java.lang.Boolean getLights()

Returns whether notifications posted to this channel trigger notification lights.

Returns:

Whether notifications posted to this channel trigger notification lights. Returns null if this setting does not override the received notifications setting.

See Also:

android.app.NotificationChannel#shouldShowLights()

setLights

public WonderPushChannel setLights(java.lang.Boolean lights)

Sets whether notifications posted to this channel should display notification lights, on devices that support that feature.

Parameters:

lights - Whether notifications posted to this channel should display notification lights Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#enableLights(boolean)

getVibrate

public java.lang.Boolean getVibrate()

Returns whether notifications posted to this channel always vibrate.

Returns:

Whether notifications posted to this channel always vibrate. Returns null if this setting does not override the received notifications setting.

See Also:

android.app.NotificationChannel#shouldVibrate()

setVibrate

public WonderPushChannel setVibrate(java.lang.Boolean vibrate)

Sets whether notification posted to this channel should vibrate. The vibration pattern can be set with setVibrationPattern(long[]).

Parameters:

vibrate - Whether notification posted to this channel should vibrate. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#enableVibration(boolean)

getVibrationPattern

public long[] getVibrationPattern()

Returns the vibration pattern for notifications posted to this channel.

Returns:

The vibration pattern for notifications posted to this channel. Returns null if this setting does not override the received notifications setting.

See Also:

android.app.NotificationChannel#getVibrationPattern()

setVibrationPattern

public WonderPushChannel setVibrationPattern(long[] vibrationPattern)

Sets the vibration pattern for notifications posted to this channel.

Parameters:

vibrationPattern - The vibration pattern for notifications posted to this channel. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#setVibrationPattern(long[])

getLightColor

public java.lang.Integer getLightColor()

Sets the notification light color for notifications posted to this channel, if lights are enabled on this channel and the device supports that feature.

Returns:

The notification light color for notifications posted to this channel Returns null if this setting does not override the received notifications setting.

See Also:

android.app.NotificationChannel#getLightColor()

setLightColor

public WonderPushChannel setLightColor(java.lang.Integer lightColor)

Returns the notification light color for notifications posted to this channel.

Parameters:

lightColor - The notification light color for notifications posted to this channel. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#setLightColor(int)

getLockscreenVisibility

public java.lang.Integer getLockscreenVisibility()

Returns whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.

Returns:

Whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form. Returns null if this setting does not override the received notifications setting.

See Also:

android.app.NotificationChannel#getLockscreenVisibility()

setLockscreenVisibility

public WonderPushChannel setLockscreenVisibility(java.lang.Integer lockscreenVisibility)

Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form. Example: Notification.VISIBILITY_PUBLIC.

Parameters:

lockscreenVisibility - Whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#setLockscreenVisibility(int)

getSound

public java.lang.Boolean getSound()

Returns whether a sound should be played for notifications posted to this channel.

Returns:

Whether a sound should be played for notifications posted to this channel. Returns null if this setting does not override the received notifications setting.

See Also:

android.app.NotificationChannel#getSound()

setSound

public WonderPushChannel setSound(java.lang.Boolean sound)

Sets whether a sound should be played for notifications posted to this channel.

Parameters:

sound - Whether a sound should be played for notifications posted to this channel. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#setSound(android.net.Uri, android.media.AudioAttributes)

getSoundUri

public android.net.Uri getSoundUri()

Returns the notification sound for this channel.

Returns:

The notification sound for this channel. Returns null if this setting does not override the received notifications setting.

See Also:

android.app.NotificationChannel#getSound()

setSoundUri

public WonderPushChannel setSoundUri(android.net.Uri soundUri)

Sets the sound that should be played for notifications posted to this channel and its audio attributes. Notification channels with an importance of at least NotificationManager.IMPORTANCE_DEFAULT should have a sound.

Parameters:

soundUri - The sound that should be played for notifications posted to this channel. You can use Settings.System.DEFAULT_NOTIFICATION_URI to use the default notification sound. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

android.app.NotificationChannel#setSound(android.net.Uri, android.media.AudioAttributes)

getVibrateInSilentMode

public java.lang.Boolean getVibrateInSilentMode()

Returns whether notifications posted to this channel vibrate if the device is in silent mode.

This is a WonderPush addition.

The primary use of this flag is to permit notifications with sound and vibration in normal mode but prevent it from vibrating in all cases in silent mode.

Returns:

Whether notifications posted to this channel vibrate if the device is in silent mode. Returns null if this setting does not override the received notifications setting.

setVibrateInSilentMode

public WonderPushChannel setVibrateInSilentMode(java.lang.Boolean vibrateInSilentMode)

Sets whether notifications posted to this channel vibrate if the device is in silent mode.

This is a WonderPush addition.

The primary use of this flag is to permit notifications with sound and vibration in normal mode but prevent it from vibrating in all cases in silent mode.

Note: You can control this setting irrespective of the fact that a given notification should vibrate a make a sound in normal mode.

Parameters:

vibrateInSilentMode - Whether notifications posted to this channel vibrate if the device is in silent mode. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

getColor

public java.lang.Integer getColor()

Returns the color to impose on all notifications posted to this channel.

This is independent of Android O notification channels and should continue to work under Android O.

Returns:

The color to impose on all notifications posted to this channel. Returns null if this setting does not override the received notifications setting.

See Also:

Notification.Builder.setColor(int)

setColor

public WonderPushChannel setColor(java.lang.Integer color)

Sets the color to impose on all notifications posted to this channel.

This is independent of Android O notification channels and should continue to work under Android O.

Parameters:

color - The color to impose on all notifications posted to this channel. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

Notification.Builder.setColor(int)

getLocalOnly

public java.lang.Boolean getLocalOnly()

Returns whether notifications posted to this channel should be local to this device.

This is independent of Android O notification channels and should continue to work under Android O.

Returns:

Whether notifications posted to this channel should be local to this device. Returns null if this setting does not override the received notifications setting.

See Also:

Notification.Builder.setLocalOnly(boolean)

setLocalOnly

public WonderPushChannel setLocalOnly(java.lang.Boolean localOnly)

Sets whether notifications posted to this channel should be local to this device.

This is independent of Android O notification channels and should continue to work under Android O.

Parameters:

localOnly - Whether notifications posted to this channel should be local to this device. Use null to not override the received notifications setting.

Returns:

The channel object for chaining setters.

See Also:

Notification.Builder.setLocalOnly(boolean)