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
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
MutableMap<String!, Migrator!>

Returns the map of Migrator, the key will be the schema type of the Migrator associated with.
MutableMap<String!, PackageIdentifier!>

Returns a mapping of publicly visible schemas to the PackageIdentifier specifying the package the schemas are from.
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<SchemaVisibilityConfig!>!>

Returns a mapping of schema types to the set of SchemaVisibilityConfig that have access to that schema type.
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.
Int

Boolean

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

Constants

READ_ASSISTANT_APP_SEARCH_DATA

Added in API level 33
Also in T Extensions 3
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_CALENDAR

Added in API level 33
Also in T Extensions 3
static val READ_CALENDAR: Int

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

Value: 2

READ_CONTACTS

Added in API level 33
Also in T Extensions 3
static val READ_CONTACTS: Int

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

Value: 3

READ_EXTERNAL_STORAGE

Added in API level 33
Also in T Extensions 3
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
Also in T Extensions 3
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

READ_SMS

Added in API level 33
Also in T Extensions 3
static val READ_SMS: Int

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

Value: 1

Public methods

equals

Added in API level 31
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
other Any?: This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

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.

getPubliclyVisibleSchemas

Added in API level 35
Also in T Extensions 13
fun getPubliclyVisibleSchemas(): MutableMap<String!, PackageIdentifier!>

Returns a mapping of publicly visible schemas to the PackageIdentifier specifying the package the schemas are from.

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

getRequiredPermissionsForSchemaTypeVisibility

Added in API level 33
Also in T Extensions 3
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.

getSchemasVisibleToConfigs

Added in API level 35
Also in T Extensions 13
fun getSchemasVisibleToConfigs(): MutableMap<String!, MutableSet<SchemaVisibilityConfig!>!>

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

It’s inefficient to call this method repeatedly.

Return
MutableMap<String!, MutableSet<SchemaVisibilityConfig!>!> 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

hashCode

Added in API level 31
fun hashCode(): Int
Return
Int a hash code value for this object.

isForceOverride

Added in API level 31
fun isForceOverride(): Boolean

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