Class CheckPermission

Checks the permission based on the provided settings.

Param: options

The options for checking permissions.

Param: options.permissionType

The type of permission to check. Can be "audioSetting", "videoSetting", "screenshareSetting", or "chatSetting".

Param: options.audioSetting

The setting for audio permission. Can be "allow", "approval", or other.

Param: options.videoSetting

The setting for video permission. Can be "allow", "approval", or other.

Param: options.screenshareSetting

The setting for screenshare permission. Can be "allow", "approval", or other.

Param: options.chatSetting

The setting for chat permission. Can be "allow", "approval", or other.

Returns

  • Returns 0 if the setting is "allow", 1 if the setting is "approval", and 2 for other settings or invalid permission types.

Throws

Will throw an error if an unexpected error occurs during the permission check.

Example

const options = {
  permissionType: 'videoSetting',
  audioSetting: 'allow',
  videoSetting: 'approval',
  screenshareSetting: 'deny',
  chatSetting: 'allow',
};

const result = await checkPermissionService.checkPermission(options);
console.log(result);
// Output: 1 (since videoSetting is 'approval')

Constructors

constructor

Methods

checkPermission

Constructors

constructor

Methods

checkPermission

  • checkPermission(options): Promise<number>

  • Checks the permission based on the provided settings.

    Parameters

    Returns Promise<number>

    • Returns 0 if the setting is "allow", 1 if the setting is "approval", and 2 for other settings or invalid permission types.

    Throws

    Will throw an error if an unexpected error occurs during the permission check.

Settings

Member Visibility

On This Page

Constructors
Methods