Added in API level 31

GetSchemaResponse

class GetSchemaResponse : Parcelable
kotlin.Any
   ↳ android.app.appsearch.GetSchemaResponse

The response class of AppSearchSession#getSchema

Summary

Nested classes

Builder for GetSchemaResponse objects.
Inherited constants
Public methods
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 set of android.Manifest.permission combination sets that querier must hold to access that schema type.
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.
MutableSet<AppSearchSchema!>

Return the schemas most recently successfully provided to AppSearchSession#setSchema.
Int

Returns the overall database schema version.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<GetSchemaResponse!>

Public methods

getPubliclyVisibleSchemas

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

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

If no schemas have been set as publicly visible, an empty set will be returned.

Return
MutableMap<String!, PackageIdentifier!> 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 set of android.Manifest.permission combination sets 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 holding both PermissionA and PermissionB has access.
  • A querier holding both PermissionC and PermissionD has access.
  • A querier holding only PermissionE has access.
  • A querier holding both PermissionA and PermissionE has access.
  • A querier holding only PermissionA doesn't have access.
  • A querier holding only PermissionA and PermissionC doesn't have access.
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.

getSchemaTypesNotDisplayedBySystem

Added in API level 33
fun getSchemaTypesNotDisplayedBySystem(): 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.

getSchemaTypesVisibleToConfigs

Added in API level 35
fun getSchemaTypesVisibleToConfigs(): MutableMap<String!, MutableSet<SchemaVisibilityConfig!>!>

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

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

getSchemaTypesVisibleToPackages

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

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

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

getSchemas

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

Return the schemas most recently successfully provided to AppSearchSession#setSchema.

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

getVersion

Added in API level 31
fun getVersion(): Int

Returns the overall database schema version.

If the database is empty, 0 will be returned.

Return
Int Value is 0 or greater

writeToParcel

Added in API level 35
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 35
static val CREATOR: Parcelable.Creator<GetSchemaResponse!>