API
Methods for interacting with system preferences in a ToDesktop application.
This package exposes a number of methods for interacting with system preferences in a ToDesktop application.
| Function | Description |
|---|---|
| askForMediaAccess(type) | |
| getMediaAccessStatus(type) |
Signature:
Electron Developers import { systemPreferences } from "@todesktop/client-core"
systemPreferences.askForMediaAccess(type: MediaTypeCommon): Promise<boolean>;
| Parameter | Type | Description |
|---|---|---|
| type | MediaTypeCommon |
Returns:
Promise<boolean>
Signature:
import { systemPreferences } from "@todesktop/client-core"
systemPreferences.getMediaAccessStatus(type: MediaTypeCommon | "screen"): Promise<AccessStatus>;
| Parameter | Type | Description |
|---|---|---|
| type | MediaTypeCommon | "screen" |
Returns:
Promise<AccessStatus>
Signature:
export declare type AccessStatus = "not-determined" | "granted" | "denied" | "restricted" | "unknown";
Signature:
export declare type MediaTypeCommon = "microphone" | "camera";
| Type Alias | Description |
|---|---|
| AccessStatus | |
| MediaTypeCommon |