SetSchemaRequest.Builder

class SetSchemaRequest.Builder


Builder for SetSchemaRequest objects.

Summary

Public constructors

Public functions

SetSchemaRequest.Builder
addDocumentClasses(documentClasses: Array<Class<Any!>!>)

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

SetSchemaRequest.Builder

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

SetSchemaRequest.Builder
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
addRequiredPermissionsForDocumentClassVisibility(
    documentClass: Class<Any!>,
    permissions: (Mutable)Set<Int!>
)

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

SetSchemaRequest.Builder
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
addRequiredPermissionsForSchemaTypeVisibility(
    schemaType: String,
    permissions: (Mutable)Set<Int!>
)

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

SetSchemaRequest.Builder

Adds one or more AppSearchSchema types to the schema.

SetSchemaRequest.Builder

Adds a collection of AppSearchSchema objects to the schema.

SetSchemaRequest

Builds a new SetSchemaRequest object.

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

Clears all required permissions combinations for the given schema type.

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

Clears all required permissions combinations for the given schema type.

SetSchemaRequest.Builder
setDocumentClassDisplayedBySystem(
    documentClass: Class<Any!>,
    displayed: Boolean
)

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

SetSchemaRequest.Builder
setDocumentClassVisibilityForPackage(
    documentClass: Class<Any!>,
    visible: Boolean,
    packageIdentifier: PackageIdentifier
)

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

SetSchemaRequest.Builder
setForceOverride(forceOverride: Boolean)

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

SetSchemaRequest.Builder
setMigrator(schemaType: String, migrator: Migrator)

Sets the Migrator associated with the given SchemaType.

SetSchemaRequest.Builder

Sets a Map of Migrators.

SetSchemaRequest.Builder
setSchemaTypeDisplayedBySystem(schemaType: String, displayed: Boolean)

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

SetSchemaRequest.Builder
setSchemaTypeVisibilityForPackage(
    schemaType: String,
    visible: Boolean,
    packageIdentifier: PackageIdentifier
)

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

SetSchemaRequest.Builder
setVersion(version: @IntRange(from = 1) Int)

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

Public constructors

Builder

Added in 1.1.0-alpha04
Builder()

Public functions

addDocumentClasses

fun addDocumentClasses(documentClasses: Array<Class<Any!>!>): SetSchemaRequest.Builder

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

Merged list available from getSchemas.

Parameters
documentClasses: Array<Class<Any!>!>

classes annotated with androidx.appsearch.annotation.Document.

Throws
androidx.appsearch.exceptions.AppSearchException

if androidx.appsearch.compiler.AppSearchCompiler has not generated a schema for the given document classes.

addDocumentClasses

Added in 1.1.0-alpha04
fun addDocumentClasses(documentClasses: (Mutable)Collection<Class<Any!>!>): SetSchemaRequest.Builder

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.

Parameters
documentClasses: (Mutable)Collection<Class<Any!>!>

classes annotated with androidx.appsearch.annotation.Document.

Throws
androidx.appsearch.exceptions.AppSearchException

if androidx.appsearch.compiler.AppSearchCompiler has not generated a schema for the given document classes.

addRequiredPermissionsForDocumentClassVisibility

Added in 1.1.0-alpha04
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
fun addRequiredPermissionsForDocumentClassVisibility(
    documentClass: Class<Any!>,
    permissions: (Mutable)Set<Int!>
): SetSchemaRequest.Builder

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.

Merged map available from getRequiredPermissionsForSchemaTypeVisibility.

Parameters
documentClass: Class<Any!>

The androidx.appsearch.annotation.Document class to set visibility on.

permissions: (Mutable)Set<Int!>

A set of required Android permissions the caller need to hold to access GenericDocument objects that under the given schema.

addRequiredPermissionsForSchemaTypeVisibility

Added in 1.1.0-alpha04
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
fun addRequiredPermissionsForSchemaTypeVisibility(
    schemaType: String,
    permissions: (Mutable)Set<Int!>
): SetSchemaRequest.Builder

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.

Parameters
schemaType: String

The schema type to set visibility on.

permissions: (Mutable)Set<Int!>

A set of required Android permissions the caller need to hold to access GenericDocument objects that under the given schema.

Throws
java.lang.IllegalArgumentException

– if input unsupported permission.

addSchemas

fun addSchemas(schemas: Array<AppSearchSchema!>): SetSchemaRequest.Builder

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.

addSchemas

Added in 1.1.0-alpha04
fun addSchemas(schemas: (Mutable)Collection<AppSearchSchema!>): SetSchemaRequest.Builder

Adds a collection of AppSearchSchema objects to the schema.

An AppSearchSchema object represents one type of structured data.

build

Added in 1.1.0-alpha04
fun build(): SetSchemaRequest

Builds a new SetSchemaRequest object.

Throws
java.lang.IllegalArgumentException

if schema types were referenced, but the corresponding AppSearchSchema type was never added.

clearRequiredPermissionsForDocumentClassVisibility

Added in 1.1.0-alpha04
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
fun clearRequiredPermissionsForDocumentClassVisibility(
    documentClass: Class<Any!>
): SetSchemaRequest.Builder

Clears all required permissions combinations for the given schema type.

clearRequiredPermissionsForSchemaTypeVisibility

Added in 1.1.0-alpha04
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.ADD_PERMISSIONS_AND_GET_VISIBILITY)
fun clearRequiredPermissionsForSchemaTypeVisibility(schemaType: String): SetSchemaRequest.Builder

Clears all required permissions combinations for the given schema type.

setDocumentClassDisplayedBySystem

Added in 1.1.0-alpha04
fun setDocumentClassDisplayedBySystem(
    documentClass: Class<Any!>,
    displayed: Boolean
): SetSchemaRequest.Builder

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.

Merged list available from getSchemasNotDisplayedBySystem.

Parameters
documentClass: Class<Any!>

A class annotated with androidx.appsearch.annotation.Document, the visibility of which will be configured

displayed: Boolean

Whether documents of this type will be displayed on system UI surfaces.

Throws
androidx.appsearch.exceptions.AppSearchException

if androidx.appsearch.compiler.AppSearchCompiler has not generated a schema for the given document class.

setDocumentClassVisibilityForPackage

Added in 1.1.0-alpha04
fun setDocumentClassVisibilityForPackage(
    documentClass: Class<Any!>,
    visible: Boolean,
    packageIdentifier: PackageIdentifier
): SetSchemaRequest.Builder

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.

Merged list available from getSchemasVisibleToPackages.

Parameters
documentClass: Class<Any!>

The androidx.appsearch.annotation.Document class to set visibility on.

visible: Boolean

Whether the documentClass will be visible or not.

packageIdentifier: PackageIdentifier

Represents the package that will be granted visibility.

Throws
androidx.appsearch.exceptions.AppSearchException

if androidx.appsearch.compiler.AppSearchCompiler has not generated a schema for the given document class.

setForceOverride

Added in 1.1.0-alpha04
fun setForceOverride(forceOverride: Boolean): SetSchemaRequest.Builder

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.

setMigrator

Added in 1.1.0-alpha04
fun setMigrator(schemaType: String, migrator: Migrator): SetSchemaRequest.Builder

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.

Parameters
schemaType: String

The schema type to set migrator on.

migrator: Migrator

The migrator translates a document from its current version to the final version set via setVersion.

setMigrators

Added in 1.1.0-alpha04
fun setMigrators(migrators: (Mutable)Map<String!, Migrator!>): SetSchemaRequest.Builder

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.

Parameters
migrators: (Mutable)Map<String!, Migrator!>

A Map of migrators that translate a document from its current version to the final version set via setVersion. The key of the map is the schema type that the Migrator value applies to.

setSchemaTypeDisplayedBySystem

Added in 1.1.0-alpha04
fun setSchemaTypeDisplayedBySystem(schemaType: String, displayed: Boolean): SetSchemaRequest.Builder

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.

Parameters
schemaType: String

The name of an AppSearchSchema within the same SetSchemaRequest, which will be configured.

displayed: Boolean

Whether documents of this type will be displayed on system UI surfaces.

setSchemaTypeVisibilityForPackage

Added in 1.1.0-alpha04
fun setSchemaTypeVisibilityForPackage(
    schemaType: String,
    visible: Boolean,
    packageIdentifier: PackageIdentifier
): SetSchemaRequest.Builder

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.

Parameters
schemaType: String

The schema type to set visibility on.

visible: Boolean

Whether the schemaType will be visible or not.

packageIdentifier: PackageIdentifier

Represents the package that will be granted visibility.

setVersion

Added in 1.1.0-alpha04
fun setVersion(version: @IntRange(from = 1) Int): SetSchemaRequest.Builder

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.

Parameters
version: @IntRange(from = 1) Int

A positive integer representing the version of the entire set of schemas represents the version of the whole schema in the AppSearchSession database, default version is 1.

Throws
java.lang.IllegalArgumentException

if the version is negative.