Package 

Class WaitForReadRequest

    • Method Summary

      Modifier and Type Method Description
      WaitForReadRequest setHandler(@Nullable() Handler handler) Sets the handler that will be used to invoke callbacks.
      WaitForReadRequest done(@NonNull() SuccessCallback callback) Use to set a completion callback.
      WaitForReadRequest fail(@NonNull() FailCallback callback) Use to set a callback that will be called in case the request has failed.
      WaitForReadRequest invalid(@NonNull() InvalidRequestCallback callback) Use to set a callback that will be called in case the request was invalid, for examplecalled before the device was connected.This callback will be ignored if request was executed synchronously, in which casethe error will be returned as an exception.
      WaitForReadRequest before(@NonNull() BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
      WaitForReadRequest then(@NonNull() AfterCallback callback) Sets a callback that will be executed when the request has been processed, no matterthe request result.
      WaitForReadRequest with(@NonNull() DataSentCallback callback) Sets the value callback.
      WaitForReadRequest trigger(@NonNull() Operation trigger) Sets an optional request that is suppose to trigger the notification or indication.This is to ensure that the characteristic value won't change before the callback was set.
      WaitForReadRequest split(@NonNull() DataSplitter splitter) Adds a splitter that will be used to cut given data into multiple packets.The splitter may modify each packet if necessary, i.e.
      WaitForReadRequest split(@NonNull() DataSplitter splitter, @NonNull() WriteProgressCallback callback) Adds a splitter that will be used to cut given data into multiple packets.The splitter may modify each packet if necessary, i.e.
      WaitForReadRequest split() Adds a default MTU splitter that will be used to cut given data into at-most MTU-3bytes long packets.
      WaitForReadRequest split(@NonNull() WriteProgressCallback callback) Adds a default MTU splitter that will be used to cut given data into at-most MTU-3bytes long packets.

      • Methods inherited from class no.nordicsemi.android.ble.AwaitingRequest

        await, trigger

      • Methods inherited from class no.nordicsemi.android.ble.TimeoutableValueRequest

        await, await, await, timeout, with

      • Methods inherited from class no.nordicsemi.android.ble.TimeoutableRequest

        await, await, cancel, enqueue, enqueue, isCancelled, setHandler, timeout

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

        before, createBond, done, fail, invalid, 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, setHandler, then

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • setHandler

        @NonNull() WaitForReadRequest setHandler(@Nullable() Handler handler)

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

        If set to null, the callbacks will be invoked immediately on the BLE looper.

        Parameters:
        handler - The handler to invoke callbacks for this request.

      • done

        @NonNull() WaitForReadRequest done(@NonNull() SuccessCallback callback)

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

        Parameters:
        callback - the callback.

      • fail

        @NonNull() WaitForReadRequest fail(@NonNull() FailCallback callback)

        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(connect was never called), the invalid will be used instead, as the BluetoothDevice is not known.

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

        Parameters:
        callback - the callback.

      • invalid

        @NonNull() WaitForReadRequest invalid(@NonNull() InvalidRequestCallback callback)

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

        Parameters:
        callback - the callback.

      • with

        @NonNull() WaitForReadRequest with(@NonNull() DataSentCallback callback)

        Sets the value callback. When the request is invoked synchronously, this callback willbe ignored and the received value will be returned by the await(...) method;

        Parameters:
        callback - the callback.

      • trigger

        @NonNull() WaitForReadRequest trigger(@NonNull() Operation trigger)

        Sets an optional request that is suppose to trigger the notification or indication.This is to ensure that the characteristic value won't change before the callback was set.

        Parameters:
        trigger - the operation that triggers the notification, usually a write characteristicrequest that write some OP CODE.

      • split

        @NonNull() WaitForReadRequest split(@NonNull() DataSplitter splitter)

        Adds a splitter that will be used to cut given data into multiple packets.The splitter may modify each packet if necessary, i.e. add a flag indicating first packet,continuation or the last packet.

        Parameters:
        splitter - an implementation of a splitter.

      • split

        @NonNull() WaitForReadRequest split(@NonNull() DataSplitter splitter, @NonNull() WriteProgressCallback callback)

        Adds a splitter that will be used to cut given data into multiple packets.The splitter may modify each packet if necessary, i.e. add a flag indicating first packet,continuation or the last packet.

        Parameters:
        splitter - an implementation of a splitter.
        callback - the progress callback that will be notified each time a packet was sent.