ExposureNotificationClient

Activity action which shows the exposure notification settings screen.

Action which will be invoked via a BroadcastReceiver as a callback when matching has finished and no matches were found. Also see EXTRA_TOKEN, which will be included in this broadcast.

Action which will be invoked via a BroadcastReceiver as a callback when the user has an updated exposure status. Also see EXTRA_EXPOSURE_SUMMARY and EXTRA_TOKEN, which will be included in this broadcast.

Action broadcast to a client application if requestPreAuthorizedTemporaryExposureKeyRelease() has been authorized and the user has unlocked their phone, granting release of their keys after a positive diagnosis.

This action will include an ArrayList of TemporaryExposureKeys keyed by EXTRA_TEMPORARY_EXPOSURE_KEY_LIST.

Action which will be invoked via a BroadcastReceiver when the user modifies the state of exposure notifications via the Google Settings page. EXTRA_SERVICE_STATE will be included as part of this broadcast.

Extra attached to the ACTION_EXPOSURE_STATE_UPDATED broadcast, giving a summary of the exposure details detected. Also see getExposureSummary(String).

Boolean extra included in the intent when the user launches the app via the notification shown after requestPreAuthorizedTemporaryExposureKeyRelease() has been called. This can be used to distinguish that app launch from others and show additional UX, if desired.

Boolean extra attached to the ACTION_SERVICE_STATE_UPDATED broadcast signifying whether the service is enabled or disabled.

Extra included in the ACTION_PRE_AUTHORIZE_RELEASE_PHONE_UNLOCKED broadcast, containing an ArrayList of TemporaryExposureKeys.

Extra attached to the ACTION_EXPOSURE_STATE_UPDATED broadcast, providing the token associated with the provideDiagnosisKeys(DiagnosisKeyFileProvider) request.

Token to be used with ExposureWindows API. Must be used with provideDiagnosisKeys(DiagnosisKeyFileProvider) request when later using getExposureWindows().

Checks whether the device supports Exposure Notification BLE scanning without requiring location to be enabled first.

Gets CalibrationConfidence of the current device.

Retrieves the per-day exposure summaries associated with the provided configuration.

A valid configuration must be provided to compute the summaries.

Retrieves the current DiagnosisKeysDataMapping.

Gets detailed information about exposures that have occurred related to the provided token, which should match the token provided in provideDiagnosisKeys(DiagnosisKeyFileProvider).

When multiple ExposureInformation objects are returned, they can be:

• Multiple encounters with a single diagnosis key.
• Multiple encounters with the same device across key rotation boundaries.
• Encounters with multiple devices.

Gets a summary of the exposure calculation for the token, which should match the token provided in provideDiagnosisKeys(DiagnosisKeyFileProvider).

Retrieves the list of exposure windows corresponding to the TEKs given to provideDiagnosisKeys(DiagnosisKeyFileProvider).

Long exposures to one TEK are split into windows of up to 30 minutes of scans, so a given TEK may lead to several exposure windows if beacon sightings for it spanned more than 30 minutes. The link between them (the fact that they all correspond to the same TEK) is lost because those windows are shuffled before being returned and the underlying TEKs are not exposed by the API.

Retrieves the list of exposure windows corresponding to the TEKs given to provideKeys with token=TOKEN_A.

Long exposures to one TEK are split into windows of up to 30 minutes of scans, so a given TEK may lead to several exposure windows if beacon sightings for it spanned more than 30 minutes. The link between them (the fact that they all correspond to the same TEK) is lost because those windows are shuffled before being returned and the underlying TEKs are not exposed by the API.

The provided token must be TOKEN_A.

Retrieves the associated PackageConfiguration for the calling package. Note that this value can be null if no configuration was provided when starting.

Gets the current Exposure Notification status.

Gets TemporaryExposureKey history to be stored on the server.

This should only be done after proper verification is performed on the client side that the user is diagnosed positive. Each key returned will have an unknown transmission risk level, clients should choose an appropriate risk level for these keys before uploading them to the server.

The keys provided here will only be from previous days; keys will not be released until after they are no longer an active exposure key.

This shows a user permission dialog for sharing and uploading data to the server.

Gets the current Exposure Notification version.

Indicates whether contact tracing is currently running for the requesting app.

Provides a list of diagnosis key files for exposure checking. The files are to be synced from the server. Old diagnosis keys (for example older than 14 days), will be ignored.

Diagnosis keys will be stored and matching will be performed in the near future, after which you’ll receive a broadcast with the ACTION_EXPOSURE_STATE_UPDATED action. If no matches are found, you'll receive an ACTION_EXPOSURE_NOT_FOUND action.

The diagnosis key files must be signed appropriately. Results from this request can also be queried at any time via getExposureWindows() and getDailySummaries(DailySummariesConfig).

After the result Task has returned, keyFiles can be deleted.

Results remain for 14 days.

Provides diagnosis key files for exposure checking. The files are to be synced from the server. Old diagnosis keys (for example older than 14 days), will be ignored.

Diagnosis keys will be stored and matching will be performed in the near future, after which you’ll receive a broadcast with the ACTION_EXPOSURE_STATE_UPDATED action. If no matches are found, you'll receive an ACTION_EXPOSURE_NOT_FOUND action.

The diagnosis key files must be signed appropriately. Results from this request can also be queried at any time via getExposureWindows() and getDailySummaries(DailySummariesConfig).

After the result Task has returned, files can be deleted.

Results remain for 14 days.

This method is identical to providing a list of key files, but skips checking the EN version and assumes the provider can be used.

Provides a list of diagnosis key files for exposure checking. The files are to be synced from the server. Old diagnosis keys (for example older than 14 days), will be ignored.

Diagnosis keys will be stored and matching will be performed in the near future, after which you’ll receive a broadcast with the ACTION_EXPOSURE_STATE_UPDATED action. If no matches are found, you'll receive an ACTION_EXPOSURE_NOT_FOUND action.

The diagnosis key files must be signed appropriately. Exposure configuration options can be provided to tune the matching algorithm. A unique token for this batch can also be provided, which will be used to associate the matches with this request as part of getExposureSummary(String) and getExposureInformation(String). Alternatively, the same token can be passed in multiple times to concatenate results.

After the result Task has returned, keyFiles can be deleted.

Results for a given token remain for 14 days.

Shows a dialog to the user asking for authorization to get TemporaryExposureKeys in the background.

If approved, the client application will be able to call requestPreAuthorizedTemporaryExposureKeyRelease() one time in the next 5 days to get a list of TemporaryExposureKeys for a user which has tested positive.

Shows a dialog to the user asking for authorization to get TemporaryExposureKeys in the background.

If approved, the client application will be able to call requestPreAuthorizedTemporaryExposureKeyRelease() one time in the next 5 days to get a list of TemporaryExposureKeys for a user which has tested positive.

This call is identical to requestPreAuthorizedTemporaryExposureKeyHistory(), but triggers a dialog which contains different text indicating that the user is currently self-reporting and, if they receive a positive test result in the near future, they'll have their keys uploaded again with the new status.

If consent has previously been requested and granted by the user using requestPreAuthorizedTemporaryExposureKeyHistory(), then this method will cause keys to be released to the client application after the screen is unlocked by the user. Keys will be delivered via a broadcast denoted with the ACTION_PRE_AUTHORIZE_RELEASE_PHONE_UNLOCKED action.

Sets the diagnosis keys data mapping if it wasn't already changed recently.

If called twice within 7 days, the second call will have no effect and will raise an exception with status code FAILED_RATE_LIMITED.

Starts BLE broadcasts and scanning based on the defined protocol.

If not previously started, this shows a user dialog for consent to start exposure detection and get permission.

Callbacks regarding exposure status will be provided via a BroadcastReceiver. Clients should register a receiver in their AndroidManifest which can handle the following action:

• com.google.android.gms.exposurenotification.ACTION_EXPOSURE_STATE_UPDATED

Disables advertising and scanning. Contents of the database and keys will remain.

If the client app has been uninstalled by the user, this will be automatically invoked and the database and keys will be wiped from the device.

Some other features associated with the Exposure Notification system, such as the WakeUpService, will also be disabled.