88 lines
2.8 KiB
Java
88 lines
2.8 KiB
Java
|
/*
|
||
|
|
* Copyright (C) 2024 The Android Open Source Project
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
package android.service.wearable;
|
||
|
|
|
||
|
|
import android.annotation.FlaggedApi;
|
||
|
|
import android.annotation.IntDef;
|
||
|
|
import android.annotation.NonNull;
|
||
|
|
import android.annotation.SystemApi;
|
||
|
|
import android.app.wearable.Flags;
|
||
|
|
import android.app.wearable.WearableSensingDataRequest;
|
||
|
|
|
||
|
|
import java.lang.annotation.Retention;
|
||
|
|
import java.lang.annotation.RetentionPolicy;
|
||
|
|
import java.util.function.Consumer;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An interface to request wearable sensing data.
|
||
|
|
*
|
||
|
|
* @hide
|
||
|
|
*/
|
||
|
|
@FlaggedApi(Flags.FLAG_ENABLE_DATA_REQUEST_OBSERVER_API)
|
||
|
|
@SystemApi
|
||
|
|
public interface WearableSensingDataRequester {
|
||
|
|
|
||
|
|
/** An unknown status. */
|
||
|
|
int STATUS_UNKNOWN = 0;
|
||
|
|
|
||
|
|
/** The value of the status code that indicates success. */
|
||
|
|
int STATUS_SUCCESS = 1;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The value of the status code that indicates the request is rejected because the data request
|
||
|
|
* observer PendingIntent has been cancelled.
|
||
|
|
*/
|
||
|
|
int STATUS_OBSERVER_CANCELLED = 2;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The value of the status code that indicates the request is rejected because it is larger than
|
||
|
|
* {@link WearableSensingDataRequest#getMaxRequestSize()}.
|
||
|
|
*/
|
||
|
|
int STATUS_TOO_LARGE = 3;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The value of the status code that indicates the request is rejected because it exceeds the
|
||
|
|
* rate limit. See {@link WearableSensingDataRequest#getRateLimit()}.
|
||
|
|
*/
|
||
|
|
int STATUS_TOO_FREQUENT = 4;
|
||
|
|
|
||
|
|
/** @hide */
|
||
|
|
@IntDef(
|
||
|
|
prefix = {"STATUS_"},
|
||
|
|
value = {
|
||
|
|
STATUS_UNKNOWN,
|
||
|
|
STATUS_SUCCESS,
|
||
|
|
STATUS_OBSERVER_CANCELLED,
|
||
|
|
STATUS_TOO_LARGE,
|
||
|
|
STATUS_TOO_FREQUENT
|
||
|
|
})
|
||
|
|
@Retention(RetentionPolicy.SOURCE)
|
||
|
|
@interface StatusCode {}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sends a data request. See {@link WearableSensingService#onDataRequestObserverRegistered(int,
|
||
|
|
* String, WearableSensingDataRequester, Consumer)} for size and rate restrictions on data
|
||
|
|
* requests.
|
||
|
|
*
|
||
|
|
* @param dataRequest The data request to send.
|
||
|
|
* @param statusConsumer A consumer that handles the status code for the data request.
|
||
|
|
*/
|
||
|
|
void requestData(
|
||
|
|
@NonNull WearableSensingDataRequest dataRequest,
|
||
|
|
@NonNull @StatusCode Consumer<Integer> statusConsumer);
|
||
|
|
}
|