cdp/dev.kdriver.cdp.domain/FedCm

FedCm

class FedCm(cdp: CDP) : Domain

This domain allows interacting with the FedCM dialog.

Constructors

FedCm

constructor(cdp: CDP)

Types

Account

@Serializable

data class Account(val accountId: String, val email: String, val name: String, val givenName: String, val pictureUrl: String, val idpConfigUrl: String, val idpLoginUrl: String, val loginState: FedCm.LoginState, val termsOfServiceUrl: String? = null, val privacyPolicyUrl: String? = null)

Corresponds to IdentityRequestAccount

AccountUrlType

@Serializable

enum AccountUrlType : Enum<FedCm.AccountUrlType>

The URLs that each account has

ClickDialogButtonParameter

@Serializable

data class ClickDialogButtonParameter(val dialogId: String, val dialogButton: FedCm.DialogButton)

DialogButton

@Serializable

enum DialogButton : Enum<FedCm.DialogButton>

The buttons on the FedCM dialog.

DialogClosedParameter

@Serializable

data class DialogClosedParameter(val dialogId: String)

Triggered when a dialog is closed, either by user action, JS abort, or a command below.

DialogShownParameter

@Serializable

data class DialogShownParameter(val dialogId: String, val dialogType: FedCm.DialogType, val accounts: List<FedCm.Account>, val title: String, val subtitle: String? = null)

DialogType

@Serializable

enum DialogType : Enum<FedCm.DialogType>

The types of FedCM dialogs.

DismissDialogParameter

@Serializable

data class DismissDialogParameter(val dialogId: String, val triggerCooldown: Boolean? = null)

EnableParameter

@Serializable

data class EnableParameter(val disableRejectionDelay: Boolean? = null)

LoginState

@Serializable

enum LoginState : Enum<FedCm.LoginState>

Whether this is a sign-up or sign-in action for this account, i.e. whether this account has ever been used to sign in to this RP before.

OpenUrlParameter

@Serializable

data class OpenUrlParameter(val dialogId: String, val accountIndex: Int, val accountUrlType: FedCm.AccountUrlType)

SelectAccountParameter

@Serializable

data class SelectAccountParameter(val dialogId: String, val accountIndex: Int)

Properties

dialogClosed

val dialogClosed: Flow<FedCm.DialogClosedParameter>

Triggered when a dialog is closed, either by user action, JS abort, or a command below.

dialogShown

val dialogShown: Flow<FedCm.DialogShownParameter>

Functions

clickDialogButton

suspend fun clickDialogButton(args: FedCm.ClickDialogButtonParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun clickDialogButton(dialogId: String, dialogButton: FedCm.DialogButton)

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

dismissDialog

suspend fun dismissDialog(args: FedCm.DismissDialogParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun dismissDialog(dialogId: String, triggerCooldown: Boolean? = null)

enable

suspend fun enable(disableRejectionDelay: Boolean? = null)

suspend fun enable(args: FedCm.EnableParameter, mode: CommandMode = CommandMode.DEFAULT)

openUrl

suspend fun openUrl(args: FedCm.OpenUrlParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun openUrl(dialogId: String, accountIndex: Int, accountUrlType: FedCm.AccountUrlType)

resetCooldown

suspend fun resetCooldown(mode: CommandMode = CommandMode.DEFAULT)

Resets the cooldown time, if any, to allow the next FedCM call to show a dialog even if one was recently dismissed by the user.

selectAccount

suspend fun selectAccount(args: FedCm.SelectAccountParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun selectAccount(dialogId: String, accountIndex: Int)