Added in API level 31

Summary: Ctors | Methods | Inherited Methods

GetSchemaResponse.Builder

---

Kotlin |Java

public static final class GetSchemaResponse.Builder
extends Object

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

---

Builder for GetSchemaResponse objects.

Summary

Public constructors
Builder() Create a Builder object}

Public methods
GetSchemaResponse.Builder	addSchema(AppSearchSchema schema) Adds one AppSearchSchema to the schema list.
GetSchemaResponse.Builder	addSchemaTypeNotDisplayedBySystem(String schemaType) Sets whether or not documents from the provided schemaType will be displayed and visible on any system UI surface.
GetSchemaResponse	build() Builds a GetSchemaResponse object.
GetSchemaResponse.Builder	setPubliclyVisibleSchema(String schemaType, PackageIdentifier packageIdentifier) Specify that the schema should be publicly available, to packages which already have visibility to packageIdentifier.
GetSchemaResponse.Builder	setRequiredPermissionsForSchemaTypeVisibility(String schemaType, Set<Set<Integer>> visibleToPermissionSets) Sets a set of required Manifest.permission combinations to the given schema type.
GetSchemaResponse.Builder	setSchemaTypeVisibleToConfigs(String schemaType, Set<SchemaVisibilityConfig> visibleToConfigs) Sets the documents from the provided schemaType can be read by the caller if they match the ALL visibility requirements set in SchemaVisibilityConfig.
GetSchemaResponse.Builder	setSchemaTypeVisibleToPackages(String schemaType, Set<PackageIdentifier> packageIdentifiers) Sets whether or not documents from the provided schemaType can be read by the specified package.
GetSchemaResponse.Builder	setVersion(int version) Sets the database overall schema version.

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.

Public constructors

Builder

Added in API level 31

public Builder ()

Create a Builder object}

Public methods

addSchema

Added in API level 31

public GetSchemaResponse.Builder addSchema (AppSearchSchema schema)

Adds one AppSearchSchema to the schema list.

Parameters
schema	AppSearchSchema: This value cannot be null.

Returns
GetSchemaResponse.Builder	This value cannot be null.

addSchemaTypeNotDisplayedBySystem

Added in API level 33

public GetSchemaResponse.Builder addSchemaTypeNotDisplayedBySystem (String schemaType)

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

Parameters
schemaType	String: The name of an AppSearchSchema within the same GetSchemaResponse, which won't be displayed by system. This value cannot be null.

Returns
GetSchemaResponse.Builder	This value cannot be null.

build

Added in API level 31

public GetSchemaResponse build ()

Builds a GetSchemaResponse object.

Returns
GetSchemaResponse	This value cannot be null.

setPubliclyVisibleSchema

Added in API level 35

public GetSchemaResponse.Builder setPubliclyVisibleSchema (String schemaType, 
                PackageIdentifier packageIdentifier)

Specify that the schema should be publicly available, to packages which already have visibility to packageIdentifier.

Parameters
schemaType	String: the schema to make publicly accessible. This value cannot be null.
packageIdentifier	PackageIdentifier: the package from which the document schema is from. This value cannot be null.

Returns
GetSchemaResponse.Builder	This value cannot be null.

See also:

• SetSchemaRequest.Builder.setPubliclyVisibleSchema(String, PackageIdentifier)

setRequiredPermissionsForSchemaTypeVisibility

Added in API level 33

public GetSchemaResponse.Builder setRequiredPermissionsForSchemaTypeVisibility (String schemaType, 
                Set<Set<Integer>> visibleToPermissionSets)

Sets a set of required Manifest.permission combinations to the given 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.

Parameters
schemaType	String: The schema type to set visibility on. This value cannot be null.
visibleToPermissionSets	Set: The Sets of Android permissions that will be required to access the given schema. Value is SetSchemaRequest.READ_SMS, SetSchemaRequest.READ_CALENDAR, SetSchemaRequest.READ_CONTACTS, SetSchemaRequest.READ_EXTERNAL_STORAGE, SetSchemaRequest.READ_HOME_APP_SEARCH_DATA, SetSchemaRequest.READ_ASSISTANT_APP_SEARCH_DATA, android.app.appsearch.SetSchemaRequest.ENTERPRISE_ACCESS, or android.app.appsearch.SetSchemaRequest.MANAGED_PROFILE_CONTACTS_ACCESS This value cannot be null.

Returns
GetSchemaResponse.Builder	This value cannot be null.

See also:

• Manifest.permission.READ_SMS
• Manifest.permission.READ_CALENDAR
• Manifest.permission.READ_CONTACTS
• Manifest.permission.READ_EXTERNAL_STORAGE
• Manifest.permission.READ_HOME_APP_SEARCH_DATA
• Manifest.permission.READ_ASSISTANT_APP_SEARCH_DATA

setSchemaTypeVisibleToConfigs

Added in API level 35

public GetSchemaResponse.Builder setSchemaTypeVisibleToConfigs (String schemaType, 
                Set<SchemaVisibilityConfig> visibleToConfigs)

Sets the documents from the provided schemaType can be read by the caller if they match the ALL visibility requirements set in SchemaVisibilityConfig.

The requirements in a SchemaVisibilityConfig is "AND" relationship. A caller must match ALL requirements to access the schema. For example, a caller must hold required permissions AND it is a specified package.

The querier could have access if they match ALL requirements in ANY of the given SchemaVisibilityConfigs

For example, if the Set contains {{PackageA and Permission1}, {PackageB and Permission2}}.

• A querier from packageA could read if they holds Permission1.
• A querier from packageA could NOT read if they only holds Permission2 instead of Permission1.
• A querier from packageB could read if they holds Permission2.
• A querier from packageC could never read.
• A querier holds both PermissionA and PermissionE has access.

Parameters
schemaType	String: The schema type to set visibility on. This value cannot be null.
visibleToConfigs	Set: The SchemaVisibilityConfigs hold all requirements that a call must to match to access the schema. This value cannot be null.

Returns
GetSchemaResponse.Builder	This value cannot be null.

setSchemaTypeVisibleToPackages

Added in API level 33

public GetSchemaResponse.Builder setSchemaTypeVisibleToPackages (String schemaType, 
                Set<PackageIdentifier> packageIdentifiers)

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 PackageManager.CERT_INPUT_SHA256.

To opt into one-way data sharing with another application, the developer will need to explicitly grant the other application\u2019s 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.

Parameters
schemaType	String: The schema type to set visibility on. This value cannot be null.
packageIdentifiers	Set: Represents the package that has access to the given schema type. This value cannot be null.

Returns
GetSchemaResponse.Builder	This value cannot be null.

setVersion

Added in API level 31

public GetSchemaResponse.Builder setVersion (int version)

Sets the database overall schema version.

Default version is 0

Parameters
version	int: Value is 0 or greater

Returns
GetSchemaResponse.Builder	This value cannot be null.