3.1 KiB

Raw Permalink Blame History

Prompts

A feature for displaying native dialogs. It will subscribe to the selected session and will handle all the common prompt dialogs from web content like input type date, file, time, color, option, menu, authentication, confirmation and alerts.

Usage

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

implementation "org.mozilla.components:feature-prompts:{latest-version}"

PromptFeature

val onNeedToRequestPermissions : (Array<String>) -> Unit = { permissions ->
  /* You are in charge of triggering the request for the permissions needed,
   * this way you can control, when you request the permissions,
   * in case that you want to show an informative dialog,
   * to clarify the use of these permissions.
   */
  this.requestPermissions(permissions, MY_PROMPT_PERMISSION_REQUEST_CODE)
}

val promptFeature = PromptFeature(fragment = this,
    fragment = fragment,
    store = store,
    fragmentManager= fragmentManager,
    onNeedToRequestPermissions = onNeedToRequestPermissions
)

// It will start listing for new prompt requests from web content.
promptFeature.start()

// It will stop listing for prompt requests from web content.
promptFeature.stop()

/* There are some requests that are not handled with dialogs, instead they are delegated to other apps
 * to perform the request e.g a file picker request, which delegates to the OS file picker.
 * For this reason, you have to forward the results of these requests to the prompt feature by overriding,
 * onActivityResult in your Activity or Fragment and forward its calls to promptFeature.onActivityResult.
 */
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
  promptFeature.onActivityResult(requestCode, resultCode, data)
}

/* Additionally, there are requests that need to have some runtime permission before they can be performed,
 * like file pickers request that need access to read the selected files. You need to override
 * onRequestPermissionsResult in your Activity or Fragment and forward the results to
 * promptFeature.PermissionsResult.
 */
override fun onRequestPermissionsResult(requestCode: Int, permissions: Array<String>, grantResults: IntArray) {
  when (requestCode) {
      MY_PROMPT_PERMISSION_REQUEST_CODE -> promptFeature.onPermissionsResult(permissions, grantResults)
  }
}

Facts

This component emits the following Facts:

Action	Item	Description
DISPLAY	prompt	A prompt was shown.
CANCEL	prompt	A prompt was canceled.
CONFIRM	prompt	A prompt was confirmed.

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/

3.1 KiB Raw Permalink Blame History