urbanairship-core/com.urbanairship.analytics/MediaEventTemplate

MediaEventTemplate

open class MediaEventTemplate

A class that represents a custom media event template for the application.

Properties

BROWSED_CONTENT_EVENT

@NonNull

val BROWSED_CONTENT_EVENT: String = "browsed_content"

The browsed event name.

CONSUMED_CONTENT_EVENT

@NonNull

val CONSUMED_CONTENT_EVENT: String = "consumed_content"

The consumed_content event name.

MEDIA_EVENT_TEMPLATE

@NonNull

val MEDIA_EVENT_TEMPLATE: String = "media"

The media event template type.

SHARED_CONTENT_EVENT

@NonNull

val SHARED_CONTENT_EVENT: String = "shared_content"

The shared_content event name.

STARRED_CONTENT_EVENT

@NonNull

val STARRED_CONTENT_EVENT: String = "starred_content"

The starred_content event name.

Functions

createEvent

@NonNull

open fun createEvent(): CustomEvent

Creates the custom media event.

newBrowsedTemplate

@NonNull

open fun newBrowsedTemplate(): MediaEventTemplate

Creates a browsed event template.

newConsumedTemplate

@NonNull

open fun newConsumedTemplate(): MediaEventTemplate

@NonNull

open fun newConsumedTemplate(value: Double): MediaEventTemplate

@NonNull

open fun newConsumedTemplate(value: Int): MediaEventTemplate

@NonNull

open fun newConsumedTemplate(@Nullable value: String): MediaEventTemplate

@NonNull

open fun newConsumedTemplate(@Nullable value: BigDecimal): MediaEventTemplate

Creates a consumed content event template.

newSharedTemplate

@NonNull

open fun newSharedTemplate(): MediaEventTemplate

@NonNull

open fun newSharedTemplate(@Nullable source: String, @Nullable medium: String): MediaEventTemplate

Creates a shared content event template.

newStarredTemplate

@NonNull

open fun newStarredTemplate(): MediaEventTemplate

Creates a starred content event template.

setAuthor

@NonNull

open fun setAuthor(@Nullable author: String): MediaEventTemplate

Set the author.

setCategory

@NonNull

open fun setCategory(@Nullable category: String): MediaEventTemplate

Set the category.

setDescription

@NonNull

open fun setDescription(@Nullable description: String): MediaEventTemplate

Set the description.

setFeature

@NonNull

open fun setFeature(feature: Boolean): MediaEventTemplate

Set the feature.

setId

@NonNull

open fun setId(@Nullable id: String): MediaEventTemplate

Set the ID.

setPublishedDate

@NonNull

open fun setPublishedDate(@Nullable publishedDate: String): MediaEventTemplate

Set the publishedDate.

setType

@NonNull

open fun setType(@Nullable type: String): MediaEventTemplate

Set the type.