Show / Hide Table of Contents

Class UserPreferencesProvider

User (and system) preference settings, at all levels

Inheritance
object
MultiQueryProviderBase
UserPreferencesProvider
Implements
IArchiveMultiQueryProvider
IArchiveProvider
IArchiveProviderHasRows
IArchiveProviderHasColumns
IArchiveProviderHasEntities
Inherited Members
MultiQueryProviderBase.InnerPopulateRow(ArchiveRow)
MultiQueryProviderBase.AcceptRow(ArchiveRow)
MultiQueryProviderBase.PreGetRows()
MultiQueryProviderBase.GetFinalRowCount()
MultiQueryProviderBase.AddSubProvider<ProviderType>(ProviderType)
MultiQueryProviderBase.RemoveSubProvider<ProviderType>(ProviderType)
MultiQueryProviderBase.SetRestrictionAndDropUnrestrictedProviders(ArchiveRestrictionInfo[])
MultiQueryProviderBase.CreateAndAddProvidersAsync(MultiQueryProviderBase.AddProviderInfo[])
MultiQueryProviderBase.Close()
MultiQueryProviderBase.GetReaderAsync(string, CancellationToken)
MultiQueryProviderBase.GetRowsAsync(string, CancellationToken)
MultiQueryProviderBase.GetResultInformationAsync()
MultiQueryProviderBase.SetPagingInfo(int, int)
MultiQueryProviderBase.GetAvailableColumns()
MultiQueryProviderBase.SetDesiredColumns(params string[])
MultiQueryProviderBase.SetOrderBy(ArchiveOrderByInfo[])
MultiQueryProviderBase.GetAvailableEntities()
MultiQueryProviderBase.SetDesiredEntities(params string[])
MultiQueryProviderBase.InhibitParallelStart
MultiQueryProviderBase.Options
MultiQueryProviderBase.OrderBy
MultiQueryProviderBase.InhibitDistinctPrimaryKeys
MultiQueryProviderBase.OrderByRequiresAll
MultiQueryProviderBase.RestrictionRequiresAll
MultiQueryProviderBase.OrderByRequired
MultiQueryProviderBase.RestrictionHelper
MultiQueryProviderBase.ColumnHelper
MultiQueryProviderBase.PageSize
MultiQueryProviderBase.PageNumber
MultiQueryProviderBase.HaveReadToEnd
MultiQueryProviderBase.Providers
MultiQueryProviderBase.DebugXML
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[ArchiveProvider("UserPreferences", 1073741823)]
public class UserPreferencesProvider : MultiQueryProviderBase, IArchiveMultiQueryProvider, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

Constructors

UserPreferencesProvider()

User (and system) preference settings, at all levels

Declaration
public UserPreferencesProvider()
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

Fields

ProviderName

User (and system) preference settings, at all levels

Declaration
public const string ProviderName = "UserPreferences"
Field Value
Type Description
string
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

RowTypeDatabaseName

User (and system) preference settings, at all levels

Declaration
public const string RowTypeDatabaseName = "database"
Field Value
Type Description
string
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

RowTypeDefaultName

User (and system) preference settings, at all levels

Declaration
public const string RowTypeDefaultName = "default"
Field Value
Type Description
string
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

RowTypeGroupName

User (and system) preference settings, at all levels

Declaration
public const string RowTypeGroupName = "group"
Field Value
Type Description
string
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

RowTypeSystemName

User (and system) preference settings, at all levels

Declaration
public const string RowTypeSystemName = "system"
Field Value
Type Description
string
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

RowTypeUserName

User (and system) preference settings, at all levels

Declaration
public const string RowTypeUserName = "user"
Field Value
Type Description
string
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

_colSectionKey

User (and system) preference settings, at all levels

Declaration
protected ArchiveColumnInfo _colSectionKey
Field Value
Type Description
ArchiveColumnInfo
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

Methods

SetRestriction(ArchiveRestrictionInfo[])

Override: In addition to section and key restrictions, we also have a combined section|key restriction needed for the Admin preference GUI

Declaration
public override bool SetRestriction(ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
bool
Overrides
MultiQueryProviderBase.SetRestriction(ArchiveRestrictionInfo[])
Remarks

The SoPreference class will return the current setting for a preference for the current principal. This archive provider is for administrative purposes, and returns all settings for the preference(s) selected.
Preferences have multiple sources: the userpreference table (UserPreferenceTableProvider, and various Service settings that are mapped into preferences, retrieved by MappedPreferenceProvider.

Implements

IArchiveMultiQueryProvider
IArchiveProvider
IArchiveProviderHasRows
IArchiveProviderHasColumns
IArchiveProviderHasEntities

Extension Methods

IArchiverProviderHasRowsExtensions.GetRowsAsync(IArchiveProviderHasRows, CancellationToken)
EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top