MetadataChangeSet.Builder

A builder for creating a new MetadataChangeSet.

Public Constructor Summary

Public Method Summary

MetadataChangeSet	build()
MetadataChangeSet.Builder	deleteCustomProperty(CustomPropertyKey key) Deletes the given custom property of the resource.
MetadataChangeSet.Builder	setCustomProperty(CustomPropertyKey key, String value) Sets a Custom File Property for the resource.
MetadataChangeSet.Builder	setDescription(String description) Sets the description for the resource.
MetadataChangeSet.Builder	setIndexableText(String text) Sets the text to be indexed for the resource.
MetadataChangeSet.Builder	setLastViewedByMeDate(Date date) Sets the date when the user most recently viewed the resource.
MetadataChangeSet.Builder	setMimeType(String mimeType) Sets a MIME type for the resource.
MetadataChangeSet.Builder	setPinned(boolean pinned) If true, the file's contents will be kept up to date locally and thus the contents will be available when the device is offline.
MetadataChangeSet.Builder	setStarred(boolean starred) Sets whether the resource will be starred.
MetadataChangeSet.Builder	setTitle(String title) Sets the title for the resource.
MetadataChangeSet.Builder	setViewed(boolean viewed) This method is deprecated. Use `setViewed()` instead.
MetadataChangeSet.Builder	setViewed() Sets the resource to viewed.

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()

Public Constructors

public MetadataChangeSet.Builder ()

Public Methods

public MetadataChangeSet build ()

public MetadataChangeSet.Builder deleteCustomProperty (CustomPropertyKey key)

Deletes the given custom property of the resource.

Note that the user must have edit access to delete a custom property (see isEditable()).

public MetadataChangeSet.Builder setCustomProperty (CustomPropertyKey key, String value)

Sets a Custom File Property for the resource. The provided value may not be null.

Note that the total size of the key string and the value string of a custom property should not exceed CUSTOM_PROPERTY_SIZE_LIMIT_BYTES bytes in UTF-8 encoding. As the default charset on Android is UTF-8, the byte length of a string in UTF-8 encoding can be calculated simply by using stringObject.getBytes().length (See //developer.android.com/reference/java/lang/String.html#getBytes()) Also, note that there are limits on the number of custom properties a resource can have. See MAX_PUBLIC_PROPERTIES_PER_RESOURCE, MAX_PRIVATE_PROPERTIES_PER_RESOURCE_PER_APP and MAX_TOTAL_PROPERTIES_PER_RESOURCE for details. If these limits are exceeded, the operation to apply this metadata change will fail.

Note that the user must have edit access to set a custom property (see isEditable()).

public MetadataChangeSet.Builder setDescription (String description)

Sets the description for the resource.

Note that the user must have edit access to set the description (see isEditable()).

public MetadataChangeSet.Builder setIndexableText (String text)

Sets the text to be indexed for the resource.

Note that the user must have edit access to set the indexable text (see isEditable()).

public MetadataChangeSet.Builder setLastViewedByMeDate (Date date)

Sets the date when the user most recently viewed the resource.

public MetadataChangeSet.Builder setMimeType (String mimeType)

Sets a MIME type for the resource.

Note that the user must have edit access to set the MIME type (see isEditable()).

public MetadataChangeSet.Builder setPinned (boolean pinned)

If true, the file's contents will be kept up to date locally and thus the contents will be available when the device is offline. Pinning a file uses bandwidth and storage space, so it should only be done in response to an explicit user request.

Note that only files where isPinnable() is true can be pinned.

public MetadataChangeSet.Builder setStarred (boolean starred)

Sets whether the resource will be starred.

public MetadataChangeSet.Builder setTitle (String title)

Sets the title for the resource.

Note that the user must have edit access to set the title (see isEditable()).

public MetadataChangeSet.Builder setViewed (boolean viewed)

This method is deprecated.
Use setViewed() instead.

Sets the resource to viewed.

Note that setting viewed to false after it has been set to true is not allowed.

public MetadataChangeSet.Builder setViewed ()

Sets the resource to viewed.