• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Estrelica
    • Core
    • CoreConfig
    • CoreConfig.Settings
  • Estrelica.Archer.AccessControl
    • AccessControlEdit
    • AccountStatus
    • ContactSubType
    • ContactType
    • IArcherGroup
    • IArcherGroupEdit
    • IArcherRole
    • IArcherRoleEdit
    • IArcherUser
    • IArcherUserEdit
    • ISecurityParameter
    • IUserContact
    • IUserProvider
    • UserType
  • Estrelica.Archer.Content
    • ArcherContentExtensions
    • ContentFilterHelper
    • ContentReportOptions
    • ContentSearchOptions
    • ContentSource
    • ContentType
    • CurrentDateOperator
    • DatafeedHistoryStatus
    • DatafeedStatus
    • DatafeedType
    • DateOffsetOperator
    • DateValueOperator
    • DisplayFieldExtensions
    • EqualityOperator
    • FieldHistoryAuditType
    • HistoryAuditType
    • IAdvancedWorkflowAudit
    • IArcherContent
    • IArcherContentAccess
    • IArcherContentEdit
    • IArcherContentIdQuery
    • IArcherDateFieldQuery
    • IArcherDocument
    • IArcherMembershipQuery<T>
    • IArcherNumericFieldQuery
    • IArcherRecord
    • IArcherRecordQuery
    • IArcherReport
    • IArcherTextFieldQuery
    • IArcherUserGroupFieldQuery
    • IArcherValuesListQuery
    • IContentHistory
    • IContentInformation
    • IContentReport
    • IContentReportOptions
    • IContentUpdateInformation
    • ICrossReferencedRecordsSelectionEdit
    • IDatafeed
    • IDatafeedHistory
    • IDatafeedHistoryMessage
    • IDatafeedRecordCount
    • IDateValueEdit
    • IDisplayField
    • IDocumentSelectionEdit
    • IEditableField
    • IExternalLink
    • IExternalLinkEdit
    • IExternalLinksSelectionEdit
    • IFieldAudit
    • IFieldHistory
    • IFieldHistoryEx
    • IFieldQuery
    • IFieldValueEdit<T>
    • IHistoryAudit
    • INumericValueEdit
    • IObjectValue
    • IReferencedRecordsSelection
    • IReferencedRecordsSelectionEdit
    • ISearchDisplayFieldOptions
    • ISearchOptions
    • ISignatureAudit
    • IStatisticsReport
    • ISubEditableField
    • ISystemUpdateInformation
    • ITextValueEdit
    • IUserGroupListSelection
    • IUserGroupListSelectionEdit
    • IValuesListBaseSelection
    • IValuesListBaseSelectionEdit
    • IValuesListSelection
    • IValuesListSelectionEdit
    • IValuesListSingleSelection
    • IValuesListSingleSelectionEdit
    • IWorkflowAction
    • IWorkflowNode
    • LastUpdatedPreference
    • NumericRangeOperator
    • RecordCountType
    • RecordStatus
    • ReportSource
    • SortField
    • SortType
    • ValueOperator
    • ValuesOperator
    • WorkflowAuditActionType
  • Estrelica.Archer.Entity
    • ArcherEntityExtensions
    • ASOStatus
    • EntityType
    • IArcherAliasableEntity
    • IArcherAliasedEntity
    • IArcherASOEntity
    • IArcherASONamedEntity
    • IArcherBase
    • IArcherContentUpdateInfoEntity
    • IArcherDescribableEntity
    • IArcherDescribedEntity
    • IArcherEntity
    • IArcherEntityBase
    • IArcherGuidEntity
    • IArcherNameableEntity
    • IArcherNamedEntity
    • IArcherUpdateInfoEntity
    • IEditableArcherEntity
    • IUpdateInformation
    • SourceAttribute
    • UpstreamPropertyAttribute
  • Estrelica.Archer.Events
    • EventActionLayoutType
    • EventActionType
    • EventDateActionType
    • EventItemActionType
    • EventSectionActionType
    • IEventAction
    • IEventRule
    • ISetDateOption
  • Estrelica.Archer.Layouts
    • ILayout
    • ILayoutEntity
    • ILayoutItem
    • ILayoutSection
    • ILayoutTab
    • LayoutItemType
    • LayoutMemberType
    • LayoutSectionType
    • LayoutTabType
  • Estrelica.Archer.Metadata
    • ArcherMetadataExtensions
    • FilterConditionType
    • FilterCriteriaOperatorType
    • IArcherApplication
    • IArcherLevel
    • IArcherModule
    • IArcherQuestionnaire
    • IArcherSolution
    • IArcherSubForm
    • IArcherValuesList
    • IArcherValuesListValue
    • IFilterCondition
    • IFilterCriteria
    • ILevelFilter
    • ILevelFilterValue
    • IModuleOwner
    • IModuleOwnerGroup
    • IModuleOwnerUser
    • IModuleReference
    • INumericRange
    • INumericRangeValue
    • IQuestionnaireRule
    • ModuleClass
    • ModuleStatus
    • ModuleType
    • QuestionnaireRuleType
    • ReportType
    • Timezone
    • ValuesListType
    • ValueSortType
  • Estrelica.Archer.Metadata.Field
    • ArcherFieldExtensions
    • DefaultDateType
    • ExternalLinkProtocol
    • FieldEncryptionState
    • FieldType
    • IArcherField
    • IAssetResponsibilitiesField
    • IAttachmentField
    • IAvailableUserGroupSelections
    • IBaseDateField
    • ICalculatedValuesListField
    • IContentAccessHistoryField
    • ICrossApplicationStatusTrackingField
    • ICrossModuleStatusTrackingField
    • ICrossReferenceField
    • IDateField
    • IDiscussionField
    • IDocumentField
    • IExternalLinksField
    • IFirstPublishedField
    • IGroupPermission
    • IHistoryLogField
    • IImageField
    • IIPAddressField
    • ILastUpdatedField
    • IMatrixField
    • ImplementsAPIKey
    • ImplementsFieldTypeAttribute
    • IMultipleReferenceDisplayField
    • INumericField
    • IPermissionInheritance
    • IQuestionnaireReferenceField
    • IRecordStatusField
    • IReferenceField
    • IRelatedRecordsField
    • IRiskAssessmentField
    • ISchedulerField
    • ISubformField
    • ITechnologiesListField
    • ITechnologyVersionsListField
    • ITextField
    • ITrackingIDField
    • IUserGroupListField
    • IUserPermission
    • IValuesListField
    • IVotingField
    • SystemFieldType
    • UserGroupType
    • VotingType
  • Estrelica.Archer.Metadata.Field.Properties
    • DisplayControl
    • FieldLayoutFormat
    • IAdvancedDisplayOption
    • IAdvancedDisplayProperty
    • IAllowLookupProperty
    • IAllowSortingProperty
    • IColumnCountProperty
    • IDisplayControlProperty
    • IDisplayInHeaderProperty
    • IEncryptionStateProperty
    • IFieldValidationTypeProperty
    • IHeightWidthProperty
    • IIncludeTimeInformationProperty
    • IIncludeUserInformationProperty
    • IIsAuditEnabledProperty
    • IIsBulkCreateEnabledProperty
    • IIsBulkUpdateEnabledProperty
    • IIsCalculatedProperty
    • IIsEditableGridDisplayProperty
    • IIsEditableInSearchProperty
    • IIsEncryptedProperty
    • IIsFindEnabledProperty
    • IIsKeyProperty
    • IIsQuestionProperty
    • IIsRequiredProperty
    • IIsRestrictedToLevelProperty
    • IIsSupressedProperty
    • IIsTrendingEnabledProperty
    • IIsUniqueProperty
    • ILinkProperty
    • ILookupReportProperty
    • IMaxAttachmentsAllowedProperty
    • IMaxFileSizeProperty
    • IMaximumSelectionProperty
    • IMaxIntValueProperty
    • IMaxLongValueProperty
    • IMinAttachmentsAllowedProperty
    • IMinimumSelectionProperty
    • IMinIntValueProperty
    • IMinLongValueProperty
    • IMinMaxSelectionProperty
    • IPrefixProperty
    • ISuffixProperty
    • ITrendingDurationProperty
    • ITrendingDurationTypeProperty
    • MatrixAxis
    • NegativeDisplayType
  • Estrelica.Archer.Metadata.Properties
    • IIsDeprecatedProperty
    • IIsDirectToEditEnabledProperty
    • IIsMobileEnabledProperty
    • IIsNotificationProperty
    • IIsTaskManagementEnabledProperty
    • IIsWaveEnabledProperty
    • IKeepLicensedProperty
    • ISearchViewProperty
  • Estrelica.Archer.Utility
    • APIExceptionExtensions
    • APIPreference
    • APISource
    • ArcherAPIException
    • ArcherEntitySerializer
    • BaseDataWrapper<K>
    • CachedResolver
    • DictionaryDataWrapper<K>
    • DomainFormat
    • EditUtilities
    • ExtensionsUnavailableException
    • FilterCriteriaHelper
    • IAccessResolver
    • IAPIFacade
    • IArcherRestAPI
    • IArcherSoapAPI
    • IArcherUndocumentedAPI
    • ICastleHillExtendedAPI
    • IContentResolver
    • ILayoutResolver
    • IMetadataResolver
    • IReportResolver
    • IValueAccessor
    • ObjectDataWrapper<T, K>
    • ObjectKeyAttribute
    • ValuesListChangeEvent
    • ValuesListChangeEventArgs
  • Estrelica.Interfaces
    • IArcherAuthProvider
    • ICacheProvider
    • IClearable
    • IDatabaseAuthProvider
    • IEditable
    • IEditable<V>
    • IEditableCollection<V>
    • IEditableEnumerable<V>
    • IEditableFieldSelection<V>
    • IEditableInterface<I>
    • IEntityResolver
    • IExtendedAPIAuthProvider
    • IHttpClientAccessor
    • ILogCleanup
    • ILogSubscriber
    • InvalidateEntity<K>
    • InvalidateEntityEventArgs<K>
    • IRecordAccess
    • IRecordAccess<T>
    • IResolverProvider
    • ISessionProvider
    • ISystemUpdateable
    • ITrafficCounter
    • LogLevel
  • Estrelica.Logging
    • BaseLogger
    • ConsoleLogger
    • FileLogger
    • FileLogger.TimestampFormat
    • Logger
    • TraceLogger
  • Estrelica.Utility
    • Arguments
    • BaseRecordAccess
    • DataReaderExtensions
    • DateTimeExtensions
    • Debouncer
    • DebugLog
    • DeferEnumerable<T>
    • DeferValue<V>
    • DictionaryExtensions
    • EnumHelper
    • ExceptionExtensions
    • GuidUtility
    • HandledException
    • HashSetExtensions
    • ICacheHandler
    • ICollectionExtensions
    • IDeferrable
    • IDeferredValue
    • IEnumerableExtensions
    • IgnoreDefaultValuesDictionary<K, V>
    • JsonDictionary<V>
    • OperationExtensions
    • Resource
    • SqlConnectionExtensions
    • SqlUtilities
    • StreamExtensions
    • StringExtensions
    • TableMapper
    • TimeoutDictionary<K, V>
    • TypeExtensions
    • XElementExtensions

Interface IAccessResolver

Inherited Members
IUserProvider.UserById(int, bool)
ICacheProvider.CacheTimeoutMinutes
ICacheProvider.ClearCache()
ICacheProvider.TimeoutChanged
ICacheProvider.CreateCache<K, V>()
ICacheProvider.UnregisterCache<K, V>(IDictionary<K, V>)
Namespace: Estrelica.Archer.Utility
Assembly: Estrelica.Interfaces.dll
Syntax
[StayPublic]
[DoNotObfuscateType]
public interface IAccessResolver : IUserProvider, ICacheProvider

Properties

AllGroups

Declaration
IEnumerable<IArcherGroup> AllGroups { get; }
Property Value
IEnumerable<IArcherGroup>

AllRoles

Declaration
IEnumerable<IArcherRole> AllRoles { get; }
Property Value
IEnumerable<IArcherRole>

AllSecurityParameters

Declaration
IEnumerable<ISecurityParameter> AllSecurityParameters { get; }
Property Value
IEnumerable<ISecurityParameter>

AllUsers

Declaration
IEnumerable<IArcherUser> AllUsers { get; }
Property Value
IEnumerable<IArcherUser>

CurrentUser

Declaration
IArcherUser CurrentUser { get; }
Property Value
IArcherUser

Methods

ChildGroupIdsForGroup(int, bool)

Declaration
IEnumerable<int> ChildGroupIdsForGroup(int groupId, bool throwExceptionIfInvalid = true)
Parameters
int groupId

bool throwExceptionIfInvalid

Returns
IEnumerable<int>

CreateGroup(string, string, IEnumerable<int>, IEnumerable<int>, IEnumerable<int>)

Declaration
IArcherGroup CreateGroup(string groupName, string description = null, IEnumerable<int> parentGroupIds = null, IEnumerable<int> childGroupIds = null, IEnumerable<int> userIds = null)
Parameters
string groupName

string description

IEnumerable<int> parentGroupIds

IEnumerable<int> childGroupIds

IEnumerable<int> userIds

Returns
IArcherGroup

CreateRole(string, string, string, IEnumerable<int>, IEnumerable<int>, bool)

Declaration
IArcherRole CreateRole(string roleName, string description = null, string alias = null, IEnumerable<int> groupIds = null, IEnumerable<int> userIds = null, bool isDefault = false)
Parameters
string roleName

string description

string alias

IEnumerable<int> groupIds

IEnumerable<int> userIds

bool isDefault

Returns
IArcherRole

CreateUser(string, string, string, string, string, int?, int?, string, bool, AccountStatus, int, IEnumerable<int>, IEnumerable<int>)

Creates a new Archer user, returning it as an IArcherUser

Declaration
IArcherUser CreateUser(string firstName, string lastName, string password, string middleName = null, string username = null, int? domainId = null, int? languageId = null, string timezone = null, bool forcePasswordChange = false, AccountStatus accountStatus = AccountStatus.Active, int securityParameterId = 1, IEnumerable<int> groupIds = null, IEnumerable<int> roleIds = null)
Parameters
string firstName

string lastName

string password

string middleName

string username

int? domainId

int? languageId

string timezone

bool forcePasswordChange

AccountStatus accountStatus

int securityParameterId

IEnumerable<int> groupIds

IEnumerable<int> roleIds

Returns
IArcherUser

Delete(IArcherGroup)

Declaration
bool Delete(IArcherGroup group)
Parameters
IArcherGroup group

Returns
bool

Delete(IArcherRole)

Declaration
bool Delete(IArcherRole role)
Parameters
IArcherRole role

Returns
bool

Delete(IArcherUser)

Declaration
bool Delete(IArcherUser user)
Parameters
IArcherUser user

Returns
bool

Delete(IEditableArcherEntity)

Declaration
bool Delete(IEditableArcherEntity item)
Parameters
IEditableArcherEntity item

Returns
bool

DeleteGroup(int)

Declaration
bool DeleteGroup(int groupId)
Parameters
int groupId

Returns
bool

DeleteRole(int)

Declaration
bool DeleteRole(int roleId)
Parameters
int roleId

Returns
bool

DeleteUser(int)

Declaration
bool DeleteUser(int userId)
Parameters
int userId

Returns
bool

GroupByAlias(string, bool)

Declaration
IArcherGroup GroupByAlias(string groupAlias, bool throwExceptionIfInvalid = true)
Parameters
string groupAlias

bool throwExceptionIfInvalid

Returns
IArcherGroup

GroupByGuid(Guid, bool)

Declaration
IArcherGroup GroupByGuid(Guid groupGuid, bool throwExceptionIfInvalid = true)
Parameters
Guid groupGuid

bool throwExceptionIfInvalid

Returns
IArcherGroup

GroupById(int, bool)

Declaration
IArcherGroup GroupById(int groupId, bool throwExceptionIfInvalid = true)
Parameters
int groupId

bool throwExceptionIfInvalid

Returns
IArcherGroup

GroupByName(string, bool)

Declaration
IArcherGroup GroupByName(string groupName, bool throwExceptionIfInvalid = true)
Parameters
string groupName

bool throwExceptionIfInvalid

Returns
IArcherGroup

GroupIdsForUser(int, bool)

Declaration
IEnumerable<int> GroupIdsForUser(int userId, bool throwExceptionIfInvalid = true)
Parameters
int userId

bool throwExceptionIfInvalid

Returns
IEnumerable<int>

ParentGroupIdsForGroup(int, bool)

Declaration
IEnumerable<int> ParentGroupIdsForGroup(int groupId, bool throwExceptionIfInvalid = true)
Parameters
int groupId

bool throwExceptionIfInvalid

Returns
IEnumerable<int>

RoleById(int, bool)

Declaration
IArcherRole RoleById(int roleId, bool throwExceptionIfInvalid = true)
Parameters
int roleId

bool throwExceptionIfInvalid

Returns
IArcherRole

RoleByName(string, bool)

Declaration
IArcherRole RoleByName(string roleName, bool throwExceptionIfInvalid = true)
Parameters
string roleName

bool throwExceptionIfInvalid

Returns
IArcherRole

SecurityParameterById(int, bool)

Declaration
ISecurityParameter SecurityParameterById(int securityParameterId, bool throwExceptionIfInvalid = true)
Parameters
int securityParameterId

bool throwExceptionIfInvalid

Returns
ISecurityParameter

Update(IArcherGroupEdit)

Declaration
IArcherGroup Update(IArcherGroupEdit item)
Parameters
IArcherGroupEdit item

Returns
IArcherGroup

Update(IArcherRoleEdit)

Declaration
IArcherRole Update(IArcherRoleEdit item)
Parameters
IArcherRoleEdit item

Returns
IArcherRole

Update(IArcherUserEdit)

Declaration
IArcherUser Update(IArcherUserEdit item)
Parameters
IArcherUserEdit item

Returns
IArcherUser

UserByUsername(string, bool)

Declaration
IArcherUser UserByUsername(string userName, bool throwExceptionIfInvalid = true)
Parameters
string userName

bool throwExceptionIfInvalid

Returns
IArcherUser

UserByUsername(string, string, bool)

Declaration
IArcherUser UserByUsername(string userName, string userDomain, bool throwExceptionIfInvalid = true)
Parameters
string userName

string userDomain

bool throwExceptionIfInvalid

Returns
IArcherUser

UserIdsForGroup(int, bool)

Declaration
IEnumerable<int> UserIdsForGroup(int groupId, bool throwExceptionIfInvalid = true)
Parameters
int groupId

bool throwExceptionIfInvalid

Returns
IEnumerable<int>

UsernameForUserId(int, bool)

Declaration
string UsernameForUserId(int userId, bool throwExceptionIfInvalid = true)
Parameters
int userId

bool throwExceptionIfInvalid

Returns
string

Extension Methods

EnumHelper.In<TEnum>(TEnum, params TEnum[])
IEnumerableExtensions.ToEnumerable<T>(T)
StringExtensions.AssertNotNull<T>(T, string)
TypeExtensions.WithDispose<T, V>(T, Func<T, V>)
EnumHelper.CastNullable<TEnum>(object)
TypeExtensions.ConvertTo<V>(object)
TypeExtensions.TryConvert<V>(object, out V)
Back to top Copyright 2019-2023 by CastleHill Software LLC