requestPermission

requestPermission(permission: string, desc?: string): Promise<number>;

• Promise<number>: user choice, where 0 means “don’t allow”, 1 means “allow this time only”, 2 means “always allow”, and -1 means the user closed the dialog without choosing (treated as “don’t allow”; the dialog will show again on the next call)

• The host may show a permission dialog for the user to choose among “Allow this time only / Always allow / Don’t allow” (the dialog defaults to “Allow this time only”)
• desc customizes only the description shown in the “don’t allow” dialog. It does not change the permission status or the user’s choice options.
• “Allow this time only” is valid only for the current plugin session and is revoked when the plugin exits or is closed. Only “Always allow” is persisted and remains valid after restarting the plugin. See How to Request Permissions

• Throws a parameter validation error when permission is not a non-empty string or desc is provided with a non-string value
• Throws an error when permission is not in the supported list (error code 1502)
• Throws an error when the plugin has not declared this permission in uses-permissions in PluginConfig.json (error code 1500)

​

Example

import { PluginManager } from 'sn-plugin-lib';

/**
 * Example: request internet permission.
 */
export async function exampleRequestPermission() {
  const permission = 'plugin.permission.INTERNET';
  const desc = 'Internet access is required to sync plugin data.';
  const result = await PluginManager.requestPermission(permission, desc);
  return result;
}