no.nordicsemi.android.ble

Class SetValueRequest

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.SimpleRequest

no.nordicsemi.android.ble.SetValueRequest

public final class SetValueRequest
extends SimpleRequest

Field Summary

Fields inherited from class no.nordicsemi.android.ble.Request

handler, requestHandler

Method Summary

Modifier and Type	Method and Description
SetValueRequest	allowLongRead(boolean longReadSupported) Sets whether Long Read procedure is supported by the remote device on the given characteristic or descriptor.
SetValueRequest	before(BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
SetValueRequest	done(SuccessCallback callback) Use to set a completion callback.
SetValueRequest	fail(FailCallback callback) Use to set a callback that will be called in case the request has failed.
SetValueRequest	invalid(InvalidRequestCallback callback) Use to set a callback that will be called in case the request was invalid, for example called before the device was connected.
SetValueRequest	setHandler(android.os.Handler handler) Sets the handler that will be used to invoke callbacks.

Methods inherited from class no.nordicsemi.android.ble.SimpleRequest

await

Methods inherited from class no.nordicsemi.android.ble.Request

createBond, enqueue, newConnectionPriorityRequest, newDisableBatteryLevelNotificationsRequest, newDisableIndicationsRequest, newDisableNotificationsRequest, newEnableBatteryLevelNotificationsRequest, newEnableIndicationsRequest, newEnableNotificationsRequest, newMtuRequest, newReadBatteryLevelRequest, newReadPhyRequest, newReadRequest, newReadRequest, newReadRssiRequest, newRefreshCacheRequest, newSetPreferredPhyRequest, newSleepRequest, newWaitForIndicationRequest, newWaitForNotificationRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, removeBond

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setHandler

@NonNull
public SetValueRequest setHandler(@NonNull
                                            android.os.Handler handler)

Description copied from class: Request

Sets the handler that will be used to invoke callbacks. By default, the handler set in BleManager will be used.

Overrides:

setHandler in class Request

Parameters:

handler - The handler to invoke callbacks for this request.

Returns:

The request.

done

@NonNull
public SetValueRequest done(@NonNull
                                      SuccessCallback callback)

Description copied from class: Request

Use to set a completion callback. The callback will be invoked when the operation has finished successfully unless the request was executed synchronously, in which case this callback will be ignored.

Overrides:

done in class Request

Parameters:

callback - the callback.

Returns:

The request.

fail

@NonNull
public SetValueRequest fail(@NonNull
                                      FailCallback callback)

Description copied from class: Request

Use to set a callback that will be called in case the request has failed. If the target device wasn't set before executing this request (BleManager.connect(BluetoothDevice) was never called), the Request.invalid(InvalidRequestCallback) will be used instead, as the BluetoothDevice is not known.

This callback will be ignored if request was executed synchronously, in which case the error will be returned as an exception.

Overrides:

fail in class Request

Parameters:

callback - the callback.

Returns:

The request.

invalid

@NonNull
public SetValueRequest invalid(@NonNull
                                         InvalidRequestCallback callback)

Description copied from class: Request

Use to set a callback that will be called in case the request was invalid, for example called before the device was connected. This callback will be ignored if request was executed synchronously, in which case the error will be returned as an exception.

Overrides:

invalid in class Request

Parameters:

callback - the callback.

Returns:

The request.

before

@NonNull
public SetValueRequest before(@NonNull
                                        BeforeCallback callback)

Description copied from class: Request

Sets a callback that will be executed before the execution of this operation starts.

Overrides:

before in class Request

Parameters:

callback - the callback.

Returns:

The request.

allowLongRead

@NonNull
public SetValueRequest allowLongRead(boolean longReadSupported)

Sets whether Long Read procedure is supported by the remote device on the given characteristic or descriptor. If set to false, the given data will be truncated to match MTU. Otherwise (default) will only be truncated to fit in the maximum Long Read length, that is 512 bytes.

Parameters:

longReadSupported - whether Long Read procedure is supported on the remote device on the given characteristic or descriptor.

Returns:

The request.