java.lang.Object | |
↳ | android.support.v4.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 ACTION_SEND
intents ("android.intent.action.SEND") and optionally
accept ACTION_SEND_MULTIPLE
("android.intent.action.SEND_MULTIPLE") if
the activity is equipped to handle multiple data streams.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Get an IntentReader for parsing and interpreting the sharing intent
used to start the given activity.
| |||||||||||
Get the
ComponentName of the Activity that invoked this sharing intent. | |||||||||||
Get the icon of the calling activity as a Drawable if data about
the calling activity is available.
| |||||||||||
Get the icon of the calling application as a Drawable if data
about the calling package is available.
| |||||||||||
Get the human-readable label (title) of the calling application if
data about the calling package is available.
| |||||||||||
Get the name of the package that invoked this sharing intent.
| |||||||||||
Get an array of Strings, each an email address to BCC on this share.
| |||||||||||
Get an array of Strings, each an email address to CC on this share.
| |||||||||||
Get an array of Strings, each an email address to share to.
| |||||||||||
Get the styled HTML text shared with the target activity.
| |||||||||||
Get the URI of a stream item shared with the target activity.
| |||||||||||
Get a URI referring to a data stream shared with the target activity.
| |||||||||||
Return the number of stream items shared.
| |||||||||||
Get a subject heading for this share; useful when sharing via email.
| |||||||||||
Get the literal text shared with the target activity.
| |||||||||||
Get the mimetype of the data shared to this activity.
| |||||||||||
Returns true if the activity this reader was obtained for was started with an
ACTION_SEND_MULTIPLE intent. | |||||||||||
Returns true if the activity this reader was obtained for was
started with an
ACTION_SEND or ACTION_SEND_MULTIPLE
sharing Intent. | |||||||||||
Returns true if the activity this reader was obtained for was started with an
ACTION_SEND intent and contains a single shared item. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Get an IntentReader for parsing and interpreting the sharing intent used to start the given activity.
activity | Activity that was started to share content |
---|
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.
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.
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.
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.
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.
Get an array of Strings, each an email address to BCC on this share.
Get an array of Strings, each an email address to CC on this share.
Get an array of Strings, each an email address to share to.
Get the styled HTML text shared with the target activity.
If no HTML text was supplied but EXTRA_TEXT
contained
styled text, it will be converted to HTML if possible and returned.
If the text provided by EXTRA_TEXT
was not styled text,
it will be escaped by escapeHtml(CharSequence)
and returned. If no text was provided at all, this method will return null.
Get the URI of a stream item shared with the target activity. Index should be in the range [0-getStreamCount()).
index | Index of text item to retrieve |
---|
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 the number of stream items shared. The return value will be 0 or 1 if
this was an ACTION_SEND
intent, or 0 or more if it was an
ACTION_SEND_MULTIPLE
intent.
Get a subject heading for this share; useful when sharing via email.
Get the literal text shared with the target activity.
Get the mimetype of the data shared to this activity.
Returns true if the activity this reader was obtained for was started with an
ACTION_SEND_MULTIPLE
intent. The Intent may contain more than
one stream item.
Returns true if the activity this reader was obtained for was
started with an ACTION_SEND
or ACTION_SEND_MULTIPLE
sharing Intent.
Returns true if the activity this reader was obtained for was started with an
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.