Package org.mozilla.geckoview

Interface GeckoSession.PromptDelegate

Enclosing class:

GeckoSession

public static interface GeckoSession.PromptDelegate

GeckoSession applications implement this interface to handle prompts triggered by content in the GeckoSession, such as alerts, authentication dialogs, and select list pickers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GeckoSession.PromptDelegate.AlertPrompt	AlertPrompt contains the information necessary to represent a JavaScript alert() call from content; it can only be dismissed, not confirmed.
static class	GeckoSession.PromptDelegate.AuthPrompt	AuthPrompt contains the information necessary to represent an HTML authorization prompt generated by content.
static class	GeckoSession.PromptDelegate.AutocompleteRequest<T extends Autocomplete.Option<?>>	Request containing information required to resolve Autocomplete prompt requests.
static class	GeckoSession.PromptDelegate.BasePrompt
static class	GeckoSession.PromptDelegate.BeforeUnloadPrompt	BeforeUnloadPrompt represents the onbeforeunload prompt.
static class	GeckoSession.PromptDelegate.ButtonPrompt	ButtonPrompt contains the information necessary to represent a JavaScript confirm() call from content.
static class	GeckoSession.PromptDelegate.ChoicePrompt	ChoicePrompt contains the information necessary to display a menu or list prompt generated by content.
static class	GeckoSession.PromptDelegate.ColorPrompt	ColorPrompt contains the information necessary to represent a prompt for color input generated by content.
static class	GeckoSession.PromptDelegate.DateTimePrompt	DateTimePrompt contains the information necessary to represent a prompt for date and/or time input generated by content.
static class	GeckoSession.PromptDelegate.FilePrompt	FilePrompt contains the information necessary to represent a prompt for a file or files generated by content.
static final class	GeckoSession.PromptDelegate.IdentityCredential	Contains all the Identity credential prompts (FedCM)
static class	GeckoSession.PromptDelegate.PopupPrompt	PopupPrompt contains the information necessary to represent a popup blocking request.
static interface	GeckoSession.PromptDelegate.PromptInstanceDelegate
static class	GeckoSession.PromptDelegate.PromptResponse	PromptResponse is an opaque class created upon confirming or dismissing a prompt.
static class	GeckoSession.PromptDelegate.RepostConfirmPrompt	RepostConfirmPrompt represents a prompt shown whenever the browser needs to resubmit POST data (e.g.
static class	GeckoSession.PromptDelegate.SharePrompt	SharePrompt contains the information necessary to represent a (v1) WebShare request.
static class	GeckoSession.PromptDelegate.TextPrompt	TextPrompt contains the information necessary to represent a Javascript prompt() call from content.

Method Summary

Modifier and Type	Method	Description
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onAddressSave(GeckoSession session, GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.AddressSaveOption> request)	Handle a address save prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onAddressSelect(GeckoSession session, GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.AddressSelectOption> request)	Handle a address selection prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onAlertPrompt(GeckoSession session, GeckoSession.PromptDelegate.AlertPrompt prompt)	Display an alert prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onAuthPrompt(GeckoSession session, GeckoSession.PromptDelegate.AuthPrompt prompt)	Display an authorization prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onBeforeUnloadPrompt(GeckoSession session, GeckoSession.PromptDelegate.BeforeUnloadPrompt prompt)	Display a onbeforeunload prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onButtonPrompt(GeckoSession session, GeckoSession.PromptDelegate.ButtonPrompt prompt)	Display a button prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onChoicePrompt(GeckoSession session, GeckoSession.PromptDelegate.ChoicePrompt prompt)	Display a list/menu prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onColorPrompt(GeckoSession session, GeckoSession.PromptDelegate.ColorPrompt prompt)	Display a color prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onCreditCardSave(GeckoSession session, GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.CreditCardSaveOption> request)	Handle a credit card save prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onCreditCardSelect(GeckoSession session, GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.CreditCardSelectOption> request)	Handle a credit card selection prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onDateTimePrompt(GeckoSession session, GeckoSession.PromptDelegate.DateTimePrompt prompt)	Display a date/time prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onFilePrompt(GeckoSession session, GeckoSession.PromptDelegate.FilePrompt prompt)	Display a file prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onLoginSave(GeckoSession session, GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.LoginSaveOption> request)	Handle a login save prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onLoginSelect(GeckoSession session, GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.LoginSelectOption> request)	Handle a login selection prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onPopupPrompt(GeckoSession session, GeckoSession.PromptDelegate.PopupPrompt prompt)	Display a popup request prompt; this occurs when content attempts to open a new window in a way that doesn't appear to be the result of user input.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onRepostConfirmPrompt(GeckoSession session, GeckoSession.PromptDelegate.RepostConfirmPrompt prompt)	Display a POST resubmission confirmation prompt.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onSelectIdentityCredentialAccount(GeckoSession session, GeckoSession.PromptDelegate.IdentityCredential.AccountSelectorPrompt prompt)	Handle an Identity Credential Account selection prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onSelectIdentityCredentialProvider(GeckoSession session, GeckoSession.PromptDelegate.IdentityCredential.ProviderSelectorPrompt prompt)	Handle an Identity Credential Provider selection prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onSharePrompt(GeckoSession session, GeckoSession.PromptDelegate.SharePrompt prompt)	Display a share request prompt; this occurs when content attempts to use the WebShare API.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onShowPrivacyPolicyIdentityCredential(GeckoSession session, GeckoSession.PromptDelegate.IdentityCredential.PrivacyPolicyPrompt prompt)	Handle an Identity Credential privacy policy prompt request.
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse>	onTextPrompt(GeckoSession session, GeckoSession.PromptDelegate.TextPrompt prompt)	Display a text prompt.

Method Details

onAlertPrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onAlertPrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.AlertPrompt prompt)

Display an alert prompt.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.AlertPrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onBeforeUnloadPrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onBeforeUnloadPrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.BeforeUnloadPrompt prompt)

Display a onbeforeunload prompt.

See https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onbeforeunload See GeckoSession.PromptDelegate.BeforeUnloadPrompt

Parameters:

session - GeckoSession that triggered the prompt

prompt - the GeckoSession.PromptDelegate.BeforeUnloadPrompt that describes the prompt.

Returns:

A GeckoResult resolving to AllowOrDeny.ALLOW if the page is allowed to continue with the navigation or AllowOrDeny.DENY otherwise.

onRepostConfirmPrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onRepostConfirmPrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.RepostConfirmPrompt prompt)

Display a POST resubmission confirmation prompt.

This prompt will trigger whenever refreshing or navigating to a page needs resubmitting POST data that has been submitted already.

Parameters:

session - GeckoSession that triggered the prompt

prompt - the GeckoSession.PromptDelegate.RepostConfirmPrompt that describes the prompt.

Returns:

A GeckoResult resolving to AllowOrDeny.ALLOW if the page is allowed to continue with the navigation and resubmit the POST data or AllowOrDeny.DENY otherwise.

onButtonPrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onButtonPrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.ButtonPrompt prompt)

Display a button prompt.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.ButtonPrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onTextPrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onTextPrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.TextPrompt prompt)

Display a text prompt.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.TextPrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onAuthPrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onAuthPrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.AuthPrompt prompt)

Display an authorization prompt.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.AuthPrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onChoicePrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onChoicePrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.ChoicePrompt prompt)

Display a list/menu prompt.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.ChoicePrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onColorPrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onColorPrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.ColorPrompt prompt)

Display a color prompt.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.ColorPrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onDateTimePrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onDateTimePrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.DateTimePrompt prompt)

Display a date/time prompt.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.DateTimePrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onFilePrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onFilePrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.FilePrompt prompt)

Display a file prompt.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.FilePrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onPopupPrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onPopupPrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.PopupPrompt prompt)

Display a popup request prompt; this occurs when content attempts to open a new window in a way that doesn't appear to be the result of user input.

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.PopupPrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onSharePrompt

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onSharePrompt(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.SharePrompt prompt)

Display a share request prompt; this occurs when content attempts to use the WebShare API. See: https://developer.mozilla.org/en-US/docs/Web/API/Navigator/share

Parameters:

session - GeckoSession that triggered the prompt.

prompt - The GeckoSession.PromptDelegate.SharePrompt that describes the prompt.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onLoginSave

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onLoginSave(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.LoginSaveOption> request)

Handle a login save prompt request. This is triggered by the user entering new or modified login credentials into a login form.

Parameters:

session - The GeckoSession that triggered the request.

request - The GeckoSession.PromptDelegate.AutocompleteRequest containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse.

Confirm the request with an Autocomplete.Option to trigger a Autocomplete.StorageDelegate.onLoginSave(org.mozilla.geckoview.Autocomplete.LoginEntry) request to save the given selection. The confirmed selection may be an entry out of the request's options, a modified option, or a freshly created login entry.

Dismiss the request to deny the saving request.

onAddressSave

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onAddressSave(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.AddressSaveOption> request)

Handle a address save prompt request. This is triggered by the user entering new or modified address credentials into a address form.

Parameters:

session - The GeckoSession that triggered the request.

request - The GeckoSession.PromptDelegate.AutocompleteRequest containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse.

Confirm the request with an Autocomplete.Option to trigger a Autocomplete.StorageDelegate.onAddressSave(org.mozilla.geckoview.Autocomplete.Address) request to save the given selection. The confirmed selection may be an entry out of the request's options, a modified option, or a freshly created address entry.

Dismiss the request to deny the saving request.

onCreditCardSave

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onCreditCardSave(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.CreditCardSaveOption> request)

Handle a credit card save prompt request. This is triggered by the user entering new or modified credit card credentials into a form.

Parameters:

session - The GeckoSession that triggered the request.

request - The GeckoSession.PromptDelegate.AutocompleteRequest containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse.

Confirm the request with an Autocomplete.Option to trigger a Autocomplete.StorageDelegate.onCreditCardSave(org.mozilla.geckoview.Autocomplete.CreditCard) request to save the given selection. The confirmed selection may be an entry out of the request's options, a modified option, or a freshly created credit card entry.

Dismiss the request to deny the saving request.

onLoginSelect

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onLoginSelect(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.LoginSelectOption> request)

Handle a login selection prompt request. This is triggered by the user focusing on a login username field.

Parameters:

session - The GeckoSession that triggered the request.

request - The GeckoSession.PromptDelegate.AutocompleteRequest containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse

Confirm the request with an Autocomplete.Option to let GeckoView fill out the login forms with the given selection details. The confirmed selection may be an entry out of the request's options, a modified option, or a freshly created login entry.

Dismiss the request to deny autocompletion for the detected form.

onSelectIdentityCredentialProvider

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onSelectIdentityCredentialProvider(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.IdentityCredential.ProviderSelectorPrompt prompt)

Handle an Identity Credential Provider selection prompt request. This is triggered by the user focusing on selecting a provider for authenticating.

Parameters:

session - The GeckoSession that triggered the request.

prompt - The GeckoSession.PromptDelegate.IdentityCredential.ProviderSelectorPrompt containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onSelectIdentityCredentialAccount

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onSelectIdentityCredentialAccount(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.IdentityCredential.AccountSelectorPrompt prompt)

Handle an Identity Credential Account selection prompt request. This is triggered by the user focusing on selecting a provider for authenticating.

Parameters:

session - The GeckoSession that triggered the request.

prompt - The GeckoSession.PromptDelegate.IdentityCredential.ProviderSelectorPrompt containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onShowPrivacyPolicyIdentityCredential

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onShowPrivacyPolicyIdentityCredential(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.IdentityCredential.PrivacyPolicyPrompt prompt)

Handle an Identity Credential privacy policy prompt request.

Parameters:

session - The GeckoSession that triggered the request.

prompt - The GeckoSession.PromptDelegate.IdentityCredential.PrivacyPolicyPrompt containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse which includes all necessary information to resolve the prompt.

onCreditCardSelect

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onCreditCardSelect(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.CreditCardSelectOption> request)

Handle a credit card selection prompt request. This is triggered by the user focusing on a credit card input field.

Parameters:

session - The GeckoSession that triggered the request.

request - The GeckoSession.PromptDelegate.AutocompleteRequest containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse

Confirm the request with an Autocomplete.Option to let GeckoView fill out the credit card forms with the given selection details. The confirmed selection may be an entry out of the request's options, a modified option, or a freshly created credit card entry.

Dismiss the request to deny autocompletion for the detected form.

onAddressSelect

@UiThread
@Nullable
default GeckoResult<GeckoSession.PromptDelegate.PromptResponse> onAddressSelect(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.PromptDelegate.AutocompleteRequest<Autocomplete.AddressSelectOption> request)

Handle a address selection prompt request. This is triggered by the user focusing on a address field.

Parameters:

session - The GeckoSession that triggered the request.

request - The GeckoSession.PromptDelegate.AutocompleteRequest containing the request details.

Returns:

A GeckoResult resolving to a GeckoSession.PromptDelegate.PromptResponse

Confirm the request with an Autocomplete.Option to let GeckoView fill out the address forms with the given selection details. The confirmed selection may be an entry out of the request's options, a modified option, or a freshly created address entry.

Dismiss the request to deny autocompletion for the detected form.