Skip to content

adds a new tile in homepage to point to fsdk docs #480

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

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

adds a new tile in homepage to point to fsdk docs #480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f5168e
adds a new tile in homepage to point to fsdk docs
jiteshsingh Feb 1, 2023
35606e3
Merge branch 'develop' into FND-1486/FND-1501
jiteshsingh Feb 6, 2023
37496a7
updates DeviceSDK UsbPermissionsManager API doc with api migration no…
jiteshsingh Feb 7, 2023
7e9b375
Merge branch 'FND-1486/FND-1501' of github.com:esper-io/dev-docs into…
jiteshsingh Feb 7, 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
14 changes: 14 additions & 0 deletions docs/.vuepress/components/Homepage.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,20 @@
<p class="homepage__text">Esper tool for provisioning</p>
</a>

<a
href="https://fsdk-api.esper.io/"
class="homepage__links__section__item homepage__links__section__item2"
>
<div style="padding-bottom: 1rem">
<img
class="no-shadow homepage_image_icon"
src="./icons/ApiReferenceIcon.svg"
alt="api"
>
</div>
<div class="homepage__a">Foundation SDK Reference</div>
<p class="homepage__text">API documentation</p>
</a>
<a
href="/home/guides"
class="homepage__links__section__item homepage__links__section__item2"
Expand Down
100 changes: 4 additions & 96 deletions docs/home/devicesdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1314,105 +1314,13 @@ sdk.clearUsbDeviceWhitelistForPackage(
});
```

### Get USB Permission Manager
### USB Permission Manager

Returns an instance of `UsbPermissionManager` which can be used for granting or denying USB device/accessory access permissions to packages.

:::warning Requirements
Only available for x86, x86_64 and arm64 GSI devices running Esper Foundation for Android.
:::

**Usage**
____

```java
sdk.getUsbPermissionManager(new EsperDeviceSDK.Callback<UsbPermissionManager>() {
@Override
public void onResponse(@Nullable UsbPermissionManager usbPermissionManager) {
// use UsbPermissionManager to perform needed actions
}

@Override
public void onFailure(Throwable t) {
Log.e(TAG, "onFailure: ", t);
showFailureResult(t);
}
});
```

### About the UsbPermissionManager

Compared to the default permission manager of Android, this one can persist permissions across package re-installations, as this one uses the package name instead of UID.

Here it is possible to grant or deny access for all USB devices and accessories to a package in one go, instead of the default one that operates on individual device identifiers.

:::tip
Unless explicitly granted, permissions are considered denied by default.
:::tip API Migrated
Esper Foundation APIs are now available under a dedicated SDK named **Foundation SDK**.
For setup and migrating to the same, refer [Foundation API Reference](https://fsdk-api.esper.io/)
:::

### Check USB Access Permissions for an App

Check the USB's access permissions for an app.

**Parameters**
___
| Parameter | Data Type | Description |
|-------------|-------------------------|--------------------------------------------------------------------------------|
| packageName | String | The package name of the application. |


**Responses**
_____
| Response | Data Type | Description |
|----------|-----------|--------------------------------------------------|
| true | Boolean | Success |
| false | Boolean | Failure |

**Usage**
____

```java
try {
boolean granted = usbPermissionManager.isAccessGranted("com.example.app");
} catch (EsperSdkException t) {
Log.e(TAG, "onFailure: ", t);
showFailureResult(t);
}
```

### Grant or Deny USB Access Permissions for an App

Grant or deny USB access permissions for an app.

**Parameter**
___
| Parameter | Data Type | Description |
|-------------|-------------------------|--------------------------------------------------------------------------------|
| packageName | String | The package name of the application. |


**Responses**
_____
| Response | Data Type | Description |
|----------|-----------|--------------------------------------------------|
| true | Boolean | Success |
| false | Boolean | Failure |

The example shown below will grant permissions to the app identified with package name <code>com.example.app</code>. Grant status <code>false</code> will deny the permission.

Once granted via here, the apps no more need to request for permission via <code> ACTION_USB_PERMISSION </code> intent.

**Usage**
___

```java
try {
usbPermissionManager.setAccessGranted("com.example.app", true);
} catch (EsperSdkException t) {
Log.e(TAG, "onFailure: ", t);
showFailureResult(t);
}
```

### Turn Wifi/Bluetooth for the Device to On/Off

Expand Down