GetSchemaResponse.Builder

Builder()

Creates a new Builder

@ExperimentalAppSearchApi
Builder(getSchemaResponse: GetSchemaResponse)

Creates a new Builder from the given GetSchemaResponse.

fun addSchema(schema: AppSearchSchema): GetSchemaResponse.Builder

Adds one AppSearchSchema to the schema list.

fun addSchemaTypeNotDisplayedBySystem(schemaType: String): GetSchemaResponse.Builder

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

fun build(): GetSchemaResponse

Builds a GetSchemaResponse object.

@ExperimentalAppSearchApi
fun clearPubliclyVisibleSchema(schemaType: String): GetSchemaResponse.Builder

Clears the visibility setting that specifies that the given schema type should be publicly available to packages which already have visibility to a specified package.

@ExperimentalAppSearchApi
fun clearRequiredPermissionsForSchemaTypeVisibility(schemaType: String): GetSchemaResponse.Builder

Clears the set of required android.Manifest.permission combinations to read the given schema type.

@ExperimentalAppSearchApi
fun clearSchemaTypeNotDisplayedBySystem(schemaType: String): GetSchemaResponse.Builder

Clears the visibility setting for the given schema type that prevents the schema from being displayed and visible on any system UI surface.

@ExperimentalAppSearchApi
fun clearSchemaTypeVisibleToConfigs(schemaType: String): GetSchemaResponse.Builder

Clears the SchemaVisibilityConfigs for the given schema type which allow visibility to the schema if the caller matches ALL visibility requirements of ANY SchemaVisibilityConfig.

@ExperimentalAppSearchApi
fun clearSchemaTypeVisibleToPackages(schemaType: String): GetSchemaResponse.Builder

Clears the set of packages that can read the given schema type.

@ExperimentalAppSearchApi
fun clearSchemas(): GetSchemaResponse.Builder

Clears all AppSearchSchemas from the list of schemas.

fun setPubliclyVisibleSchema(
    schemaType: String,
    packageIdentifier: PackageIdentifier
): GetSchemaResponse.Builder

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

fun setRequiredPermissionsForSchemaTypeVisibility(
    schemaType: String,
    visibleToPermissionSets: (Mutable)Set<(Mutable)Set<Int!>!>
): GetSchemaResponse.Builder

Sets a set of required android.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.

fun setSchemaTypeVisibleToConfigs(
    schemaType: String,
    visibleToConfigs: (Mutable)Set<SchemaVisibilityConfig!>
): GetSchemaResponse.Builder

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.

fun setSchemaTypeVisibleToPackages(
    schemaType: String,
    packageIdentifiers: (Mutable)Set<PackageIdentifier!>
): GetSchemaResponse.Builder

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

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

fun setVersion(version: @IntRange(from = 0) Int): GetSchemaResponse.Builder

Sets the database overall schema version.

Default version is 0

fun setVisibilitySettingSupported(visibilitySettingSupported: Boolean): GetSchemaResponse.Builder

Method to set visibility setting. If this is called with false, getRequiredPermissionsForSchemaTypeVisibility, getSchemaTypesNotDisplayedBySystem}, and getSchemaTypesVisibleToPackages calls will throw an UnsupportedOperationException. If called with true, visibility information for all schemas will be cleared.