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

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

Fields

CREATOR

Added in API level 35
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