urbanairship-core/com.urbanairship.channel/AirshipChannel

AirshipChannel

class AirshipChannel : AirshipComponent(source)

Airship channel access.

Constructors

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

constructor(context: Context, dataStore: PreferenceDataStore, runtimeConfig: AirshipRuntimeConfig, privacyManager: PrivacyManager, permissionsManager: PermissionsManager, localeManager: LocaleManager, audienceOverridesProvider: AudienceOverridesProvider, channelRegistrar: ChannelRegistrar)

Properties

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.

val subscriptions: Flow<Result<Set<String>>>

var tags: Set<String>

Set tags for the channel and update the server.

Inherited properties

defaultExecutor

protected val defaultExecutor: Executor

Default job executor.

Functions

addChannelListener

fun addChannelListener(listener: AirshipChannelListener)

Adds a channel listener.

buildCraPayload

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

suspend fun buildCraPayload(): ChannelRegistrationPayload

fun editAttributes(): AttributeEditor

Edit the attributes associated with this channel.

fun editAttributes(block: AttributeEditor.() -> Unit)

Edits the attributes associated with this channel. Automatically calls AttributeEditor.apply.

editSubscriptionLists

fun editSubscriptionLists(): SubscriptionListEditor

Edit the channel subscription lists.

fun editSubscriptionLists(block: SubscriptionListEditor.() -> Unit)

Edits the channel subscription lists. Automatically calls SubscriptionListEditor.apply.

fun editTagGroups(): TagGroupsEditor

Edit the channel tag groups.

fun editTagGroups(block: TagGroupsEditor.() -> Unit)

Edits channel tag groups. Automatically calls TagGroupsEditor.apply.

fun editTags(): TagEditor

Edits channel Tags.

fun editTags(block: TagEditor.() -> Unit)

Edits channel Tags. Automatically calls TagEditor.apply.

enableChannelCreation

fun enableChannelCreation()

Enables channel creation if channel creation has been delayed.

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.