IntentReader

class IntentReader
kotlin.Any
   ↳ 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

open static ShareCompat.IntentReader
from(@NonNull activity: Activity)

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

open ComponentName?

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

open Drawable?

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

open Drawable?

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

open CharSequence?

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

open String?

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

open Array<String!>?

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

open Array<String!>?

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

open Array<String!>?

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

open String?

Get the styled HTML text shared with the target activity.

open Uri?

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

open Uri?
getStream(index: Int)

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

open Int

Return the number of stream items shared.

open String?

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

open CharSequence?

Get the literal text shared with the target activity.

open String?

Get the mimetype of the data shared to this activity.

open Boolean

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

open Boolean

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

open Boolean

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

Public methods

from

@NonNull open static fun from(@NonNull activity: Activity): ShareCompat.IntentReader

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
Return
ShareCompat.IntentReader: IntentReader for parsing sharing data

getCallingActivity

@Nullable open fun getCallingActivity(): ComponentName?

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.

Return
ComponentName?: ComponentName of the calling Activity or null if unknown

getCallingActivityIcon

@Nullable open fun getCallingActivityIcon(): Drawable?

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.

Return
Drawable?: The calling Activity's icon or null if unknown

getCallingApplicationIcon

@Nullable open fun getCallingApplicationIcon(): Drawable?

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.

Return
Drawable?: The calling application's icon or null if unknown

getCallingApplicationLabel

@Nullable open fun getCallingApplicationLabel(): CharSequence?

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.

Return
CharSequence?: The calling application's label or null if unknown

getCallingPackage

@Nullable open fun getCallingPackage(): String?

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.

Return
String?: Name of the package that started this activity or null if unknown

getEmailBcc

@Nullable open fun getEmailBcc(): Array<String!>?

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

Return
Array<String!>?: An array of email addresses or null if none were supplied.

See Also

getEmailCc

@Nullable open fun getEmailCc(): Array<String!>?

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

Return
Array<String!>?: An array of email addresses or null if none were supplied.

See Also

getEmailTo

@Nullable open fun getEmailTo(): Array<String!>?

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

Return
Array<String!>?: An array of email addresses or null if none were supplied.

getHtmlText

@Nullable open fun getHtmlText(): String?

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 android.text.Html#escapeHtml(CharSequence) and returned. If no text was provided at all, this method will return null.

Return
String?: Styled text provided by the sender as HTML.

getStream

@Nullable open fun getStream(): Uri?

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.

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

getStream

@Nullable open fun getStream(index: Int): Uri?

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
Return
Uri?: Requested stream item URI

getStreamCount

open fun getStreamCount(): Int

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.

Return
Int: Count of text items contained within the Intent

getSubject

@Nullable open fun getSubject(): String?

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

Return
String?: The subject heading for this share or null if one was not supplied.

getText

@Nullable open fun getText(): CharSequence?

Get the literal text shared with the target activity.

Return
CharSequence?: Literal shared text or null if none was supplied

getType

@Nullable open fun getType(): String?

Get the mimetype of the data shared to this activity.

Return
String?: mimetype of the shared data

See Also

isMultipleShare

open fun isMultipleShare(): Boolean

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.

Return
Boolean: true if the activity was started with an ACTION_SEND_MULTIPLE intent

isShareIntent

open fun isShareIntent(): Boolean

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

Return
Boolean: true if the activity was started with an ACTION_SEND or ACTION_SEND_MULTIPLE Intent

isSingleShare

open fun isSingleShare(): Boolean

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.

Return
Boolean: true if the activity was started with an ACTION_SEND intent