urbanairship-core/com.urbanairship.channel/AirshipChannel

AirshipChannel

class AirshipChannel : AirshipComponent

Airship channel access.

Properties

channelIdFlow

var channelIdFlow: StateFlow<String?>

Channel Id flow. Can be used to listen for when the channel is created.

channelTagRegistrationEnabled

var channelTagRegistrationEnabled: Boolean

Determines whether tags are enabled on the device.

val id: String?

Gets the channel identifier. This Id is created asynchronously, so initially it may be null. To be notified when the channel is updated, add a listener with .addChannelListener.

isChannelCreationDelayEnabled

val isChannelCreationDelayEnabled: Boolean

Determines whether channel creation is initially disabled, to be enabled later by enableChannelCreation.

Functions

addChannelListener

fun addChannelListener(listener: AirshipChannelListener)

Adds a channel listener.

editAttributes

fun editAttributes(): AttributeEditor

Edit the attributes associated with this channel.

editSubscriptionLists

fun editSubscriptionLists(): SubscriptionListEditor

Edit the channel subscription lists.

editTagGroups

fun editTagGroups(): TagGroupsEditor

Edit the channel tag groups.

editTags

fun editTags(): TagEditor

Edits channel Tags.

enableChannelCreation

fun enableChannelCreation()

Enables channel creation if channel creation has been delayed.

extend

suspend fun AirshipChannel.Extender.extend(builder: ChannelRegistrationPayload.Builder): ChannelRegistrationPayload.Builder

fetchSubscriptionLists

suspend fun fetchSubscriptionLists(): Result<Set<String>>

Returns the current set of subscription lists for the channel.

fetchSubscriptionListsPendingResult

fun fetchSubscriptionListsPendingResult(): PendingResult<Set<String>>

Returns the current set of subscription lists for the channel.

removeChannelListener

fun removeChannelListener(listener: AirshipChannelListener)

Removes a channel listener.