Table of Contents

Class BizFormRoleInfoProvider

Namespace
CMS.OnlineForms
Assembly
CMS.OnlineForms.dll

Class providing BizFormRoleInfo management.

[ProviderInterface(typeof(IBizFormRoleInfoProvider))]
public class BizFormRoleInfoProvider : AbstractInfoProvider<BizFormRoleInfo, BizFormRoleInfoProvider>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<BizFormRoleInfo>, IInfoByIdProvider<BizFormRoleInfo>, IInfoByGuidProvider<BizFormRoleInfo>, IInfoByNameProvider<BizFormRoleInfo>, IBulkInfoProvider<BizFormRoleInfo>, IBizFormRoleInfoProvider, IInfoProvider<BizFormRoleInfo>
Inheritance
object
BizFormRoleInfoProvider
Implements
Inherited Members
Extension Methods

Methods

Add(int, int)

Creates BizFormRoleInfo binding.

[Obsolete("Create a new BizFormRoleInfo with specified RoleID and FormID and use Set(BizFormRoleInfo) instead.")]
[ObsoleteSince(28, 4)]
public virtual void Add(int roleId, int formId)

Parameters

roleId int

Role ID.

formId int

Form ID.

Get(int, int)

Gets an instance of the BizFormRoleInfo binding structure.

[Obsolete("Use Get() and parametrized ObjectQuery to get the BizFormRoleInfo with specified RoleID and FormID.")]
[ObsoleteSince(28, 4)]
public virtual BizFormRoleInfo Get(int roleId, int formId)

Parameters

roleId int

Role ID.

formId int

Form ID.

Returns

BizFormRoleInfo

Returns an instance of BizFormRoleInfo corresponding to given identifiers or null.

GetAsync(int, int, CancellationToken?)

Asynchronously gets an instance of the BizFormRoleInfo binding structure.

[Obsolete("Use Get() and parametrized ObjectQuery to get the BizFormRoleInfo with specified RoleID and FormID.")]
[ObsoleteSince(28, 4)]
public virtual Task<BizFormRoleInfo> GetAsync(int roleId, int formId, CancellationToken? cancellationToken = null)

Parameters

roleId int

Role ID.

formId int

Form ID.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<BizFormRoleInfo>

Returns a task returning either an instance of BizFormRoleInfo corresponding to given identifiers or null.

Remove(int, int)

Deletes BizFormRoleInfo binding.

[Obsolete("Get the BizFormRoleInfo with specified RoleID and FormID using Get() and delete the binding using Delete(BizFormRoleInfo).")]
[ObsoleteSince(28, 4)]
public virtual void Remove(int roleId, int formId)

Parameters

roleId int

Role ID.

formId int

Form ID.

RemoveAllRolesFromForm(int)

Removes all allowed roles from the form.

public static void RemoveAllRolesFromForm(int formId)

Parameters

formId int

Form ID

RemoveAllRolesFromFormInternal(int)

Removes all allowed roles from the form.

protected virtual void RemoveAllRolesFromFormInternal(int formId)

Parameters

formId int

Form ID