PutDataRequest

AI-generated Key Takeaways

• PutDataRequest is used to create new data items in the Android Wear network.

• The class includes constants like WEAR_URI_SCHEME and methods to create, get, add, remove, and set data or assets on a data item.

• It also provides methods to manage the urgency of data item transport and is Parcelable for efficient data transfer.

public class PutDataRequest extends Object
implements Parcelable

PutDataRequest is used to create new data items in the Android Wear network.

Constant Summary

String

WEAR_URI_SCHEME

URI scheme to use for Wear URIs.

Inherited Constant Summary

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Field Summary

public static final Creator<PutDataRequest>

CREATOR

Public Method Summary

static PutDataRequest	create(String path) Creates a PutDataRequest with the provided, complete, path.
static PutDataRequest	createFromDataItem(DataItem source) Creates a PutDataRequest from an existing DataItem using the provided source.
static PutDataRequest	createWithAutoAppendedId(String pathPrefix) Creates a PutDataRequest with a randomly generated id prefixed with the provided path.
Asset	getAsset(String key) Returns an Asset previously added with putAsset(String, Asset).
Map<String, Asset>	getAssets() Returns unmodifiable map of Assets on this DataItem.
byte[]	getData() An array of data stored at the specified Uri.
Uri	getUri() Returns a Uri for the pending data item.
boolean	hasAsset(String key) Returns true if the asset exists in this data item.
boolean	isUrgent() Whether the DataItem for this request is urgent.
PutDataRequest	putAsset(String key, Asset value) Adds an Asset to the data item.
PutDataRequest	removeAsset(String key) Removes a previously added Asset.
PutDataRequest	setData(byte[] data) Sets the data in a data item.
PutDataRequest	setUrgent() Flags this DataItem for urgent transport.
String	toString()
String	toString(boolean verbose)
void	writeToParcel(Parcel dest, int flags)

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Constants

public static final String WEAR_URI_SCHEME

URI scheme to use for Wear URIs. See DataApi for details of the Wear URI format.

Constant Value: "wear"

Fields

public static final Creator<PutDataRequest> CREATOR

Public Methods

public static PutDataRequest create (String path)

Creates a PutDataRequest with the provided, complete, path.

public static PutDataRequest createFromDataItem (DataItem source)

Creates a PutDataRequest from an existing DataItem using the provided source.

public static PutDataRequest createWithAutoAppendedId (String pathPrefix)

Creates a PutDataRequest with a randomly generated id prefixed with the provided path.

public Asset getAsset (String key)

Returns an Asset previously added with putAsset(String, Asset).

public Map<String, Asset> getAssets ()

Returns unmodifiable map of Assets on this DataItem.

public byte[] getData ()

An array of data stored at the specified Uri. PutDataMapRequest may be used to store structured data in the network.

public Uri getUri ()

Returns a Uri for the pending data item. If this is a modification of an existing data item, Uri.getHost() will return the id of the node that originally created it. Otherwise, a new data item will be created with the requesting device's node.

public boolean hasAsset (String key)

Returns true if the asset exists in this data item.

public boolean isUrgent ()

Whether the DataItem for this request is urgent.

Returns

• true if the DataItem for this request is urgent

public PutDataRequest putAsset (String key, Asset value)

Adds an Asset to the data item.

public PutDataRequest removeAsset (String key)

Removes a previously added Asset.

public PutDataRequest setData (byte[] data)

Sets the data in a data item.

Note: Use an empty array if there is no data to store. null is only allowed for backwards compatibility.

public PutDataRequest setUrgent ()

Flags this DataItem for urgent transport. Updates to DataItems with the same path will be applied in the order they are received. A subsequent urgent update will remove the delay for pending updates. A subsequent delayed update will not delay pending urgent updates.

Non-urgent DataItems will be delayed no longer than 30 minutes, subject to a connected peer, but are expected to arrive much sooner.

Clients should only setUrgent() for DataItems which need to be delivered right away.

public String toString ()

public String toString (boolean verbose)

public void writeToParcel (Parcel dest, int flags)