RemoveByDocumentIdRequest


public final class RemoveByDocumentIdRequest
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.appsearch.RemoveByDocumentIdRequest


Encapsulates a request to remove documents by namespace and IDs from the AppSearchSession database.

Summary

Nested classes

class RemoveByDocumentIdRequest.Builder

Builder for RemoveByDocumentIdRequest objects. 

Inherited constants

int CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

int PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields

public static final Creator<RemoveByDocumentIdRequest> CREATOR

Creator class for RemoveByDocumentIdRequest.

Public methods

Set<String> getIds()

Returns the set of document IDs attached to the request.

String getNamespace()

Returns the namespace to remove documents from.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

abstract void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 35
Also in T Extensions 13
public static final Creator<RemoveByDocumentIdRequest> CREATOR

Creator class for RemoveByDocumentIdRequest.

Public methods

getIds

Added in API level 31
public Set<String> getIds ()

Returns the set of document IDs attached to the request.

Returns
Set<String> This value cannot be null.

getNamespace

Added in API level 31
public String getNamespace ()

Returns the namespace to remove documents from.

Returns
String This value cannot be null.

writeToParcel

Added in API level 35
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES