Class RoleInfo

The RoleInfo class provides the Entity Layer Role object.

Inheritance

System.Object

BaseEntityInfo

RoleInfo

UserRoleInfo

Implements

IHydratable

IXmlSerializable

IPropertyAccess

Inherited Members

BaseEntityInfo.CreatedByUserID

BaseEntityInfo.CreatedOnDate

BaseEntityInfo.LastModifiedByUserID

BaseEntityInfo.LastModifiedOnDate

BaseEntityInfo.CreatedByUser(Int32)

BaseEntityInfo.LastModifiedByUser(Int32)

BaseEntityInfo.FillInternal(IDataReader)

BaseEntityInfo.CloneBaseProperties(BaseEntityInfo, BaseEntityInfo)

Namespace: DotNetNuke.Security.Roles

Assembly: DotNetNuke.dll

Syntax

public class RoleInfo : BaseEntityInfo, IHydratable, IXmlSerializable, IPropertyAccess

Constructors

| Improve this Doc View Source

RoleInfo()

Initializes a new instance of the RoleInfo class.

Declaration

public RoleInfo()

Properties

| Improve this Doc View Source

AutoAssignment

Gets or sets a value indicating whether gets and sets whether users are automatically assigned to the role.

Declaration

public bool AutoAssignment { get; set; }

Property Value

Type	Description
System.Boolean	A boolean (True/False).

| Improve this Doc View Source

BillingFrequency

Gets or sets and sets the Billing Frequency for the role.

Declaration

public string BillingFrequency { get; set; }

Property Value

Type	Description
System.String	A String representing the Billing Frequency of the Role.

| Improve this Doc View Source

BillingPeriod

Gets or sets and sets the length of the billing period.

Declaration

public int BillingPeriod { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the length of the billing period.

| Improve this Doc View Source

Cacheability

Gets the cache level for property access.

Declaration

public CacheLevel Cacheability { get; }

Property Value

Type	Description
CacheLevel

| Improve this Doc View Source

Description

Gets or sets an sets the Description of the Role.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	A string representing the description of the role.

| Improve this Doc View Source

IconFile

Gets or sets and sets the Icon File for the role.

Declaration

public string IconFile { get; set; }

Property Value

Type	Description
System.String	A string representing the Icon File for the role.

| Improve this Doc View Source

IsPublic

Gets or sets a value indicating whether gets and sets whether the role is public.

Declaration

public bool IsPublic { get; set; }

Property Value

Type	Description
System.Boolean	A boolean (True/False).

| Improve this Doc View Source

IsSystemRole

Gets or sets a value indicating whether gets whether this role is a system role.

Declaration

public bool IsSystemRole { get; set; }

Property Value

Type	Description
System.Boolean	A boolean representing whether this is a system role such as Administrators, Registered Users etc.

| Improve this Doc View Source

KeyID

Gets or sets and sets the Key ID.

Declaration

public virtual int KeyID { get; set; }

Property Value

Type	Description
System.Int32	An Integer.

| Improve this Doc View Source

PhotoURL

Declaration

public string PhotoURL { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PortalID

Gets or sets and sets the Portal Id for the Role.

Declaration

public int PortalID { get; set; }

Property Value

Type	Description
System.Int32	An Integer representing the Id of the Portal.

| Improve this Doc View Source

RoleGroupID

Gets or sets and sets the RoleGroup Id.

Declaration

public int RoleGroupID { get; set; }

Property Value

Type	Description
System.Int32	An Integer representing the Id of the RoleGroup.

| Improve this Doc View Source

RoleID

Gets or sets and sets the Role Id.

Declaration

public int RoleID { get; set; }

Property Value

Type	Description
System.Int32	An Integer representing the Id of the Role.

| Improve this Doc View Source

RoleName

Gets or sets and sets the Role Name.

Declaration

public string RoleName { get; set; }

Property Value

Type	Description
System.String	A string representing the name of the role.

| Improve this Doc View Source

RoleType

Gets the Role Type.

Declaration

public RoleType RoleType { get; }

Property Value

Type	Description
RoleType	A enum representing the type of the role.

| Improve this Doc View Source

RSVPCode

Gets or sets and sets the RSVP Code for the role.

Declaration

public string RSVPCode { get; set; }

Property Value

Type	Description
System.String	A string representing the RSVP Code for the role.

| Improve this Doc View Source

SecurityMode

Gets or sets and sets whether the role is a security role and can be used in Permission Grids etc.

Declaration

public SecurityMode SecurityMode { get; set; }

Property Value

Type	Description
SecurityMode	A SecurityMode enum.

| Improve this Doc View Source

ServiceFee

Gets or sets and sets the fee for the role.

Declaration

public float ServiceFee { get; set; }

Property Value

Type	Description
System.Single	A single number representing the fee for the role.

| Improve this Doc View Source

Settings

Gets the role settings.

Declaration

public Dictionary<string, string> Settings { get; }

Property Value

Type	Description
Dictionary<System.String, System.String>

| Improve this Doc View Source

Status

Gets or sets and sets the status for the role.

Declaration

public RoleStatus Status { get; set; }

Property Value

Type	Description
RoleStatus	An enumerated value Pending, Disabled, Approved.

| Improve this Doc View Source

TrialFee

Gets or sets and sets the trial fee for the role.

Declaration

public float TrialFee { get; set; }

Property Value

Type	Description
System.Single	A single number representing the trial fee for the role.

| Improve this Doc View Source

TrialFrequency

Gets or sets and sets the Trial Frequency for the role.

Declaration

public string TrialFrequency { get; set; }

Property Value

Type	Description
System.String	A String representing the Trial Frequency of the Role.

| Improve this Doc View Source

TrialPeriod

Gets or sets and sets the length of the trial period.

Declaration

public int TrialPeriod { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the length of the trial period.

| Improve this Doc View Source

UserCount

Gets the number of users in the role.

Declaration

public int UserCount { get; }

Property Value

Type	Description
System.Int32	An integer representing the number of users.

Methods

| Improve this Doc View Source

Fill(IDataReader)

Fills a RoleInfo from a Data Reader.

Declaration

public virtual void Fill(IDataReader dr)

Parameters

Type	Name	Description
IDataReader	dr	The Data Reader to use.

| Improve this Doc View Source

GetProperty(String, String, CultureInfo, UserInfo, Scope, ref Boolean)

Gets a property.

Declaration

public string GetProperty(string propertyName, string format, CultureInfo formatProvider, UserInfo accessingUser, Scope accessLevel, ref bool propertyNotFound)

Parameters

Type	Name	Description
System.String	propertyName	The property name to get.
System.String	format	The format string to format the property with, or `null` to use the default format.
CultureInfo	formatProvider	The format provider (e.g. ) to use.
UserInfo	accessingUser	The user this property belongs to, UserInfo.
Scope	accessLevel	The Scope of the access level for this property.
System.Boolean	propertyNotFound	An out parameter that indicates if the property was not found.

Returns

Type	Description
System.String	A string with the value of the property.

| Improve this Doc View Source

GetSchema()

Gets an XmlSchema for the RoleInfo.

Declaration

public XmlSchema GetSchema()

Returns

Type	Description
XmlSchema

| Improve this Doc View Source

ReadXml(XmlReader)

Reads a RoleInfo from an XmlReader.

Declaration

public void ReadXml(XmlReader reader)

Parameters

Type	Name	Description
XmlReader	reader	The XmlReader to use.

| Improve this Doc View Source

WriteXml(XmlWriter)

Writes a RoleInfo to an XmlWriter.

Declaration

public void WriteXml(XmlWriter writer)

Parameters

Type	Name	Description
XmlWriter	writer	The XmlWriter to use.

Implements

IHydratable

IXmlSerializable

IPropertyAccess

Extension Methods

JsonExtensionsWeb.ToJson(Object)