Package 

Class ReadRequest

    • Method Summary

      Modifier and Type Method Description
      ReadRequest setHandler(@Nullable() Handler handler) Sets the handler that will be used to invoke callbacks.
      ReadRequest done(@NonNull() SuccessCallback callback) Use to set a completion callback.
      ReadRequest fail(@NonNull() FailCallback callback) Use to set a callback that will be called in case the request has failed.
      ReadRequest 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.
      ReadRequest before(@NonNull() BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
      ReadRequest then(@NonNull() AfterCallback callback) Sets a callback that will be executed when the request has been processed, no matterthe request result.
      ReadRequest with(@NonNull() DataReceivedCallback callback) Sets the value callback.
      ReadRequest filter(@NonNull() DataFilter filter) Sets a filter which allows to skip some incoming data.
      ReadRequest filterPacket(@NonNull() PacketFilter filter) Sets a packet filter which allows to ignore the complete packet.
      ReadRequest merge(@NonNull() DataMerger merger) Adds a merger that will be used to merge multiple packets into a single Data.The merger may modify each packet if necessary.
      ReadRequest merge(@NonNull() DataMerger merger, @NonNull() ReadProgressCallback callback) Adds a merger that will be used to merge multiple packets into a single Data.The merger may modify each packet if necessary.
      <E extends ProfileReadResponse> E awaitValid(@NonNull() Class<E> responseClass) Same as await, but if the response class extends ProfileReadResponse and the received response is not valid(isValid returns false), this method willthrow an exception.
      <E extends ProfileReadResponse> E awaitValid(@NonNull() E response) Same as await, but if the response class extends ProfileReadResponse and the received response is not valid(isValid returns false), this method willthrow an exception.

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

        await, await, with

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

        await

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

        before, createBond, done, enqueue, 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() ReadRequest 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() ReadRequest 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() ReadRequest 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() ReadRequest 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() ReadRequest with(@NonNull() DataReceivedCallback 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.

      • filter

        @NonNull() ReadRequest filter(@NonNull() DataFilter filter)

        Sets a filter which allows to skip some incoming data.

        This filter filters each received packet before they are given to the data merger.To filter the complete packet after merging, use filterPacket instead.

        Parameters:
        filter - the data filter.

      • filterPacket

        @NonNull() ReadRequest filterPacket(@NonNull() PacketFilter filter)

        Sets a packet filter which allows to ignore the complete packet.

        This filter differs from the filter, as it checks the completepacket, after it has been merged. If there is not merger set, this does the same asthe data filter.

        Parameters:
        filter - the packet filter.