urbanairship-message-center-core/com.urbanairship.messagecenter/Message

Message

class Message @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val id: String, val title: String, val bodyUrl: String, val sentDate: Date, val expirationDate: Date?, val isUnread: Boolean, val extras: Map<String, String?>?, val contentType: Message.ContentType, messageUrl: String, reporting: JsonValue?, rawMessageJson: JsonValue, isUnreadClient: Boolean = isUnread, isDeletedClient: Boolean, associatedData: JsonValue?) : Parcelable(source)

Message Center Message data.

Constructors

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

constructor(id: String, title: String, bodyUrl: String, sentDate: Date, expirationDate: Date?, isUnread: Boolean, extras: Map<String, String?>?, contentType: Message.ContentType, messageUrl: String, reporting: JsonValue?, rawMessageJson: JsonValue, isUnreadClient: Boolean = isUnread, isDeletedClient: Boolean, associatedData: JsonValue?)

Types

object Companion

enum ContentType : Enum<Message.ContentType>

Properties

val bodyUrl: String

The URL for the message body. URL may only be accessed with Basic Auth credentials set to the user ID and password.

val contentType: Message.ContentType

val expirationDate: Date?

(Optional) The date and time the message will expire (UTC).

val extras: Map<String, String?>?

(Optional) Additional key-value pairs associated with the message.

The Airship message ID. May be used to match an incoming push notification to a specific Message.

val isDeleted: Boolean

Indicates whether the message has been deleted.

val isExpired: Boolean

Indicates whether the message has been expired.

val isRead: Boolean

Indicates whether the message has been read.

val isUnread: Boolean

val listIconUrl: String?

Optional list icon URL for this Message.

val productId: String

Product id used for impressions tracking. Defaults to DEFAULT_PRODUCT_ID.

val sentDate: Date

The date and time the message was sent (UTC).

val subtitle: String?

Optional subtitle for this Message.

val title: String

The message title.

Functions

fun ~~delete~~()

Deletes this Message

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

open override fun hashCode(): Int

fun ~~markRead~~()

Marks this Message as read.

fun ~~markUnread~~()

Marks this Message as unread

Inherited functions

describeContents

abstract fun describeContents(): Int

abstract fun writeToParcel(p0: Parcel, p1: Int)