Class IRMSettings

Declares the Information Rights Management settings for the list or library.

Inheritance
System.Object
BaseModel
IRMSettings
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class IRMSettings : BaseModel, IProvisioningTemplateDescendant

Properties

AllowPrint

Defines whether a viewer can print the downloaded document.

Declaration
public Boolean AllowPrint { get; set; }
Property Value
Boolean

AllowScript

Defines whether a viewer can run a script on the downloaded document.

Declaration
public Boolean AllowScript { get; set; }
Property Value
Boolean

AllowWriteCopy

Defines whether a viewer can write on a copy of the downloaded document.

Declaration
public Boolean AllowWriteCopy { get; set; }
Property Value
Boolean

DisableDocumentBrowserView

Defines whether to block Office Web Application Companion applications (WACs) from showing this document.

Declaration
public Boolean DisableDocumentBrowserView { get; set; }
Property Value
Boolean

DocumentAccessExpireDays

Defines the number of days after which the downloaded document will expire.

Declaration
public Int32 DocumentAccessExpireDays { get; set; }
Property Value
Int32

DocumentLibraryProtectionExpiresInDays

Defines the expire days for the Information Rights Management (IRM) protection of this document library will expire.

Declaration
public Int32 DocumentLibraryProtectionExpiresInDays { get; set; }
Property Value
Int32

Enabled

Defines whether the IRM settings have to be enabled or not.

Declaration
public Boolean Enabled { get; set; }
Property Value
Boolean

EnableDocumentAccessExpire

Defines whether the downloaded document will expire.

Declaration
public Boolean EnableDocumentAccessExpire { get; set; }
Property Value
Boolean

EnableDocumentBrowserPublishingView

Defines whether to enable Office Web Application Companion applications (WACs) to publishing view.

Declaration
public Boolean EnableDocumentBrowserPublishingView { get; set; }
Property Value
Boolean

EnableGroupProtection

Defines whether the permission of the downloaded document is applicable to a group.

Declaration
public Boolean EnableGroupProtection { get; set; }
Property Value
Boolean

EnableLicenseCacheExpire

Defines whether a user must verify their credentials after some interval.

Declaration
public Boolean EnableLicenseCacheExpire { get; set; }
Property Value
Boolean

GroupName

Defines the group name (email address) that the permission is also applicable to.

Declaration
public String GroupName { get; set; }
Property Value
String

LicenseCacheExpireDays

Defines the number of days that the application that opens the document caches the IRM license. When these elapse, the application will connect to the IRM server to validate the license.

Declaration
public Int32 LicenseCacheExpireDays { get; set; }
Property Value
Int32

PolicyDescription

Defines the permission policy description.

Declaration
public String PolicyDescription { get; set; }
Property Value
String

PolicyTitle

Defines the permission policy title.

Declaration
public String PolicyTitle { get; set; }
Property Value
String

Methods

Equals(IRMSettings)

Compares IRMSettings object based on Enabled, AllowPrint, AllowScript, AllowWriteCopy, DisableDocumentBrowserView, DocumentAccessExpireDays, DocumentLibraryProtectionExpiresInDays, EnableDocumentAccessExpire, EnableDocumentBrowserPublishingView, EnableGroupProtection, EnableLicenseCacheExpire, GroupName, LicenseCacheExpireDays, PolicyDescription, and PolicyTitle

Declaration
public bool Equals(IRMSettings other)
Parameters
IRMSettings other

IRMSettings object
Returns
System.Boolean

true if the IRMSettings object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with ObjectSecurity

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Object that represents ObjectSecurity
Returns
System.Boolean

true if the current object is equal to the ObjectSecurity

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods