PermissionDefinition

Record in Oadm.Sdk.Plugins · Oadm.Sdk.dll

A right an administrator gives or takes per role on the Users page (the permission matrix). A plugin declares its own through ICorePlugin.Permissions or ITaskPlugin.Permissions; the host stores them as “<plugin id>:<key>” (core plugins) and “task:<task plugin id>:<key>” (task plugins), so keys only have to be unique within the plugin.

public sealed record PermissionDefinition(string Key, string Name, string Description)

Guide: Task plugins

Parameters

Key: Letters and digits, starting with a letter, at most 32 characters (“send”, “rollout”).
Name: What the role may do, short, for the matrix row (“Send VAPIX commands”).
Description: One sentence that explains it, shown in the row’s info icon.

Properties

Description

string Description { get; init; }

One sentence that explains it, shown in the row’s info icon.

FullDeviceControl

bool FullDeviceControl { get; init; }

The permission gives full control of the devices (it acts with their stored login, e.g. Web View, user accounts on the devices): the matrix marks it with a warning icon.

Key

string Key { get; init; }

Letters and digits, starting with a letter, at most 32 characters (“send”, “rollout”).

Name

string Name { get; init; }

What the role may do, short, for the matrix row (“Send VAPIX commands”).

OperatorDefault

bool OperatorDefault { get; init; }

Whether the built-in Operator role gets it when the permission first appears. Default true.

ViewerDefault

bool ViewerDefault { get; init; }

Whether the built-in Viewer role (sees, changes nothing) gets it when it first appears. Default false.