Added in API level 31

SetSchemaRequest

class SetSchemaRequest
kotlin.Any
   ↳ android.app.appsearch.SetSchemaRequest

Encapsulates a request to update the schema of an AppSearchSession database.

The schema is composed of a collection of AppSearchSchema objects, each of which defines a unique type of data.

The first call to SetSchemaRequest will set the provided schema and store it within the AppSearchSession database.

Subsequent calls will compare the provided schema to the previously saved schema, to determine how to treat existing documents.

The following types of schema modifications are always safe and are made without deleting any existing documents:

  • Addition of new AppSearchSchema types
  • Addition of new properties to an existing AppSearchSchema type
  • Changing the cardinality of a property to be less restrictive

The following types of schema changes are not backwards compatible:

  • Removal of an existing AppSearchSchema type
  • Removal of a property from an existing AppSearchSchema type
  • Changing the data type of an existing property
  • Changing the cardinality of a property to be more restrictive

Providing a schema with incompatible changes, will throw an , with a message describing the incompatibility. As a result, the previously set schema will remain unchanged.

Backward incompatible changes can be made by :

Summary

Nested classes

Builder for SetSchemaRequest objects.

Constants
static Int

The android.Manifest.permission#READ_ASSISTANT_APP_SEARCH_DATA AppSearch supported in SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

static Int

The android.Manifest.permission#READ_CALENDAR AppSearch supported in android.app.appsearch.SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

static Int

The android.Manifest.permission#READ_CONTACTS AppSearch supported in android.app.appsearch.SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

static Int

The android.Manifest.permission#READ_EXTERNAL_STORAGE AppSearch supported in android.app.appsearch.SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

static Int

The android.Manifest.permission#READ_HOME_APP_SEARCH_DATA AppSearch supported in SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

static Int

The android.Manifest.permission#READ_SMS AppSearch supported in android.app.appsearch.SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

Public methods
MutableMap<String!, Migrator!>

Returns the map of Migrator, the key will be the schema type of the Migrator associated with.

MutableMap<String!, MutableSet<MutableSet<Int!>!>!>

Returns a mapping of schema types to the Map of android.Manifest.permission combinations that querier must hold to access that schema type.

MutableSet<AppSearchSchema!>

Returns the AppSearchSchema types that are part of this request.

MutableSet<String!>

Returns all the schema types that are opted out of being displayed and visible on any system UI surface.

MutableMap<String!, MutableSet<PackageIdentifier!>!>

Returns a mapping of schema types to the set of packages that have access to that schema type.

Int

Returns the database overall schema version.

Boolean

Returns whether this request will force the schema to be overridden.

Constants

READ_ASSISTANT_APP_SEARCH_DATA

Added in API level 33
static val READ_ASSISTANT_APP_SEARCH_DATA: Int

The android.Manifest.permission#READ_ASSISTANT_APP_SEARCH_DATA AppSearch supported in SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

Value: 6

READ_EXTERNAL_STORAGE

Added in API level 33
static val READ_EXTERNAL_STORAGE: Int

The android.Manifest.permission#READ_EXTERNAL_STORAGE AppSearch supported in android.app.appsearch.SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

Value: 4

READ_HOME_APP_SEARCH_DATA

Added in API level 33
static val READ_HOME_APP_SEARCH_DATA: Int

The android.Manifest.permission#READ_HOME_APP_SEARCH_DATA AppSearch supported in SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility

Value: 5

Public methods

getMigrators

Added in API level 31
fun getMigrators(): MutableMap<String!, Migrator!>

Returns the map of Migrator, the key will be the schema type of the Migrator associated with.

Return
MutableMap<String!, Migrator!> This value cannot be null.

getRequiredPermissionsForSchemaTypeVisibility

Added in API level 33
fun getRequiredPermissionsForSchemaTypeVisibility(): MutableMap<String!, MutableSet<MutableSet<Int!>!>!>

Returns a mapping of schema types to the Map of android.Manifest.permission combinations that querier must hold to access that schema type.

The querier could read the GenericDocument objects under the schemaType if they holds ALL required permissions of ANY of the individual value sets.

For example, if the Map contains {{permissionA, PermissionB}, {PermissionC, PermissionD}, {PermissionE}}.

  • A querier holds both PermissionA and PermissionB has access.
  • A querier holds both PermissionC and PermissionD has access.
  • A querier holds only PermissionE has access.
  • A querier holds both PermissionA and PermissionE has access.
  • A querier holds only PermissionA doesn't have access.
  • A querier holds both PermissionA and PermissionC doesn't have access.

It’s inefficient to call this method repeatedly.

Return
MutableMap<String!, MutableSet<MutableSet<Int!>!>!> The map contains schema type and all combinations of required permission for querier to access it. The supported Permission are SetSchemaRequest#READ_SMS, android.app.appsearch.SetSchemaRequest#READ_CALENDAR, SetSchemaRequest#READ_CONTACTS, android.app.appsearch.SetSchemaRequest#READ_EXTERNAL_STORAGE, android.app.appsearch.SetSchemaRequest#READ_HOME_APP_SEARCH_DATA and android.app.appsearch.SetSchemaRequest#READ_ASSISTANT_APP_SEARCH_DATA. This value cannot be null.

getSchemas

Added in API level 31
fun getSchemas(): MutableSet<AppSearchSchema!>

Returns the AppSearchSchema types that are part of this request.

Return
MutableSet<AppSearchSchema!> This value cannot be null.

getSchemasNotDisplayedBySystem

Added in API level 31
fun getSchemasNotDisplayedBySystem(): MutableSet<String!>

Returns all the schema types that are opted out of being displayed and visible on any system UI surface.

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

getSchemasVisibleToPackages

Added in API level 31
fun getSchemasVisibleToPackages(): MutableMap<String!, MutableSet<PackageIdentifier!>!>

Returns a mapping of schema types to the set of packages that have access to that schema type.

It’s inefficient to call this method repeatedly.

Return
MutableMap<String!, MutableSet<PackageIdentifier!>!> This value cannot be null.

getVersion

Added in API level 31
fun getVersion(): Int

Returns the database overall schema version.

Return
Int Value is 1 or greater

isForceOverride

Added in API level 31
fun isForceOverride(): Boolean

Returns whether this request will force the schema to be overridden.