Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for SetScreenTimeout and PowerOff #495

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Documentation for SetScreenTimeout and PowerOff #495

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ba92f1
added doc
swapnil-esper Mar 1, 2023
2a02f83
Added Constants. for SetScreenTimeout
swapnil-esper Mar 1, 2023
7c93bf4
Changed functionCall parameter
swapnil-esper Mar 1, 2023
0eb753e
Changed version and release name
swapnil-esper Mar 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions docs/home/devicesdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

The Esper Device SDK uses an API to conduct operations on Esper-managed devices. Use the Device SDK to develop apps that perform operations or retrieve data from your device fleet. We now use AndroidX libraries (androidx.core-core-ktx version 1.5.0 stable) as dependencies which reduces compile time.

Current version: **v2.1.7787.21**
Current version: **v2.2.3663.24**

Release name: **SUNFYRE_V8**
Release name: **SILVERWING**

Table of Contents:

Expand Down Expand Up @@ -40,6 +40,7 @@ Table of Contents:
* [Update Existing APN Config](#update-existing-apn-config)
* [Install an APK from a Public Folder](#install-an-apk-from-a-public-folder)
* [Power Off the Device](#power-off-the-device)
* [Set Screen Timeout](#set-screen-timeout)

## SDK Setup

Expand Down Expand Up @@ -1491,7 +1492,7 @@ sdk.installApp(packageName, apkPath, new EsperDeviceSDK.Callback<Boolean>() {
Use this method to power off the device.

:::warning Requirements
This method is only available for Knox-supported devices & CSDK-supported devices.
This method is only available for devices with support for Knox/CSDK/Supervisor plugin.
:::

**Usage**
Expand All @@ -1513,4 +1514,28 @@ sdk.powerOff(new EsperDeviceSDK.Callback<Boolean>() {
});
```

### Set Screen Timeout
Use this method to set the screen timeout for the device.

**Parameters**
___
| Parameter | Data Type | Description |
|-------------|-------------------------|--------------------------------------------------------------------------------|
| timeoutInMills | int | One of the following: <ul><li>Constants.FIVE_SECS</li> <li>Constants.FIFTEEN_SECS</li> <li>Constants.THIRTY_SECS</li> <li>Constants.FORTY_FIVE_SECS</li> <li>Constants.ONE_MIN</li> <li>Constants.TWO_MIN</li> <li>Constants.FIVE_MIN</li> <li>Constants.TEN_MIN</li> <li>Constants.ONE_HOUR</li> <li>Constants.TWO_HOUR</li> <li>Constants.NEVER</li></ul> |
| ```EsperDeviceSDK.Callback``` | callback | The callback implemented once the callback succeeds. |

**Usage**
___

```java
sdk.setScreenTimeOut(Constants.TWO_MIN, new EsperDeviceSDK.Callback<Boolean>() {
@Override
public void onResponse(@Nullable Boolean response) {
Log.d(TAG, "screen timeout to " + timeout + " is success : " + response);
}
@Override
public void onFailure(Throwable t) {
Log.d(TAG, "Screen Timeout change failed", t);
}
});
```