Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in version 1.0.0
belongs to Maven artifact androidx.core:core:1.0.0-rc01

ShareCompat.IntentReader

public static class ShareCompat.IntentReader
extends Object

java.lang.Object
   ↳ androidx.core.app.ShareCompat.IntentReader


IntentReader is a helper for reading the data contained within a sharing (ACTION_SEND) Intent. It provides methods to parse standard elements included with a share in addition to extra metadata about the app that shared the content.

Social sharing apps are encouraged to provide attribution for the app that shared the content. IntentReader offers access to the application label, calling activity info, and application icon of the app that shared the content. This data may have been provided voluntarily by the calling app and should always be displayed to the user before submission for manual verification. The user should be offered the option to omit this information from shared posts if desired.

Activities that intend to receive sharing intents should configure an intent-filter to accept Intent.ACTION_SEND intents ("android.intent.action.SEND") and optionally accept Intent.ACTION_SEND_MULTIPLE ("android.intent.action.SEND_MULTIPLE") if the activity is equipped to handle multiple data streams.

Summary

Public methods

static ShareCompat.IntentReader from(Activity activity)

Get an IntentReader for parsing and interpreting the sharing intent used to start the given activity.

ComponentName getCallingActivity()

Get the ComponentName of the Activity that invoked this sharing intent.

Drawable getCallingActivityIcon()

Get the icon of the calling activity as a Drawable if data about the calling activity is available.

Drawable getCallingApplicationIcon()

Get the icon of the calling application as a Drawable if data about the calling package is available.

CharSequence getCallingApplicationLabel()

Get the human-readable label (title) of the calling application if data about the calling package is available.

String getCallingPackage()

Get the name of the package that invoked this sharing intent.

String[] getEmailBcc()

Get an array of Strings, each an email address to BCC on this share.

String[] getEmailCc()

Get an array of Strings, each an email address to CC on this share.

String[] getEmailTo()

Get an array of Strings, each an email address to share to.

String getHtmlText()

Get the styled HTML text shared with the target activity.

Uri getStream(int index)

Get the URI of a stream item shared with the target activity.

Uri getStream()

Get a URI referring to a data stream shared with the target activity.

int getStreamCount()

Return the number of stream items shared.

String getSubject()

Get a subject heading for this share; useful when sharing via email.

CharSequence getText()

Get the literal text shared with the target activity.

String getType()

Get the mimetype of the data shared to this activity.

boolean isMultipleShare()

Returns true if the activity this reader was obtained for was started with an Intent.ACTION_SEND_MULTIPLE intent.

boolean isShareIntent()

Returns true if the activity this reader was obtained for was started with an Intent.ACTION_SEND or Intent.ACTION_SEND_MULTIPLE sharing Intent.

boolean isSingleShare()

Returns true if the activity this reader was obtained for was started with an Intent.ACTION_SEND intent and contains a single shared item.

Inherited methods

Public methods

from

added in version 1.0.0
public static ShareCompat.IntentReader from (Activity activity)

Get an IntentReader for parsing and interpreting the sharing intent used to start the given activity.

Parameters
activity Activity: Activity that was started to share content

Returns
ShareCompat.IntentReader IntentReader for parsing sharing data

getCallingActivity

added in version 1.0.0
public ComponentName getCallingActivity ()

Get the ComponentName of the Activity that invoked this sharing intent. If the target sharing activity was not started for a result, IntentBuilder will read this from extra metadata placed in the intent by ShareBuilder.

Note: This data may have been provided voluntarily by the calling application. As such it should not be trusted for accuracy in the context of security or verification.

Returns
ComponentName ComponentName of the calling Activity or null if unknown

getCallingActivityIcon

added in version 1.0.0
public Drawable getCallingActivityIcon ()

Get the icon of the calling activity as a Drawable if data about the calling activity is available.

Note: This data may have been provided voluntarily by the calling application. As such it should not be trusted for accuracy in the context of security or verification.

Returns
Drawable The calling Activity's icon or null if unknown

getCallingApplicationIcon

added in version 1.0.0
public Drawable getCallingApplicationIcon ()

Get the icon of the calling application as a Drawable if data about the calling package is available.

Note: This data may have been provided voluntarily by the calling application. As such it should not be trusted for accuracy in the context of security or verification.

Returns
Drawable The calling application's icon or null if unknown

getCallingApplicationLabel

added in version 1.0.0
public CharSequence getCallingApplicationLabel ()

Get the human-readable label (title) of the calling application if data about the calling package is available.

Note: This data may have been provided voluntarily by the calling application. As such it should not be trusted for accuracy in the context of security or verification.

Returns
CharSequence The calling application's label or null if unknown

getCallingPackage

added in version 1.0.0
public String getCallingPackage ()

Get the name of the package that invoked this sharing intent. If the activity was not started for a result, IntentBuilder will read this from extra metadata placed in the Intent by ShareBuilder.

Note: This data may have been provided voluntarily by the calling application. As such it should not be trusted for accuracy in the context of security or verification.

Returns
String Name of the package that started this activity or null if unknown

getEmailBcc

added in version 1.0.0
public String[] getEmailBcc ()

Get an array of Strings, each an email address to BCC on this share.

Returns
String[] An array of email addresses or null if none were supplied.

See also:

getEmailCc

added in version 1.0.0
public String[] getEmailCc ()

Get an array of Strings, each an email address to CC on this share.

Returns
String[] An array of email addresses or null if none were supplied.

See also:

getEmailTo

added in version 1.0.0
public String[] getEmailTo ()

Get an array of Strings, each an email address to share to.

Returns
String[] An array of email addresses or null if none were supplied.

See also:

getHtmlText

added in version 1.0.0
public String getHtmlText ()

Get the styled HTML text shared with the target activity. If no HTML text was supplied but Intent.EXTRA_TEXT contained styled text, it will be converted to HTML if possible and returned. If the text provided by Intent.EXTRA_TEXT was not styled text, it will be escaped by Html.escapeHtml(CharSequence) and returned. If no text was provided at all, this method will return null.

Returns
String Styled text provided by the sender as HTML.

getStream

added in version 1.0.0
public Uri getStream (int index)

Get the URI of a stream item shared with the target activity. Index should be in the range [0-getStreamCount()).

Parameters
index int: Index of text item to retrieve

Returns
Uri Requested stream item URI

getStream

added in version 1.0.0
public Uri getStream ()

Get a URI referring to a data stream shared with the target activity.

This call will fail if the share intent contains multiple stream items. If isMultipleShare() returns true the application should use getStream(int) and getStreamCount() to retrieve the included stream items.

Returns
Uri A URI referring to a data stream to be shared or null if one was not supplied

getStreamCount

added in version 1.0.0
public int getStreamCount ()

Return the number of stream items shared. The return value will be 0 or 1 if this was an Intent.ACTION_SEND intent, or 0 or more if it was an Intent.ACTION_SEND_MULTIPLE intent.

Returns
int Count of text items contained within the Intent

getSubject

added in version 1.0.0
public String getSubject ()

Get a subject heading for this share; useful when sharing via email.

Returns
String The subject heading for this share or null if one was not supplied.

getText

added in version 1.0.0
public CharSequence getText ()

Get the literal text shared with the target activity.

Returns
CharSequence Literal shared text or null if none was supplied

See also:

getType

added in version 1.0.0
public String getType ()

Get the mimetype of the data shared to this activity.

Returns
String mimetype of the shared data

See also:

isMultipleShare

added in version 1.0.0
public boolean isMultipleShare ()

Returns true if the activity this reader was obtained for was started with an Intent.ACTION_SEND_MULTIPLE intent. The Intent may contain more than one stream item.

Returns
boolean true if the activity was started with an ACTION_SEND_MULTIPLE intent

isShareIntent

added in version 1.0.0
public boolean isShareIntent ()

Returns true if the activity this reader was obtained for was started with an Intent.ACTION_SEND or Intent.ACTION_SEND_MULTIPLE sharing Intent.

Returns
boolean true if the activity was started with an ACTION_SEND or ACTION_SEND_MULTIPLE Intent

isSingleShare

added in version 1.0.0
public boolean isSingleShare ()

Returns true if the activity this reader was obtained for was started with an Intent.ACTION_SEND intent and contains a single shared item. The shared content should be obtained using either the getText() or getStream() methods depending on the type of content shared.

Returns
boolean true if the activity was started with an ACTION_SEND intent