• API
Show / Hide Table of Contents
  • BiExcellence.OpenBi.Api
    • IOpenBiConfiguration
    • IOpenBiRequest
    • IOpenBiRequestSerializable
    • IOpenBiResponse
    • IOpenBiServerMessage
    • IOpenBiSession
    • IOpenBiSessionHttpClient
    • MessageCategory
    • OpenBiConfiguration
    • OpenBiConfigurationExtensions
    • OpenBiErrorEventArgs
    • OpenBiRequestEventArgs
    • OpenBiRequestExtensions
    • OpenBiResponseCodes
    • OpenBiResponseEventArgs
    • OpenBiServerErrorException
    • OpenBiSession
    • OpenBiSessionExtensions
    • Protocol
    • SecureOpenBiSession
  • BiExcellence.OpenBi.Api.Commands
    • ContentTypes
    • Filter
    • FilterOperator
    • FilterSign
    • HierarchyNode<T>
    • IFilter
    • IListRequest
    • IListRequest<T>
    • IListResponse
    • IListResponse<T>
    • ILoginInfo
    • IPingInfo
    • ISessionInfo
    • ListRequestExtensions
    • OpenBiLoginExtensions
    • OpenBiPingExtensions
  • BiExcellence.OpenBi.Api.Commands.AuthObjects
    • AuthObject
    • AuthObjectValue
    • IAuthObject
    • IAuthObjectValue
    • OpenBiAuthObjectExtensions
  • BiExcellence.OpenBi.Api.Commands.AuthObjects.Internal
    • AuthObjectJsonImpl
    • AuthObjectValueJsonImpl
  • BiExcellence.OpenBi.Api.Commands.BatchJobs
    • BatchJob
    • BatchJobHandlerParameterType
    • BatchJobParameter
    • BatchJobPeriodicType
    • BatchJobType
    • IBatchJob
    • IBatchJobHandler
    • IBatchJobHandlerParameter
    • IBatchJobLog
    • IBatchJobLogEntry
    • IBatchJobParameter
    • OpenBiBatchJobExtensions
    • OpenBiConfigurationExtensions
  • BiExcellence.OpenBi.Api.Commands.BatchJobs.Internal
    • BatchJobJsonImpl
    • BatchJobParameterJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Blogs
    • Blog
    • BlogArticle
    • IBlog
    • IBlogArticle
    • OpenBiBlogExtensions
  • BiExcellence.OpenBi.Api.Commands.Blogs.Internal
    • BlogArticleJsonImpl
    • BlogJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Cms
    • CmsItemAttributeTypes
    • CmsItemTemplate
    • ICmsItem
    • ICmsItemAttribute
    • ICmsItemDefinition
    • ICmsItemReplacementParameter
    • ICmsItemTemplate
    • ICmsItemTemplateHistory
    • OpenBiCmsExtensions
  • BiExcellence.OpenBi.Api.Commands.Cms.Internal
    • CmsItemTemplateJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Configurator
    • IObjectLock
    • IServerError
    • ITransportTask
    • ITransportTaskElement
    • OpenBiEmailExtensions
    • OpenBiObjectLockExtensions
    • OpenBiServerErrorExtensions
    • OpenBiTransportTaskExtensions
    • TransportTask
    • TransportTaskElement
    • TransportTaskElementActions
    • TransportTaskElementTypes
    • TransportTaskStates
  • BiExcellence.OpenBi.Api.Commands.ConnectionTemplates
    • ConnectionTemplate
    • ConnectionTemplateParameter
    • ConnectionTemplateParameterType
    • DataProviderTypes
    • IConnection
    • IConnectionTemplate
    • IConnectionTemplateParameter
    • IDataProviderType
    • OpenBiConnectionExtensions
    • OpenBiConnectionTemplateExtensions
    • OpenBiRequestExtensions
  • BiExcellence.OpenBi.Api.Commands.ConnectionTemplates.Internal
    • ConnectionTemplateJsonImpl
    • ConnectionTemplateParameterJsonImpl
  • BiExcellence.OpenBi.Api.Commands.DataProviders
    • AffectedDataProvider
    • AffectedDataProviderMode
    • AlertLevel
    • AlertLevelId
    • ChartDataExtensions
    • DataProvider
    • DataProviderCubeType
    • DataProviderDefinition
    • DataProviderExtensions
    • DataProviderRoleType
    • DataProviderView
    • DataProviderViewExtensions
    • DataVisualType
    • Dimension
    • DimensionAxis
    • DimensionSortType
    • DimensionSumState
    • DrillState
    • DrillStateTuple
    • DrillStateValue
    • F4ValueExtensions
    • GridCellContent
    • GridDefinitionEventArgs
    • GridExtensions
    • IAffectedDataProvider
    • IAffectedDataProviderExecuteDefinition
    • IAlertLevel
    • IChartCategory
    • IChartCategoryGroup
    • IChartData
    • IChartGroup
    • IChartPoint
    • IDataComment
    • IDataProvider
    • IDataProviderDefinition
    • IDataProviderNode
    • IDataProviderView
    • IDimension
    • IDimensionAttribute
    • IDimensionAttributes
    • IDimensionGridCell
    • IDimensionHierarchy
    • IDimensions
    • IDrillState
    • IDrillStates
    • IDrillStateTuple
    • IExecuteDefinition
    • IExportDocument
    • IF4Value
    • IF4Values
    • IFilterableInfoObject
    • IFlatF4Value
    • IGrid
    • IGridCell
    • IGridCell<T>
    • IGridData
    • IGridDefinition
    • IHierarchyF4Value
    • IInfoObject
    • IInfoObjects<T>
    • IKeyFigure
    • IKeyFigures
    • InfoObjectDataType
    • InfoObjectsExtensions
    • InfoObjectSortMode
    • IPositionableInfoObject<T>
    • IPositionableInfoObjects<T>
    • ISortableInfoObject
    • ISortTuple
    • ISumGridCell
    • ITuple
    • IUsedConnection
    • IUsedConnections
    • IValueGridCell
    • IVariable
    • IVariables
    • KeyFigure
    • KeyFigureAggregation
    • KeyFigureCalculationTime
    • KeyFigureExtensions
    • OpenBiDataProviderExtensions
    • OpenBiDataProviderViewExtensions
    • OpenBiRequestExtensions
    • SortTuple
    • Variable
    • VariableEntryType
    • VariableSelection
    • VariableType
  • BiExcellence.OpenBi.Api.Commands.DataProviders.Internal
    • DataProviderDefinitionJsonImpl
    • DataProviderUtils
  • BiExcellence.OpenBi.Api.Commands.DatastoreObjects
    • DatastoreObject
    • DatastoreObjectTypes
    • IDatastoreObject
    • OpenBiDatastoreObjectExtensions
  • BiExcellence.OpenBi.Api.Commands.DatastoreObjects.Internal
    • DatastoreObjectJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Downloads
    • Download
    • IDownload
    • OpenBiDownloadExtensions
  • BiExcellence.OpenBi.Api.Commands.Downloads.Internal
    • DownloadJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Entities
    • BaseEntity
    • Entity
    • IBaseEntity
    • IBaseEntityAssignment
    • IEntity
    • OpenBiEntityExtensions
  • BiExcellence.OpenBi.Api.Commands.Entities.Internal
    • BaseEntityJsonImpl
    • EntityJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Files
    • OpenBiSessionFileExtensions
  • BiExcellence.OpenBi.Api.Commands.HostHeaders
    • HostHeader
    • IHostHeader
    • OpenBiHostHeaderExtensions
  • BiExcellence.OpenBi.Api.Commands.HostHeaders.Internal
    • HostHeaderJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Inquiries
    • IInquirer
    • IInquiry
    • IInquiryField
    • OpenBiInquirerExtensions
    • OpenBiInquiryExtensions
  • BiExcellence.OpenBi.Api.Commands.LanguageTexts
    • ILanguageText
    • ILanguageTextValue
    • LanguageText
    • LanguageTextValue
    • OpenBiLanguageTextExtensions
  • BiExcellence.OpenBi.Api.Commands.LanguageTexts.Internal
    • LanguageTextJsonImpl
    • LanguageTextValueJsonImpl
  • BiExcellence.OpenBi.Api.Commands.LicenseInformation
    • ILicenseInformation
    • ILicenseInformationComponent
    • OpenBiLicenseInformationExtensions
  • BiExcellence.OpenBi.Api.Commands.MajaAi
    • IMajaEntity
    • IMajaGrammar
    • IMajaQueryAnswer
    • IMajaTalent
    • IMajaTalentCategory
    • IPossibleUserReply
    • MajaQueryAnswerAction
    • MajaQueryAnswerProposalType
    • News
    • OpenBiMajaExtensions
    • PossibleUserReplyControlType
    • PossibleUserReplyType
    • WeatherDetails
    • WeatherForecast
  • BiExcellence.OpenBi.Api.Commands.MajaAi.Internal
    • MajaGrammarJsonImpl
    • MajaTalentCategoryJsonImpl
    • MajaTalentJsonImpl
  • BiExcellence.OpenBi.Api.Commands.MapDimensions
    • IMapDimension
    • MapDimension
    • OpenBiMapDimensionExtensions
  • BiExcellence.OpenBi.Api.Commands.MapDimensions.Internal
    • MapDimensionJsonImpl
  • BiExcellence.OpenBi.Api.Commands.MasterData
    • IMasterData
    • IMasterDataAttribute
    • IMasterDataAttributes
    • IMasterDataHierarchy
    • IMasterDataHierarchyMemberNode
    • IMasterDataHierarchyNode
    • IMasterDataHierarchyTextNode
    • MasterData
    • MasterDataAttribute
    • MasterDataAttributes
    • MasterDataHierarchy
    • MasterDataHierarchyMemberNode
    • MasterDataHierarchyNodeExtensions
    • MasterDataHierarchyTextNode
    • OpenBiMasterDataExtensions
  • BiExcellence.OpenBi.Api.Commands.Organisations
    • IOrganisation
    • OpenBiOrganisationExtensions
    • Organisation
  • BiExcellence.OpenBi.Api.Commands.Organisations.Internal
    • OrganisationJsonImpl
  • BiExcellence.OpenBi.Api.Commands.RoleContents
    • IRoleContent
    • IRoleContentElement
    • IRoleContentElementCmsContent
    • IRoleContentElementHistory
    • IRoleContentHistory
    • OpenBiRoleContentExtensions
    • RoleContent
    • RoleContentElement
    • RoleContentElementCmsContent
    • RoleContentExtensions
  • BiExcellence.OpenBi.Api.Commands.Roles
    • IRole
    • IRoleAssignment
    • OpenBiRoleExtensions
    • Role
  • BiExcellence.OpenBi.Api.Commands.Roles.Internal
    • RoleAssignmentJsonImpl
    • RoleJsonImpl
  • BiExcellence.OpenBi.Api.Commands.ServerSettings
    • IServerSettingParameter
    • IServerSettingParameters
    • IServerSettings
    • OpenBiServerSettingsExtensions
    • ServerSettingParameter
  • BiExcellence.OpenBi.Api.Commands.TableAttributes
    • BooleanTableAttribute
    • DateTimeTableAttribute
    • DoubleTableAttribute
    • ICustomAttributes
    • IntegerTableAttribute
    • ITableAttribute
    • ITableAttribute<T>
    • ITableAttributeCache
    • ITableAttributes
    • ITableAttributes<T>
    • OpenBiTableAttributeExtensions
    • StringTableAttribute
    • TableAttribute
    • TableAttributeAttribute
    • TableAttributes
    • TableAttributes<T>
  • BiExcellence.OpenBi.Api.Commands.TableAttributes.Internal
    • TableAttributeJsonImpl
    • TableAttributeUtils
  • BiExcellence.OpenBi.Api.Commands.Usergroups
    • IUsergroup
    • IUsergroupAssignment
    • OpenBiUsergroupExtensions
    • Usergroup
  • BiExcellence.OpenBi.Api.Commands.Usergroups.Internal
    • UsergroupAssignmentJsonImpl
    • UsergroupJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Users
    • IUser
    • OpenBiUserExtensions
    • User
  • BiExcellence.OpenBi.Api.Commands.Users.Internal
    • UserJsonImpl
  • BiExcellence.OpenBi.Api.Internal
    • ApiFieldAttribute
    • EnumValueAttribute
    • Utils

Class OpenBiRoleContentExtensions

Extension methods for role contents.

Inheritance
object
OpenBiRoleContentExtensions
Namespace: BiExcellence.OpenBi.Api.Commands.RoleContents
Assembly: BiExcellence.OpenBi.Api.Role.dll
Syntax
public static class OpenBiRoleContentExtensions

Methods

AssignElementToRoleAsync(IOpenBiSession, IRoleContent, IRole, CancellationToken)

Assigns a role content to a role.

Declaration
public static Task AssignElementToRoleAsync(this IOpenBiSession session, IRoleContent rolecontent, IRole role, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

IRoleContent rolecontent

The role content.

IRole role

The role.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task

CreateRoleContentAsync(IOpenBiSession, IRoleContentElement, CancellationToken)

Creates or updates a role content element.

Declaration
public static Task CreateRoleContentAsync(this IOpenBiSession session, IRoleContentElement rolecontent, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

IRoleContentElement rolecontent

The role content.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task

DeleteRoleContentAsync(IOpenBiSession, IRoleContent, CancellationToken)

Deletes a role content.

Declaration
public static Task DeleteRoleContentAsync(this IOpenBiSession session, IRoleContent rolecontent, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

IRoleContent rolecontent

The role content.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task

DeleteRoleContentAsync(IOpenBiSession, string, string?, CancellationToken)

Deletes a role content by id.

Declaration
public static Task DeleteRoleContentAsync(this IOpenBiSession session, string rolecontentId, string? language = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

string rolecontentId

The role content id.

string language

The language.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task

GetContentElementAsync(IOpenBiSession, IRoleContent, CancellationToken)

Returns a role content element for a role content.

Declaration
public static Task<IRoleContentElement?> GetContentElementAsync(this IOpenBiSession session, IRoleContent rolecontent, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

IRoleContent rolecontent

The role content.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<IRoleContentElement>

GetContentElementByIdAsync(IOpenBiSession, string, string?, CancellationToken)

Returns a role content element by its id.

Declaration
public static Task<IRoleContentElement?> GetContentElementByIdAsync(this IOpenBiSession session, string elementId, string? language = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

string elementId

The element id.

string language

The language.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<IRoleContentElement>

GetContentElementHistoryAsync(IOpenBiSession, IRoleContentHistory, CancellationToken)

Returns a role content element history.

Declaration
public static Task<IRoleContentElementHistory> GetContentElementHistoryAsync(this IOpenBiSession session, IRoleContentHistory history, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

IRoleContentHistory history

The role content history.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<IRoleContentElementHistory>

GetContentElementHistoryByIdAsync(IOpenBiSession, string, CancellationToken)

Returns a role content element history by history id.

Declaration
public static Task<IRoleContentElementHistory> GetContentElementHistoryByIdAsync(this IOpenBiSession session, string historyId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

string historyId

The role content element history id.

CancellationToken cancellationToken

The cancellation token

Returns
Type Description
Task<IRoleContentElementHistory>

GetRoleContentAsync(IOpenBiSession, string, string?, CancellationToken)

Returns all role contents for a role.

Declaration
public static Task<IList<IRoleContent>> GetRoleContentAsync(this IOpenBiSession session, string roleId, string? language = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

string roleId

The role id.

string language

The language.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<IList<IRoleContent>>

GetRoleContentHistoryAsync(IOpenBiSession, string, string?, CancellationToken)

Returns role content history.

Declaration
public static Task<IList<IRoleContentHistory>> GetRoleContentHistoryAsync(this IOpenBiSession session, string elementId, string? language = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

string elementId

The role content element id.

string language

The language.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task<IList<IRoleContentHistory>>

RemoveElementFromRoleAsync(IOpenBiSession, IRoleContent, IRole, CancellationToken)

Removes a role content from a role.

Declaration
public static Task RemoveElementFromRoleAsync(this IOpenBiSession session, IRoleContent rolecontent, IRole role, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

IRoleContent rolecontent

The role content.

IRole role

The role.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task

RemoveElementFromRoleAsync(IOpenBiSession, string, string, CancellationToken)

Removes a role content from a role.

Declaration
public static Task RemoveElementFromRoleAsync(this IOpenBiSession session, string rolecontentId, string roleId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.

string rolecontentId

The role content id.

string roleId

The role id.

CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
Task
In This Article
Back to top bi excellence software GmbH