ClearRegistryRequest.ClearTypedRegistryOption

public final class ClearRegistryRequest.ClearTypedRegistryOption implements Parcelable


A request to configure how to clear the registries for a given type.

The order of the conditions are important. If deleteAllForType is true, then the other conditions are ignored and all the registries for the given type are deleted. Otherwise, if deleteIdlessRegistry is true, then the registry with an empty ID is deleted; at the same time, the registries with the IDs provided in registryIds will also be deleted.

Summary

Public constructors

ClearTypedRegistryOption(
    boolean deleteAllForType,
    @NonNull String type,
    boolean deleteIdlessRegistry,
    @NonNull List<@NonNull String> registryIds
)

constructs an instance of ClearTypedRegistryOption

Public methods

final int
final boolean

whether to delete all registries for the given type

final boolean

whether to delete the registry for the given type that was registered without an ID provided; in other words, the registry that was registered without providing RegistrationRequest.id

final @NonNull List<@NonNull String>

the IDs of the registries for the given type to delete

final @NonNull String

the type of registry to clear, matching the RegistrationRequest.type provided during registration

void
writeToParcel(@NonNull Parcel dest, int flags)

Public constructors

ClearTypedRegistryOption

public ClearTypedRegistryOption(
    boolean deleteAllForType,
    @NonNull String type,
    boolean deleteIdlessRegistry,
    @NonNull List<@NonNull String> registryIds
)

constructs an instance of ClearTypedRegistryOption

Parameters
boolean deleteAllForType

whether to delete all registries for the given type

@NonNull String type

the type of registry to clear, matching the RegistrationRequest.type provided during registration

boolean deleteIdlessRegistry

whether to delete the registry for the given type that was registered without an ID provided; in other words, the registry that was registered without providing RegistrationRequest.id

@NonNull List<@NonNull String> registryIds

the IDs of the registries for the given type to delete

Public methods

describeContents

public final int describeContents()

getDeleteAllForType

public final boolean getDeleteAllForType()

whether to delete all registries for the given type

getDeleteIdlessRegistry

public final boolean getDeleteIdlessRegistry()

whether to delete the registry for the given type that was registered without an ID provided; in other words, the registry that was registered without providing RegistrationRequest.id

getRegistryIds

public final @NonNull List<@NonNull StringgetRegistryIds()

the IDs of the registries for the given type to delete

getType

public final @NonNull String getType()

the type of registry to clear, matching the RegistrationRequest.type provided during registration

writeToParcel

public void writeToParcel(@NonNull Parcel dest, int flags)