ShareActionProvider

Kotlin |Java

open class ShareActionProvider : ActionProvider

kotlin.Any
↳	android.view.ActionProvider
	↳	android.widget.ShareActionProvider

This is a provider for a share action. It is responsible for creating views that enable data sharing and also to show a sub menu with sharing activities if the hosting item is placed on the overflow menu.

Here is how to use the action provider with custom backing file in a MenuItem:

// In Activity#onCreateOptionsMenu
  public boolean onCreateOptionsMenu(Menu menu) {
      // Get the menu item.
      MenuItem menuItem = menu.findItem(R.id.my_menu_item);
      // Get the provider and hold onto it to set/change the share intent.
      mShareActionProvider = (ShareActionProvider) menuItem.getActionProvider();
      // Set history different from the default before getting the action
      // view since a call to <code><a docref="android.view.MenuItem$getActionView()">MenuItem.getActionView()</a></code>calls
      // <code><a docref="android.view.ActionProvider$onCreateActionView()">ActionProvider.onCreateActionView()</a></code>which uses the backing file name. Omit this
      // line if using the default share history file is desired.
      mShareActionProvider.setShareHistoryFileName("custom_share_history.xml");
      . . .
  }
 
  // Somewhere in the application.
  public void doShare(Intent shareIntent) {
      // When you want to share set the share intent.
      mShareActionProvider.setShareIntent(shareIntent);
  }

Note: While the sample snippet demonstrates how to use this provider in the context of a menu item, the use of the provider is not limited to menu items.

Summary

Nested classes
abstract	`OnShareTargetSelectedListener` Listener for the event of selecting a share target.

Constants
static String	`DEFAULT_SHARE_HISTORY_FILE_NAME` The default name for storing share history.

Public constructors
`ShareActionProvider(context: Context!)` Creates a new instance.

Public methods
open Boolean	`hasSubMenu()` Determines if this ActionProvider has a submenu associated with it.
open View	`onCreateActionView()` Factory method called by the Android framework to create new action views.
open Unit	`onPrepareSubMenu(subMenu: SubMenu)` Called to prepare an associated submenu for the menu item backed by this ActionProvider.
open Unit	`setOnShareTargetSelectedListener(listener: ShareActionProvider.OnShareTargetSelectedListener!)` Sets a listener to be notified when a share target has been selected.
open Unit	`setShareHistoryFileName(shareHistoryFile: String!)` Sets the file name of a file for persisting the share history which history will be used for ordering share targets.
open Unit	`setShareIntent(shareIntent: Intent!)` Sets an intent with information about the share action.

Inherited functions

From class ActionProvider

`Boolean`	`isVisible()` If `overridesItemVisibility()` returns true, the return value of this method will help determine the visibility of the `MenuItem` this ActionProvider is bound to. If the MenuItem's visibility is explicitly set to false by the application, the MenuItem will not be shown, even if this method returns true.
`View`	`onCreateActionView(forItem: MenuItem)` Factory method called by the Android framework to create new action views. This method returns a new action view for the given MenuItem. If your ActionProvider implementation overrides the deprecated no-argument overload `onCreateActionView()`, overriding this method for devices running API 16 or later is recommended but optional. The default implementation calls `onCreateActionView()` for compatibility with applications written for older platform versions.
`Boolean`	`onPerformDefaultAction()` Performs an optional default action. For the case of an action provider placed in a menu item not shown as an action this method is invoked if previous callbacks for processing menu selection has handled the event. A menu item selection is processed in the following order: Receiving a call to `MenuItem.OnMenuItemClickListener.onMenuItemClick`. Receiving a call to `Activity.onOptionsItemSelected(MenuItem)` Receiving a call to `Fragment.onOptionsItemSelected(MenuItem)` Launching the `android.content.Intent` set via `MenuItem.setIntent(android.content.Intent)` Invoking this method. The default implementation does not perform any action and returns false.
`Boolean`	`overridesItemVisibility()` The result of this method determines whether or not `isVisible()` will be used by the `MenuItem` this ActionProvider is bound to help determine its visibility.
`Unit`	`refreshVisibility()` If this ActionProvider is associated with an item in a menu, refresh the visibility of the item based on `overridesItemVisibility()` and `isVisible()`. If `overridesItemVisibility()` returns false, this call will have no effect.
`Unit`	`setVisibilityListener(listener: ActionProvider.VisibilityListener?)` Set a listener to be notified when this ActionProvider's overridden visibility changes. This should only be used by MenuItem implementations.

Constants

DEFAULT_SHARE_HISTORY_FILE_NAME

Added in API level 14

static val DEFAULT_SHARE_HISTORY_FILE_NAME: String

The default name for storing share history.

Value: "share_history.xml"

Public constructors

ShareActionProvider

Added in API level 14

ShareActionProvider(context: Context!)

Creates a new instance.

Parameters
`context`	Context!: Context for accessing resources.

Public methods

hasSubMenu

Added in API level 14

open fun hasSubMenu(): Boolean

Determines if this ActionProvider has a submenu associated with it.

Associated submenus will be shown when an action view is not. This provider instance will receive a call to onPrepareSubMenu(android.view.SubMenu) after the call to onPerformDefaultAction() and before a submenu is displayed to the user.

Return
`Boolean`	true if the item backed by this provider should have an associated submenu

onCreateActionView

Added in API level 14

open fun onCreateActionView(): View

Factory method called by the Android framework to create new action views.

This method has been deprecated in favor of onCreateActionView(android.view.MenuItem). Newer apps that wish to support platform versions prior to API 16 should also implement this method to return a valid action view.

Return
`View`	A new action view. This value cannot be `null`.

onPrepareSubMenu

Added in API level 14

open fun onPrepareSubMenu(subMenu: SubMenu): Unit

Called to prepare an associated submenu for the menu item backed by this ActionProvider.

if hasSubMenu() returns true, this method will be called when the menu item is selected to prepare the submenu for presentation to the user. Apps may use this to create or alter submenu content right before display.

Parameters
`subMenu`	SubMenu: Submenu that will be displayed This value cannot be `null`.

setOnShareTargetSelectedListener

Added in API level 14

open fun setOnShareTargetSelectedListener(listener: ShareActionProvider.OnShareTargetSelectedListener!): Unit

Sets a listener to be notified when a share target has been selected. The listener can optionally decide to handle the selection and not rely on the default behavior which is to launch the activity.

Note: If you choose the backing share history file you will still be notified in this callback.

Parameters
`listener`	ShareActionProvider.OnShareTargetSelectedListener!: The listener.

setShareHistoryFileName

Added in API level 14

open fun setShareHistoryFileName(shareHistoryFile: String!): Unit

Sets the file name of a file for persisting the share history which history will be used for ordering share targets. This file will be used for all view created by onCreateActionView(). Defaults to DEFAULT_SHARE_HISTORY_FILE_NAME. Set to null if share history should not be persisted between sessions.

Note: The history file name can be set any time, however only the action views created by onCreateActionView() after setting the file name will be backed by the provided file. Therefore, if you want to use different history files for sharing specific types of content, every time you change the history file setShareHistoryFileName(java.lang.String) you must call android.app.Activity#invalidateOptionsMenu() to recreate the action view. You should not call android.app.Activity#invalidateOptionsMenu() from android.app.Activity#onCreateOptionsMenu(Menu).

private void doShare(Intent intent) {
      if (IMAGE.equals(intent.getMimeType())) {
          mShareActionProvider.setHistoryFileName(SHARE_IMAGE_HISTORY_FILE_NAME);
      } else if (TEXT.equals(intent.getMimeType())) {
          mShareActionProvider.setHistoryFileName(SHARE_TEXT_HISTORY_FILE_NAME);
      }
      mShareActionProvider.setIntent(intent);
      invalidateOptionsMenu();
  }

Parameters
`shareHistoryFile`	String!: The share history file name.

setShareIntent

Added in API level 14

open fun setShareIntent(shareIntent: Intent!): Unit

Sets an intent with information about the share action. Here is a sample for constructing a share intent:

Intent shareIntent = new Intent(Intent.ACTION_SEND);
  shareIntent.setType("image/*");
  Uri uri = Uri.fromFile(new File(getFilesDir(), "foo.jpg"));
  shareIntent.putExtra(Intent.EXTRA_STREAM, uri);

Parameters
`shareIntent`	Intent!: The share intent.

See Also