diff options
Diffstat (limited to 'framework/java/android/bluetooth/le/AdvertisingSetCallback.java')
| -rw-r--r-- | framework/java/android/bluetooth/le/AdvertisingSetCallback.java | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/framework/java/android/bluetooth/le/AdvertisingSetCallback.java b/framework/java/android/bluetooth/le/AdvertisingSetCallback.java new file mode 100644 index 0000000000..ceed8d9e3c --- /dev/null +++ b/framework/java/android/bluetooth/le/AdvertisingSetCallback.java @@ -0,0 +1,144 @@ +/* + * Copyright (C) 2017 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.bluetooth.le; + +import android.bluetooth.BluetoothDevice; + +/** + * Bluetooth LE advertising set callbacks, used to deliver advertising operation + * status. + */ +public abstract class AdvertisingSetCallback { + + /** + * The requested operation was successful. + */ + public static final int ADVERTISE_SUCCESS = 0; + + /** + * Failed to start advertising as the advertise data to be broadcasted is too + * large. + */ + public static final int ADVERTISE_FAILED_DATA_TOO_LARGE = 1; + + /** + * Failed to start advertising because no advertising instance is available. + */ + public static final int ADVERTISE_FAILED_TOO_MANY_ADVERTISERS = 2; + + /** + * Failed to start advertising as the advertising is already started. + */ + public static final int ADVERTISE_FAILED_ALREADY_STARTED = 3; + + /** + * Operation failed due to an internal error. + */ + public static final int ADVERTISE_FAILED_INTERNAL_ERROR = 4; + + /** + * This feature is not supported on this platform. + */ + public static final int ADVERTISE_FAILED_FEATURE_UNSUPPORTED = 5; + + /** + * Callback triggered in response to {@link BluetoothLeAdvertiser#startAdvertisingSet} + * indicating result of the operation. If status is ADVERTISE_SUCCESS, then advertisingSet + * contains the started set and it is advertising. If error occured, advertisingSet is + * null, and status will be set to proper error code. + * + * @param advertisingSet The advertising set that was started or null if error. + * @param status Status of the operation. + */ + public void onAdvertisingSetStarted(AdvertisingSet advertisingSet, int status) {} + + /** + * Callback triggered in response to {@link BluetoothLeAdvertiser#stopAdvertisingSet} + * indicating advertising set is stopped. + * + * @param advertisingSet The advertising set. + */ + public void onAdvertisingSetStopped(AdvertisingSet advertisingSet) {} + + /** + * Callback triggered in response to {@link BluetoothLeAdvertiser#startAdvertisingSet} indicating + * result of the operation. If status is ADVERTISE_SUCCESS, then advertising set is advertising. + * + * @param advertisingSet The advertising set. + * @param status Status of the operation. + */ + public void onAdvertisingEnabled(AdvertisingSet advertisingSet, boolean enable, int status) {} + + /** + * Callback triggered in response to {@link AdvertisingSet#setAdvertisingData} indicating + * result of the operation. If status is ADVERTISE_SUCCESS, then data was changed. + * + * @param advertisingSet The advertising set. + * @param status Status of the operation. + */ + public void onAdvertisingDataSet(AdvertisingSet advertisingSet, int status) {} + + /** + * Callback triggered in response to {@link AdvertisingSet#setAdvertisingData} indicating + * result of the operation. + * + * @param advertisingSet The advertising set. + * @param status Status of the operation. + */ + public void onScanResponseDataSet(AdvertisingSet advertisingSet, int status) {} + + /** + * Callback triggered in response to {@link AdvertisingSet#setAdvertisingParameters} + * indicating result of the operation. + * + * @param advertisingSet The advertising set. + * @param status Status of the operation. + */ + public void onAdvertisingParametersUpdated(AdvertisingSet advertisingSet, + int status) {} + + /** + * Callback triggered in response to {@link AdvertisingSet#setPeriodicAdvertisingParameters} + * indicating result of the operation. + * + * @param advertisingSet The advertising set. + * @param status Status of the operation. + */ + public void + onPeriodicAdvertisingParametersUpdated(AdvertisingSet advertisingSet, + int status) {} + + /** + * Callback triggered in response to {@link AdvertisingSet#setPeriodicAdvertisingData} + * indicating result of the operation. + * + * @param advertisingSet The advertising set. + * @param status Status of the operation. + */ + public void onPeriodicAdvertisingDataSet(AdvertisingSet advertisingSet, + int status) {} + + /** + * Callback triggered in response to {@link AdvertisingSet#periodicAdvertisingEnable} + * indicating result of the operation. + * + * @param advertisingSet The advertising set. + * @param status Status of the operation. + */ + public void onPeriodicAdvertisingEnable(AdvertisingSet advertisingSet, boolean enable, + int status) {} +}
\ No newline at end of file |