urbanairship-core/com.urbanairship.push.notifications/NotificationChannelCompat

NotificationChannelCompat

class NotificationChannelCompat : JsonSerializable(source)

Compatibility class for supporting NotificationChannel functionality across Android OS versions.

Constructors

@RequiresApi(api = 26)

constructor(notificationChannel: NotificationChannel)

NotificationChannelCompat constructor.

constructor(id: String, name: CharSequence, importance: Int)

NotificationChannelCompat constructor.

Types

Companion

object Companion

Properties

bypassDnd

@JvmField

var bypassDnd: Boolean

Indicates whether the channel can bypass do-not-disturb.

description

@JvmField

var description: String?

The channel's description.

group

@JvmField

var group: String?

The channel's group.

val id: String

The channel's identifier.

importance

@JvmField

var importance: Int

The channel's importance.

lightColor

@JvmField

var lightColor: Int

The channel's light color.

lockscreenVisibility

@JvmField

var lockscreenVisibility: Int

The channel's lockscreen visibility.

name

var name: CharSequence

The channel's name.

showBadge

var showBadge: Boolean

Indicates whether the channel can show badges

sound

@JvmField

var sound: Uri?

The channel's sound.

vibrationPattern

@JvmField

var vibrationPattern: LongArray?

The channel's vibration pattern.

Functions

enableLights

fun enableLights(lights: Boolean)

Sets whether the channel can show lights.

enableVibration

fun enableVibration(vibration: Boolean)

Sets whether the channel can vibrate.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

shouldShowLights

fun shouldShowLights(): Boolean

Indicates whether the channel can show lights.

shouldVibrate

fun shouldVibrate(): Boolean

Indicates whether the channel can vibrate.

toJsonValue

open override fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

toNotificationChannel

@RequiresApi(api = 26)

fun toNotificationChannel(): NotificationChannel

Creates a corresponding NotificationChannel object for Android O and above.

toString

open override fun toString(): String