Added in API level 31

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

GetSchemaResponse

Kotlin |Java

public final class GetSchemaResponse
extends Object implements Parcelable

java.lang.Object
↳	android.app.appsearch.GetSchemaResponse

The response class of AppSearchSession#getSchema

Summary

Nested classes
`class`	`GetSchemaResponse.Builder` Builder for `GetSchemaResponse` objects.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<GetSchemaResponse>`	`CREATOR`

Public methods
`Map<String, PackageIdentifier>`	`getPubliclyVisibleSchemas()` Returns a mapping of publicly visible schemas to the `PackageIdentifier` specifying the package the schemas are from.
`Map<String, Set<Set<Integer>>>`	`getRequiredPermissionsForSchemaTypeVisibility()` Returns a mapping of schema types to the set of `Manifest.permission` combination sets that querier must hold to access that schema type.
`Set<String>`	`getSchemaTypesNotDisplayedBySystem()` Returns all the schema types that are opted out of being displayed and visible on any system UI surface.
`Map<String, Set<SchemaVisibilityConfig>>`	`getSchemaTypesVisibleToConfigs()` Returns a mapping of schema types to the set of `SchemaVisibilityConfig` that have access to that schema type.
`Map<String, Set<PackageIdentifier>>`	`getSchemaTypesVisibleToPackages()` Returns a mapping of schema types to the set of packages that have access to that schema type.
`Set<AppSearchSchema>`	`getSchemas()` Return the schemas most recently successfully provided to `AppSearchSession#setSchema`.
`int`	`getVersion()` Returns the overall database schema version.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 35

public static final Creator<GetSchemaResponse> CREATOR

Public methods

getPubliclyVisibleSchemas

Added in API level 35

public Map<String, PackageIdentifier> getPubliclyVisibleSchemas ()

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.

Returns
`Map<String, PackageIdentifier>`	This value cannot be `null`.

getRequiredPermissionsForSchemaTypeVisibility

Added in API level 33

public Map<String, Set<Set<Integer>>> getRequiredPermissionsForSchemaTypeVisibility ()

Returns a mapping of schema types to the set of 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.

Returns
`Map<String, Set<Set<Integer>>>`	The map contains schema type and all combinations of required permission for querier to access it. The supported Permission are `SetSchemaRequest#READ_SMS`, `SetSchemaRequest.READ_CALENDAR`, `SetSchemaRequest#READ_CONTACTS`, `SetSchemaRequest.READ_EXTERNAL_STORAGE`, `SetSchemaRequest.READ_HOME_APP_SEARCH_DATA` and `SetSchemaRequest.READ_ASSISTANT_APP_SEARCH_DATA`. This value cannot be `null`.

getSchemaTypesNotDisplayedBySystem

Added in API level 33

public Set<String> getSchemaTypesNotDisplayedBySystem ()

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

Returns
`Set<String>`	This value cannot be `null`.

getSchemaTypesVisibleToConfigs

Added in API level 35

public Map<String, Set<SchemaVisibilityConfig>> getSchemaTypesVisibleToConfigs ()

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

Returns
`Map<String, Set<SchemaVisibilityConfig>>`	This value cannot be `null`.

See also:

SetSchemaRequest.Builder.addSchemaTypeVisibleToConfig(String, SchemaVisibilityConfig)

getSchemaTypesVisibleToPackages

Added in API level 33

public Map<String, Set<PackageIdentifier>> getSchemaTypesVisibleToPackages ()

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

Returns
`Map<String, Set<PackageIdentifier>>`	This value cannot be `null`.

getSchemas

Added in API level 31

public Set<AppSearchSchema> getSchemas ()

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

Returns
`Set<AppSearchSchema>`	This value cannot be `null`.

getVersion

Added in API level 31

public int getVersion ()

Returns the overall database schema version.

If the database is empty, 0 will be returned.

Returns
`int`	Value is 0 or greater

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

GetSchemaResponse

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

getPubliclyVisibleSchemas

getRequiredPermissionsForSchemaTypeVisibility

getSchemaTypesNotDisplayedBySystem

getSchemaTypesVisibleToConfigs

getSchemaTypesVisibleToPackages

getSchemas

getVersion

writeToParcel