SetSchemaRequest.Builder

public Builder()

Creates a new SetSchemaRequest.Builder.

@ExperimentalAppSearchApi
public Builder(@NonNull SetSchemaRequest request)

Creates a SetSchemaRequest.Builder from the given SetSchemaRequest.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SET_SCHEMA_REQUEST_ADD_SCHEMA_TYPE_VISIBLE_TO_CONFIG)
public @NonNull SetSchemaRequest.Builder addDocumentClassVisibleToConfig(
    @NonNull Class<@NonNull ?> documentClass,
    @NonNull SchemaVisibilityConfig schemaVisibilityConfig
)

Sets the documents from the provided schemaType can be read by the caller if they match the ALL visibility requirements set in SchemaVisibilityConfig.

The requirements in a SchemaVisibilityConfig is "AND" relationship. A caller must match ALL requirements to access the schema. For example, a caller must hold required permissions AND it is a specified package.

You can call this method repeatedly to add multiple SchemaVisibilityConfigs, and the querier will have access if they match ANY of the SchemaVisibilityConfig.

public @NonNull SetSchemaRequest.Builder addDocumentClasses(@NonNull Class[] documentClasses)

Adds one or more androidx.appsearch.annotation.Document annotated classes to the schema.

Merged list available from getSchemas.

public @NonNull SetSchemaRequest.Builder addDocumentClasses(@NonNull Collection<Class<@NonNull ?>> documentClasses)

Adds a collection of androidx.appsearch.annotation.Document annotated classes to the schema.

This will also add all androidx.appsearch.annotation.Document classes referenced by the schema via document properties.

Merged list available from getSchemas.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
public @NonNull SetSchemaRequest.Builder addRequiredPermissionsForDocumentClassVisibility(
    @NonNull Class<@NonNull ?> documentClass,
    @NonNull Set<Integer> permissions
)

Adds a set of required Android android.Manifest.permission combination to the given schema type.

If the querier holds ALL of the required permissions in this combination, they will have access to read GenericDocument objects of the given schema type.

You can call this method to add multiple permission combinations, and the querier will have access if they holds ANY of the combinations.

The supported Permissions are READ_SMS, READ_CALENDAR, READ_CONTACTS, READ_EXTERNAL_STORAGE, READ_HOME_APP_SEARCH_DATA and READ_ASSISTANT_APP_SEARCH_DATA.

The relationship between visible packages added in this method and permission visibility setting addRequiredPermissionsForSchemaTypeVisibility is "OR". The caller could access the schema if they match ANY requirements. If you want to set "AND" requirements like a caller must hold required permissions AND it is a specified package, please use addSchemaTypeVisibleToConfig.

Merged map available from getRequiredPermissionsForSchemaTypeVisibility.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
public @NonNull SetSchemaRequest.Builder addRequiredPermissionsForSchemaTypeVisibility(
    @NonNull String schemaType,
    @NonNull Set<Integer> permissions
)

Adds a set of required Android android.Manifest.permission combination to the given schema type.

If the querier holds ALL of the required permissions in this combination, they will have access to read GenericDocument objects of the given schema type.

You can call this method to add multiple permission combinations, and the querier will have access if they holds ANY of the combinations.

The supported Permissions are READ_SMS, READ_CALENDAR, READ_CONTACTS, READ_EXTERNAL_STORAGE, READ_HOME_APP_SEARCH_DATA and READ_ASSISTANT_APP_SEARCH_DATA.

The relationship between permissions added in this method and package visibility setting setSchemaTypeVisibilityForPackage is "OR". The caller could access the schema if they match ANY requirements. If you want to set "AND" requirements like a caller must hold required permissions AND it is a specified package, please use addSchemaTypeVisibleToConfig.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SET_SCHEMA_REQUEST_ADD_SCHEMA_TYPE_VISIBLE_TO_CONFIG)
public @NonNull SetSchemaRequest.Builder addSchemaTypeVisibleToConfig(
    @NonNull String schemaType,
    @NonNull SchemaVisibilityConfig schemaVisibilityConfig
)

Sets the documents from the provided schemaType can be read by the caller if they match the ALL visibility requirements set in SchemaVisibilityConfig.

The requirements in a SchemaVisibilityConfig is "AND" relationship. A caller must match ALL requirements to access the schema. For example, a caller must hold required permissions AND it is a specified package.

You can call this method repeatedly to add multiple SchemaVisibilityConfigs, and the querier will have access if they match ANY of the SchemaVisibilityConfig.

public @NonNull SetSchemaRequest.Builder addSchemas(@NonNull AppSearchSchema[] schemas)

Adds one or more AppSearchSchema types to the schema.

An AppSearchSchema object represents one type of structured data.

Any documents of these types will be displayed on system UI surfaces by default.

public @NonNull SetSchemaRequest.Builder addSchemas(@NonNull Collection<AppSearchSchema> schemas)

Adds a collection of AppSearchSchema objects to the schema.

An AppSearchSchema object represents one type of structured data.

public @NonNull SetSchemaRequest build()

Builds a new SetSchemaRequest object.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SET_SCHEMA_REQUEST_ADD_SCHEMA_TYPE_VISIBLE_TO_CONFIG)
public @NonNull SetSchemaRequest.Builder clearDocumentClassVisibleToConfigs(
    @NonNull Class<@NonNull ?> documentClass
)

Clears all visible to SchemaVisibilityConfig for the given schema type.

@ExperimentalAppSearchApi
public @NonNull SetSchemaRequest.Builder clearMigrators()

Clears all Migrators.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
public @NonNull SetSchemaRequest.Builder clearRequiredPermissionsForDocumentClassVisibility(
    @NonNull Class<@NonNull ?> documentClass
)

Clears all required permissions combinations for the given schema type.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
public @NonNull SetSchemaRequest.Builder clearRequiredPermissionsForSchemaTypeVisibility(
    @NonNull String schemaType
)

Clears all required permissions combinations for the given schema type.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SET_SCHEMA_REQUEST_ADD_SCHEMA_TYPE_VISIBLE_TO_CONFIG)
public @NonNull SetSchemaRequest.Builder clearSchemaTypeVisibleToConfigs(@NonNull String schemaType)

Clears all visible to SchemaVisibilityConfig for the given schema type.

@ExperimentalAppSearchApi
public @NonNull SetSchemaRequest.Builder clearSchemas()

Clears all AppSearchSchemas from the list of schemas.

public @NonNull SetSchemaRequest.Builder setDocumentClassDisplayedBySystem(
    @NonNull Class<@NonNull ?> documentClass,
    boolean displayed
)

Sets whether or not documents from the provided androidx.appsearch.annotation.Document annotated class will be displayed and visible on any system UI surface.

This setting applies to the provided androidx.appsearch.annotation.Document annotated class only, and does not persist across setSchemaAsync calls.

The default behavior, if this method is not called, is to allow types to be displayed on system UI surfaces.

You can use isFeatureSupported with the SET_SCHEMA_REQUEST_SCHEMA_TYPE_DISPLAYED_BY_SYSTEM Feature to see if this visibility mode is supported on this backend / API level combination. If not supported, this function is still safe to call and the configuration will be saved in the schema, but it will not have any effect and documents will not be visible through this mechanism on that backend / API level.

Merged list available from getSchemasNotDisplayedBySystem.

public @NonNull SetSchemaRequest.Builder setDocumentClassVisibilityForPackage(
    @NonNull Class<@NonNull ?> documentClass,
    boolean visible,
    @NonNull PackageIdentifier packageIdentifier
)

Sets whether or not documents from the provided androidx.appsearch.annotation.Document annotated class can be read by the specified package.

Each package is represented by a PackageIdentifier, containing a package name and a byte array of type CERT_INPUT_SHA256.

To opt into one-way data sharing with another application, the developer will need to explicitly grant the other application’s package name and certificate Read access to its data.

For two-way data sharing, both applications need to explicitly grant Read access to one another.

By default, app data sharing between applications is disabled.

The relationship between visible packages added in this method and permission visibility setting addRequiredPermissionsForSchemaTypeVisibility is "OR". The caller could access the schema if they match ANY requirements. If you want to set "AND" requirements like a caller must hold required permissions AND it is a specified package, please use addSchemaTypeVisibleToConfig.

Merged list available from getSchemasVisibleToPackages.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SET_SCHEMA_REQUEST_SET_WIPEOUT_ACCOUNT)
@ExperimentalAppSearchApi
public @NonNull SetSchemaRequest.Builder setDocumentClassWipeoutAccountPropertyPaths(
    @NonNull Class<@NonNull ?> documentClass,
    @NonNull Set<PropertyPath> accountPropertyPaths,
    boolean autoWipeOut
)

Configures the property paths within a specific schema type that are associated with a account, enabling AppSearch to automatically wipe out GenericDocuments when that account is removed.

The property path must point to a androidx.appsearch.app.AppSearchSchema.DocumentPropertyConfig which is AppSearch built-in account.

When putting a GenericDocument into AppSearch, all accounts identified by the given accountPropertyPaths within that document must already exist. AppSearch will reject the document if any account specified by these paths is not recognized.

public @NonNull SetSchemaRequest.Builder setForceOverride(boolean forceOverride)

Sets whether or not to override the current schema in the AppSearchSession database.

Call this method whenever backward incompatible changes need to be made by setting forceOverride to true. As a result, during execution of the setSchema operation, all documents that are incompatible with the new schema will be deleted and the new schema will be saved and persisted.

By default, this is false.

public @NonNull SetSchemaRequest.Builder setMigrator(@NonNull String schemaType, @NonNull Migrator migrator)

Sets the Migrator associated with the given SchemaType.

The Migrator migrates all GenericDocuments under given schema type from the current version number stored in AppSearch to the final version set via setVersion.

A Migrator will be invoked if the current version number stored in AppSearch is different from the final version set via setVersion and shouldMigrate returns true.

The target schema type of the output GenericDocument of onUpgrade or onDowngrade must exist in this SetSchemaRequest.

public @NonNull SetSchemaRequest.Builder setMigrators(@NonNull Map<String, Migrator> migrators)

Sets a Map of Migrators.

The key of the map is the schema type that the Migrator value applies to.

The Migrator migrates all GenericDocuments under given schema type from the current version number stored in AppSearch to the final version set via setVersion.

A Migrator will be invoked if the current version number stored in AppSearch is different from the final version set via setVersion and shouldMigrate returns true.

The target schema type of the output GenericDocument of onUpgrade or onDowngrade must exist in this SetSchemaRequest.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SET_SCHEMA_REQUEST_SET_PUBLICLY_VISIBLE)
public @NonNull SetSchemaRequest.Builder setPubliclyVisibleDocumentClass(
    @NonNull Class<@NonNull ?> documentClass,
    @Nullable PackageIdentifier packageIdentifier
)

Specify that the documents from the provided androidx.appsearch.annotation.Document annotated class should be publicly available, to packages which already have visibility to packageIdentifier. This visibility is determined by the result of canPackageQuery.

It is possible for the packageIdentifier parameter to be different from the package performing the indexing. This might happen in the case of an on-device indexer processing information about various packages. The visibility will be the same regardless of which package indexes the document, as the visibility is based on the packageIdentifier parameter.

If this is called repeatedly with the same androidx.appsearch.annotation.Document annotated class, the PackageIdentifier in the last call will be used as the "from" package for that class (or schema).

Calling this with packageIdentifier set to null is valid, and will remove public visibility for the class (or schema).

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SET_SCHEMA_REQUEST_SET_PUBLICLY_VISIBLE)
public @NonNull SetSchemaRequest.Builder setPubliclyVisibleSchema(
    @NonNull String schema,
    @Nullable PackageIdentifier packageIdentifier
)

Specify that the schema should be publicly available, to packages which already have visibility to packageIdentifier. This visibility is determined by the result of canPackageQuery.

It is possible for the packageIdentifier parameter to be different from the package performing the indexing. This might happen in the case of an on-device indexer processing information about various packages. The visibility will be the same regardless of which package indexes the document, as the visibility is based on the packageIdentifier parameter.

If this is called repeatedly with the same schema, the PackageIdentifier in the last call will be used as the "from" package for that schema.

Calling this with packageIdentifier set to null is valid, and will remove public visibility for the schema.

public @NonNull SetSchemaRequest.Builder setSchemaTypeDisplayedBySystem(
    @NonNull String schemaType,
    boolean displayed
)

Sets whether or not documents from the provided schemaType will be displayed and visible on any system UI surface.

This setting applies to the provided schemaType only, and does not persist across setSchemaAsync calls.

The default behavior, if this method is not called, is to allow types to be displayed on system UI surfaces.

You can use isFeatureSupported with the SET_SCHEMA_REQUEST_SCHEMA_TYPE_DISPLAYED_BY_SYSTEM Feature to see if this visibility mode is supported on this backend / API level combination. If not supported, this function is still safe to call and the configuration will be saved in the schema, but it will not have any effect and documents will not be visible through this mechanism on that backend / API level.

public @NonNull SetSchemaRequest.Builder setSchemaTypeVisibilityForPackage(
    @NonNull String schemaType,
    boolean visible,
    @NonNull PackageIdentifier packageIdentifier
)

Sets whether or not documents from the provided schemaType can be read by the specified package.

Each package is represented by a PackageIdentifier, containing a package name and a byte array of type CERT_INPUT_SHA256.

To opt into one-way data sharing with another application, the developer will need to explicitly grant the other application’s package name and certificate Read access to its data.

For two-way data sharing, both applications need to explicitly grant Read access to one another.

By default, data sharing between applications is disabled.

The relationship between permissions added in this method and package visibility setting setSchemaTypeVisibilityForPackage is "OR". The caller could access the schema if they match ANY requirements. If you want to set "AND" requirements like a caller must hold required permissions AND it is a specified package, please use addSchemaTypeVisibleToConfig.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SET_SCHEMA_REQUEST_SET_WIPEOUT_ACCOUNT)
@ExperimentalAppSearchApi
public @NonNull SetSchemaRequest.Builder setSchemaTypeWipeoutAccountPropertyPaths(
    @NonNull String schemaType,
    @NonNull Set<PropertyPath> accountPropertyPaths,
    boolean autoWipeout
)

Configures the property paths within a specific schema type that are associated with a account, enabling AppSearch to automatically wipe out GenericDocuments when that account is removed.

To enable AppSearch to automatically wipe out documents when an account is removed, you must use this API to configure the account property paths for the relevant schema type. If this configuration is not set for a schema type, AppSearch will not automatically delete any GenericDocuments of that type, even if the account associated with the document is removed from the system. Documents will only be deleted if the app explicitly calls for their removal.

The property path must point to a androidx.appsearch.app.AppSearchSchema.DocumentPropertyConfig which is AppSearch built-in account. The property path could point to the nested document.

When putting a GenericDocument into AppSearch, all accounts identified by the given accountPropertyPaths within that document must already exist. AppSearch will reject the document if any account specified by these paths is not recognized.

Subsequent calls for the same schemaType are additive. When autoWipeout is true, new paths are merged into the existing configuration; when false, the specified paths are removed. This allows you to incrementally manage multiple account-associated fields within a single schema.

public @NonNull SetSchemaRequest.Builder setVersion(@IntRange(from = 1) int version)

Sets the version number of the overall AppSearchSchema in the database.

The AppSearchSession database can only ever hold documents for one version at a time.

Setting a version number that is different from the version number currently stored in AppSearch will result in AppSearch calling the Migrators provided to setSchemaAsync to migrate the documents already in AppSearch from the previous version to the one set in this request. The version number can be updated without any other changes to the set of schemas.

The version number can stay the same, increase, or decrease relative to the current version number that is already stored in the AppSearchSession database.

The version of an empty database will always be 0. You cannot set version to the SetSchemaRequest, if it doesn't contains any AppSearchSchema.