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

NotificationChannelCompat

open class NotificationChannelCompat : JsonSerializable

Compatibility class for supporting NotificationChannel functionality across Android OS versions.

Constructors

Link copied to clipboard
@RequiresApi(api = Build.VERSION_CODES.O)
constructor(@NonNull notificationChannel: NotificationChannel)
NotificationChannelCompat constructor.
constructor(@NonNull id: String, @NonNull name: CharSequence, importance: Int)
NotificationChannelCompat constructor.

Properties

Link copied to clipboard
open var bypassDnd: Boolean
Link copied to clipboard
@get:Nullable
open var description: String
Link copied to clipboard
@get:Nullable
open var group: String
Link copied to clipboard
open var importance: Int
Link copied to clipboard
open var lightColor: Int
Link copied to clipboard
Link copied to clipboard
@get:NonNull
open var name: CharSequence
Link copied to clipboard
open var showBadge: Boolean
Link copied to clipboard
@get:Nullable
open var sound: Uri
Link copied to clipboard

Functions

Link copied to clipboard
open fun enableLights(lights: Boolean)
Sets whether the channel can show lights.
Link copied to clipboard
open fun enableVibration(vibration: Boolean)
Sets whether the channel can vibrate.
Link copied to clipboard
open fun equals(o: Any): Boolean
Link copied to clipboard
@Nullable
open fun fromJson(@NonNull jsonValue: JsonValue): NotificationChannelCompat
Factory method for creating a NotificationChannelCompat out of a JSON payload.
Link copied to clipboard
@NonNull
open fun getId(): String
Gets the channel's identifier.
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun shouldShowLights(): Boolean
Indicates whether the channel can show lights.
Link copied to clipboard
open fun shouldVibrate(): Boolean
Indicates whether the channel can vibrate.
Link copied to clipboard
@NonNull
open fun toJsonValue(): JsonValue
Returns the objects represented as a JsonValue.
Link copied to clipboard
@RequiresApi(api = Build.VERSION_CODES.O)
@NonNull
open fun toNotificationChannel(): NotificationChannel
Creates a corresponding NotificationChannel object for Android O and above.
Link copied to clipboard
@NonNull
open fun toString(): String