Package 

Class SleepRequest

    • Method Summary

      Modifier and Type Method Description
      SleepRequest setHandler(@Nullable() Handler handler) Sets the handler that will be used to invoke callbacks.
      SleepRequest done(@NonNull() SuccessCallback callback) Use to set a completion callback.
      SleepRequest fail(@NonNull() FailCallback callback) Use to set a callback that will be called in case the request has failed.
      SleepRequest 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.
      SleepRequest before(@NonNull() BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
      SleepRequest then(@NonNull() AfterCallback callback) Sets a callback that will be executed when the request has been processed, no matterthe request result.
      SleepRequest timeout(@IntRange(from = 0) long timeout) Sets the operation timeout.

      • 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() SleepRequest 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() SleepRequest 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() SleepRequest 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() SleepRequest 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.

      • timeout

        @NonNull() SleepRequest timeout(@IntRange(from = 0) long timeout)

        Sets the operation timeout.When the timeout occurs, the request will fail with REASON_TIMEOUT.

        Parameters:
        timeout - the request timeout in milliseconds, 0 to disable timeout.