ShareTarget
public final class ShareTarget
Describes a Web Share Target associated with a Trusted Web Activity. The structure of a ShareTarget object follows the specification [1] of the "share_target" object within web manifest json, with the following exceptions: - The "action" field specifies the full URL of the Share Target, and not only the path. - There is no "url" field in the "params" object, since urls are not supplied separately from text in Android's ACTION_SEND and ACTION_SEND_MULTIPLE intents. [1] https://wicg.github.io/web-share-target/level-2/
Summary
Nested types |
|---|
public final class ShareTarget.FileFormFieldDefines a form field for sharing files. |
public class ShareTarget.ParamsContains parameter names to be used for the data being shared. |
Constants |
|
|---|---|
static final String |
ENCODING_TYPE_MULTIPART = "multipart/form-data"An encoding type to be used with POST requests (see |
static final String |
ENCODING_TYPE_URL_ENCODED = "application/x-www-form-urlencoded"An encoding type to be used with POST requests (see |
static final String |
KEY_ACTION = "androidx.browser.trusted.sharing.KEY_ACTION"Bundle key for |
static final String |
KEY_ENCTYPE = "androidx.browser.trusted.sharing.KEY_ENCTYPE"Bundle key for |
static final String |
KEY_METHOD = "androidx.browser.trusted.sharing.KEY_METHOD"Bundle key for |
static final String |
KEY_PARAMS = "androidx.browser.trusted.sharing.KEY_PARAMS"Bundle key for |
static final String |
METHOD_GET = "GET"See |
static final String |
METHOD_POST = "POST"See |
Public fields |
|
|---|---|
final @NonNull String |
URL of the Web Share Target. |
final @Nullable String |
Specifies how the shared data should be encoded in the body of a POST request. |
final @Nullable String |
HTTP request method for the Web Share Target. |
final @NonNull ShareTarget.Params |
Contains the parameter names, see |
Public constructors |
|---|
ShareTarget(Creates a |
Public methods |
|
|---|---|
static @Nullable ShareTarget |
fromBundle(@NonNull Bundle bundle)Unpacks the object from a |
@NonNull Bundle |
toBundle()Packs the object into a |
Constants
ENCODING_TYPE_MULTIPART
public static final String ENCODING_TYPE_MULTIPART = "multipart/form-data"
An encoding type to be used with POST requests (see encodingType) corresponding to multipart/form-data of the HTTP POST standard [1].
ENCODING_TYPE_URL_ENCODED
public static final String ENCODING_TYPE_URL_ENCODED = "application/x-www-form-urlencoded"
An encoding type to be used with POST requests (see encodingType) corresponding to application/x-www-form-urlencoded of the HTTP POST standard [1]. [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
KEY_ACTION
public static final String KEY_ACTION = "androidx.browser.trusted.sharing.KEY_ACTION"
Bundle key for action.
KEY_ENCTYPE
public static final String KEY_ENCTYPE = "androidx.browser.trusted.sharing.KEY_ENCTYPE"
Bundle key for encodingType.
KEY_METHOD
public static final String KEY_METHOD = "androidx.browser.trusted.sharing.KEY_METHOD"
Bundle key for method.
KEY_PARAMS
public static final String KEY_PARAMS = "androidx.browser.trusted.sharing.KEY_PARAMS"
Bundle key for params.
Public fields
action
public final @NonNull String action
URL of the Web Share Target. Must belong to an origin associated with the Trusted Web Activity. For example, assuming the origin is "https://mypwa.com", the action could be "https://mypwa.com/share.html".
encodingType
public final @Nullable String encodingType
Specifies how the shared data should be encoded in the body of a POST request. Must be ENCODING_TYPE_MULTIPART or ENCODING_TYPE_URL_ENCODED. Default is ENCODING_TYPE_URL_ENCODED.
method
public final @Nullable String method
HTTP request method for the Web Share Target. Must be METHOD_GET or METHOD_POST. Default is METHOD_GET.
params
public final @NonNull ShareTarget.Params params
Contains the parameter names, see Params.
Public constructors
ShareTarget
public ShareTarget(
@NonNull String action,
@Nullable String method,
@Nullable String encodingType,
@NonNull ShareTarget.Params params
)
Creates a ShareTarget with the given parameters.
Public methods
fromBundle
public static @Nullable ShareTarget fromBundle(@NonNull Bundle bundle)
Unpacks the object from a Bundle.