Added in API level 14

Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods

ShareActionProvider

Kotlin |Java

public class ShareActionProvider
extends ActionProvider

java.lang.Object
↳	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 MenuItem.getActionView() calls
     // ActionProvider.onCreateActionView() 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.

See also:

ActionProvider

Summary

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

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

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

Public methods
`boolean`	`hasSubMenu()` Determines if this ActionProvider has a submenu associated with it.
`View`	`onCreateActionView()` This method is deprecated. use `onCreateActionView(android.view.MenuItem)`
`void`	`onPrepareSubMenu(SubMenu subMenu)` Called to prepare an associated submenu for the menu item backed by this ActionProvider.
`void`	`setOnShareTargetSelectedListener(ShareActionProvider.OnShareTargetSelectedListener listener)` Sets a listener to be notified when a share target has been selected.
`void`	`setShareHistoryFileName(String shareHistoryFile)` Sets the file name of a file for persisting the share history which history will be used for ordering share targets.
`void`	`setShareIntent(Intent shareIntent)` Sets an intent with information about the share action.

Inherited methods

From class


        
          android.view.ActionProvider

`boolean`	`hasSubMenu()` Determines if this ActionProvider has a submenu associated with it.
`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.
`abstract View`	`onCreateActionView()` This method was deprecated in API level 16. use `onCreateActionView(android.view.MenuItem)`
`View`	`onCreateActionView(MenuItem forItem)` Factory method called by the Android framework to create new action views.
`boolean`	`onPerformDefaultAction()` Performs an optional default action.
`void`	`onPrepareSubMenu(SubMenu subMenu)` Called to prepare an associated submenu for the menu item backed by this ActionProvider.
`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.
`void`	`refreshVisibility()` If this ActionProvider is associated with an item in a menu, refresh the visibility of the item based on `overridesItemVisibility()` and `isVisible()`.
`void`	`setVisibilityListener(ActionProvider.VisibilityListener listener)` Set a listener to be notified when this ActionProvider's overridden visibility changes.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

DEFAULT_SHARE_HISTORY_FILE_NAME

Added in API level 14

public static final String DEFAULT_SHARE_HISTORY_FILE_NAME

The default name for storing share history.

Constant Value: "share_history.xml"

Public constructors

ShareActionProvider

Added in API level 14

public ShareActionProvider (Context context)

Creates a new instance.

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

Public methods

hasSubMenu

Added in API level 14

public boolean hasSubMenu ()

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.

Returns
`boolean`	true if the item backed by this provider should have an associated submenu

onCreateActionView

Added in API level 14

public View onCreateActionView ()

This method is deprecated.
use onCreateActionView(android.view.MenuItem)

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.

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

onPrepareSubMenu

Added in API level 14

public void onPrepareSubMenu (SubMenu subMenu)

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`.

Added in API level 14

public void setOnShareTargetSelectedListener (ShareActionProvider.OnShareTargetSelectedListener listener)

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

public void setShareHistoryFileName (String shareHistoryFile)

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 Activity.invalidateOptionsMenu() to recreate the action view. You should not call Activity.invalidateOptionsMenu() from 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

public void setShareIntent (Intent shareIntent)

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:

ShareActionProvider

Summary

Nested classes

Constants

Public constructors

Public methods

Inherited methods

Constants

DEFAULT_SHARE_HISTORY_FILE_NAME

Public constructors

ShareActionProvider

Public methods

hasSubMenu

onCreateActionView

onPrepareSubMenu

setOnShareTargetSelectedListener

setShareHistoryFileName

setShareIntent