vpn-api/com.duckduckgo.mobile.android.vpn.service/VpnEnabledNotificationContentPlugin

VpnEnabledNotificationContentPlugin

interface VpnEnabledNotificationContentPlugin

Types

data class VpnEnabledNotificationContent(val title: String?, val text: SpannableStringBuilder, val onNotificationPressIntent: PendingIntent?, val notificationActions: VpnEnabledNotificationContentPlugin.NotificationActions, val deleteIntent: PendingIntent?)

VpnEnabledNotificationPriority

enum VpnEnabledNotificationPriority : Enum<VpnEnabledNotificationContentPlugin.VpnEnabledNotificationPriority>

Properties

uuid

abstract val uuid: String

Functions

getInitialContent

abstract fun getInitialContent(): VpnEnabledNotificationContentPlugin.VpnEnabledNotificationContent?

This method will be called to show the first notification when the VPN is enabled. The method will be called from the main thread.

getPriority

abstract fun getPriority(): VpnEnabledNotificationContentPlugin.VpnEnabledNotificationPriority

The VPN will call this method to select what plugin will be displayed in the notification. To select a proper priority:

getUpdatedContent

abstract fun getUpdatedContent(): Flow<VpnEnabledNotificationContentPlugin.VpnEnabledNotificationContent?>

The VPN will subscribe to this flow, after it's being enabled, to get notification content updates. The method will NOT be called from the main thread.

isActive

abstract fun isActive(): Boolean

The VPN will call this method to know whether this plugin is active or not.