GetSchemaResponse.Builder

public static final class GetSchemaResponse.Builder extends Object

Builder for GetSchemaResponse objects.

Public Constructor Summary

Builder()
Create a GetSchemaResponse.Builder object}

Public Method Summary

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 Method Summary

Public Constructors

public Builder ()

Create a GetSchemaResponse.Builder object}

Public Methods

public GetSchemaResponse.Builder addSchema (AppSearchSchema schema)

Adds one AppSearchSchema to the schema list.

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 The name of an AppSearchSchema within the same GetSchemaResponse, which won't be displayed by system.

public GetSchemaResponse build ()

Builds a GetSchemaResponse object.

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 the schema to make publicly accessible.
packageIdentifier the package from which the document schema is from.
See Also

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 The schema type to set visibility on.
visibleToPermissionSets The Sets of Android permissions that will be required to access the given schema.
See Also

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 The schema type to set visibility on.
visibleToConfigs The SchemaVisibilityConfigs hold all requirements that a call must to match to access the schema.

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

Parameters
schemaType The schema type to set visibility on.
packageIdentifiers Represents the package that has access to the given schema type.

public GetSchemaResponse.Builder setVersion (int version)

Sets the database overall schema version.

Default version is 0