RemoveByDocumentIdRequest

Kotlin |Java

class RemoveByDocumentIdRequest : Parcelable

kotlin.Any
↳	android.app.appsearch.RemoveByDocumentIdRequest

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

Summary

Nested classes
	`Builder` Builder for `RemoveByDocumentIdRequest` objects.

Inherited constants

From class Parcelable

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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
MutableSet<String!>	`getIds()` Returns the set of document IDs attached to the request.
String	`getNamespace()` Returns the namespace to remove documents from.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<RemoveByDocumentIdRequest!>	`CREATOR` Creator class for `android.app.appsearch.RemoveByDocumentIdRequest`.

Public methods

describeContents

Added in API level 35

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getIds

Added in API level 31

fun getIds(): MutableSet<String!>

Returns the set of document IDs attached to the request.

Return
`MutableSet<String!>`	This value cannot be `null`.

getNamespace

Added in API level 31

fun getNamespace(): String

Returns the namespace to remove documents from.

Return
`String`	This value cannot be `null`.

writeToParcel

Added in API level 35

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 35
Also in T Extensions 13

static val CREATOR: Parcelable.Creator<RemoveByDocumentIdRequest!>

Creator class for android.app.appsearch.RemoveByDocumentIdRequest.