IPolicyEngine Interface

Definition

This class provides an interface for all engine functions.

public interface IPolicyEngine : IDisposable
type IPolicyEngine = interface
    interface IDisposable
Public Interface IPolicyEngine
Implements IDisposable
Implements

Properties

ClassificationScheme

Gets the tenant-selected algorithm that the Microsoft Classification Engine will apply and the type of results to expect

CustomSettings

The custom policy settings. set by the tenant admin.

DefaultSensitivityLabel

Gets the default sensitivity label.

HasClassificationRules

Gets if the policy has automatic or recommendation rules.

IsLabelingRequired

Checks whether or not the policy dictates that a document must be labeled.

LastPolicyFetchTime

Provide the time when the policy was last fetched.

MoreInfoUrl

Provide a url for looking up more information regarding the policy/labels.

PolicyDataXml

Gets policy data XML which describes the settings, labels, and rules associated with this policy

PolicyFileId

Provide the policy file ID.

SensitivityLabels

List the sensitivity labels associated with the policy engine.

SensitivityTypes

List the sensitivity types associated with the policy engine.

SensitivityTypesDataXml

Gets sensitivity types data XML which describes the sensitivity types associated with this policy

SensitivityTypesFileId

Provide the sensitivity types file ID.

Settings

Get the policy engine Settings.

TenantId

Gets tenant ID

WxpMetadataVersion

Gets the recommended WXP (Windows, Excel, Powerpoint) metadata version, currently 0 for old verion 1 for co-authoring enabled version.

Methods

CreatePolicyHandler(Boolean)

Create a Policy Handler to execute policy related functions on a file's execution state

GetDefaultSensitivityLabel(String)

Gets the default sensitivity label.

GetLabelById(String)

Gets the label according to the provided id.

HasClassificationRules(String[])

Gets if the policy has automatic or recommendation rules.

HasWorkloadConsent(Workload)

Checks workload consent

IsDowngradeJustificationRequired()

Checks whether or not the policy dictates a justification for downgrade operations is required.

IsLabelingRequired(String)

Checks whether or not the policy dictates that a document must be labeled.

ListSensitivityLabels(String[])

List the sensitivity labels associated with the policy engine.

SendApplicationAuditEvent(String, String, String)

Logs an application specific event to the audit pipeline.

Applies to