ShareTarget

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

Defines a form field for sharing files.

Contains parameter names to be used for the data being shared.

Constants
const 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].
const 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].
const String!
KEY_ACTION = "androidx.browser.trusted.sharing.KEY_ACTION"

Bundle key for action.
const String!
KEY_ENCTYPE = "androidx.browser.trusted.sharing.KEY_ENCTYPE"

Bundle key for encodingType.
const String!
KEY_METHOD = "androidx.browser.trusted.sharing.KEY_METHOD"

Bundle key for method.
const String!
KEY_PARAMS = "androidx.browser.trusted.sharing.KEY_PARAMS"

Bundle key for params.
const String!
METHOD_GET = "GET"

See method.
const String!
METHOD_POST = "POST"

See method.

Public constructors
ShareTarget(
    action: String,
    method: String?,
    encodingType: String?,
    params: ShareTarget.Params
)

Creates a ShareTarget with the given parameters.

Public functions
java-static ShareTarget?
fromBundle(bundle: Bundle)

Unpacks the object from a Bundle.
Bundle

Packs the object into a Bundle.

Public properties
String

URL of the Web Share Target.
String?

Specifies how the shared data should be encoded in the body of a POST request.
String?

HTTP request method for the Web Share Target.
ShareTarget.Params

Contains the parameter names, see Params.

Constants

ENCODING_TYPE_MULTIPART

Added in 1.2.0
const val ENCODING_TYPE_MULTIPART = "multipart/form-data": String!

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

Added in 1.2.0
const val ENCODING_TYPE_URL_ENCODED = "application/x-www-form-urlencoded": String!

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

Added in 1.2.0
const val KEY_ACTION = "androidx.browser.trusted.sharing.KEY_ACTION": String!

Bundle key for action.

KEY_ENCTYPE

Added in 1.2.0
const val KEY_ENCTYPE = "androidx.browser.trusted.sharing.KEY_ENCTYPE": String!

Bundle key for encodingType.

KEY_METHOD

Added in 1.2.0
const val KEY_METHOD = "androidx.browser.trusted.sharing.KEY_METHOD": String!

Bundle key for method.

KEY_PARAMS

Added in 1.2.0
const val KEY_PARAMS = "androidx.browser.trusted.sharing.KEY_PARAMS": String!

Bundle key for params.

METHOD_GET

Added in 1.2.0
const val METHOD_GET = "GET": String!

See method.

METHOD_POST

Added in 1.2.0
const val METHOD_POST = "POST": String!

See method.

Public constructors

ShareTarget

Added in 1.2.0
ShareTarget(
    action: String,
    method: String?,
    encodingType: String?,
    params: ShareTarget.Params
)

Creates a ShareTarget with the given parameters.

Parameters
action: String

The action.
method: String?

The method.
encodingType: String?

The encodingType.
params: ShareTarget.Params

The params.

Public functions

fromBundle

Added in 1.2.0
java-static fun fromBundle(bundle: Bundle): ShareTarget?

Unpacks the object from a Bundle.

toBundle

Added in 1.2.0
fun toBundle(): Bundle

Packs the object into a Bundle.

Public properties

action

Added in 1.2.0
val action: String

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

Added in 1.2.0
val encodingType: String?

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

Added in 1.2.0
val method: String?

HTTP request method for the Web Share Target. Must be METHOD_GET or METHOD_POST. Default is METHOD_GET.

params

Added in 1.2.0
val params: ShareTarget.Params

Contains the parameter names, see Params.