UserPreferences Class |
Service for managing user preferences.
Inheritance HierarchySystemObject
System.ComponentModelMarshalByValueComponent
System.Web.ServicesWebService
FileHold.LibraryManagerUserPreferences
System.ComponentModelMarshalByValueComponent
System.Web.ServicesWebService
FileHold.LibraryManagerUserPreferences
Namespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
SyntaxC#
public class UserPreferences : WebService
The UserPreferences type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | UserPreferences | Initializes a new instance of the UserPreferences class |
Methods| Name | Description | |
|---|---|---|
| ActivateExistingADAMObjects |
Activate existing ADAM objects in the cache.
|
| AddADAMObject |
Add given ADAM objects into the cache.
|
| AddAlert |
Add document or folder to list of alerts
|
| AddView |
Create a new personal or public view.
|
| AddViewForUser |
Create a new personal view for specified user.
|
| DontShowMessage |
Mark the message not to be shown in the future for current user.
|
| GetAdvancedSearchSettings |
Get user preferences for advanced search settings
|
| GetAdvancedSearchSettingsSystem |
Return system settings for advanced search settings
|
| GetAlerts |
Return all alerts for the current user
|
| GetAlertSettings |
Return user preferences for alerts
|
| GetAlertSystemSettings |
Return system settings for alerts
|
| GetAvailableFormats |
Return the list of available formats of the given type.
|
| GetAvailableTimeZones |
Get available time zones in the system.
|
| GetClearWorkflowIncludePostponed |
Get include postponed while clearing workflows setting.
|
| GetCustomView |
Get the custom view columns for the current user.
|
| GetDefaultTimeZone |
This method is obsolete.
|
| GetDefaultViewForContext |
Retrieve the default view in given context.
|
| GetDontShowMessage |
Checks if a specific message was marked not to be shown in the future.
|
| GetDoubleClickActionType |
Return FDA's action type when double clicking on document.
|
| GetFastFindSettings |
Get user preferences for fast find settings
|
| GetFastFindSettingsSystem |
Return system settings for fast find settings
|
| GetFDAAdvancedSettings |
Get user preferences for fda advanced settings
|
| GetFDAAdvancedSettingsSystem |
Return system settings for fda advanced settings
|
| GetLinkedDocumentsMetadataFieldId |
Get user's Linked Documents default metadata field id
|
| GetLinkedDocumentsSchemaMode |
Get user's Linked Documents schema mode
|
| GetLinkedPanelPinSetting |
Get user's Linked panel pin setting
|
| GetLocalTimeZoneId | |
| GetMiscSettings |
Get user preferences for misc settings
|
| GetMiscSettingsSystem |
Return system settings for misc settings
|
| GetMiscSettingsSystem(Database, DbTransaction) | |
| GetMultipleWorkflowsSettings |
Get multiple workflows settings.
|
| GetMyTasksFilter | |
| GetMyTasksFilter(Database, DbTransaction, NullableInt32) | |
| GetParentViewForContext |
Retrieve the inherited view in given context.
|
| GetReminderDetails |
Return the details of a specific reminder.
|
| GetReminders |
Return a list of reminders for the current user.
|
| GetSchemaFields |
Return column definitions for all fields defined in all document schemas.
|
| GetSpecificUserWorkflowDetailsPreferences |
Return user workflow details preferences for specific user
|
| GetSystemFields |
Get column definitions of all available system fields for the given container type.
|
| GetTimeZone |
This method is obsolete.
|
| GetUserAdminMenuSettings |
Get specific user preferences for admin menu settings
|
| GetUserAdvancedSearchSettings |
Get specific user preferences for advanced search settings
|
| GetUserAlertSettings |
Get specific user preferences for alerts
|
| GetUserDownloadPreferencesInWebClient |
Return default document action in Web Client
|
| GetUserFDAAdvancedSettings |
Get specific user preferences for fda advanced settings
|
| GetUserGuid |
Get user guid by user id
|
| GetUserId |
Get user id by user guid
|
| GetUserLanguage(Guid) |
Return default language for the specified user.
|
| GetUserLanguage(Guid, Database, DbTransaction) | |
| GetUserMiscSettings(Guid) |
Get specific user preferences for misc settings
|
| GetUserMiscSettings(Guid, Database, DbTransaction) | |
| GetUserPreferences |
Return preferences for the current user.
|
| GetUserPreferences(Int32) | |
| GetUserPreferences(Int32, Database, DbTransaction) | |
| GetUserUseNewWorkflowInterface |
Return new workflow interface preference for a user
|
| GetUserWorkflowDetailsPreferences |
Return user workflow details preferences
|
| GetUserWorkflowNotificationsSettings |
Get specific user preferences for workflow notifications
|
| GetViewDetails |
Return details of the given view.
|
| GetViewDetailsForUser |
Return details of the given view that specified user has access to.
|
| GetViewPageSize |
Get the page size for a given view.
|
| GetViews |
Return all views for given container type.
|
| GetViewSettings |
Return the default view for given folder.
|
| GetViewsForUser |
Return all views for given container type for specified user.
|
| GetWorkflowDocumentsPanelPinSetting |
Get user's Workflow Documents panel pin setting
|
| GetWorkflowNotificationsSettings |
Get user preferences for workflow notifications
|
| GetWorkflowNotificationsSystemSettings |
Return system settings for workflow notification
|
| MarkAlertsAsRead |
Mark selected alerts as read.
|
| MarkRemindersAsRead |
Mark selected reminders as read.
|
| RemoveADAMObjects |
Remove given ADAM objects from the cache.
|
| RemoveAlert |
Removes document or folder from list of alerts
|
| RemoveReminder |
Remove document from list of reminders
|
| RemoveView |
Delete a personal or public view.
|
| ResetAdvancedSearchSettingsSystem |
Reset user settings advanced search settings
|
| ResetAlertSettings |
Reset user settings for alerts
|
| ResetAllMessages |
Mark all messages to be shown in the future.
|
| ResetCustomView |
Delete the custom view and use the default view.
|
| ResetFastFindSettingsSystem |
Reset user settings fast find settings
|
| ResetFDAAdvancedSettingsSystem |
Reset user settings fda advanced settings
|
| ResetMiscSettingsSystem |
Reset user settings misc settings
|
| ResetWorkflowNotificationsSettings |
Reset user settings for workflow notification
|
| SavePersonalView |
Create or update a personal view in given context.
|
| SetAdvancedSearchSettings |
Set user preferences for advanced search settings
|
| SetAdvancedSearchSettingsSystem |
Set system settings for advanced search settings
|
| SetAlertSettings |
Set user preferences for alerts
|
| SetAlertSystemSettings |
Set system settings for alerts
|
| SetClearWorkflowIncludePostponed |
Set include postponed while clearing workflows setting.
|
| SetCustomView |
Set custom view for the current user.
|
| SetDefaultTimeZone |
This method is obsolete.
|
| SetDefaultView |
Set the default view for all users.
|
| SetDefaultViewForContext |
Set the default view in given context.
|
| SetFastFindSettings |
Set user preferences for fast find settings
|
| SetFastFindSettingsSystem |
Set system settings for fast find settings
|
| SetFDAAdvancedSettings |
Set user preferences for fda advanced settings
|
| SetFDAAdvancedSettingsSystem |
Set system settings for fda advanced settings
|
| SetFixedViewPageSize |
Modify the page size for a fixed container type.
|
| SetLinkedDocumentsMetadataFieldId |
Set user's Linked Documents default metadata field id
|
| SetLinkedDocumentsSchemaMode |
Set user's Linked Documents schema mode
|
| SetLinkedPanelPinSetting |
Set user's Linked panel pin setting
|
| SetMiscSettings |
Set user preferences for misc settings
|
| SetMiscSettingsSystem |
Set system settings for misc settings
|
| SetMultipleWorkflowsSettings |
Set multiple workflows settings.
|
| SetMyTasksFilter(String) | |
| SetMyTasksFilter(String, Database, DbTransaction, NullableInt32) | |
| SetReminder |
Add a reminder for a document.
|
| SetSpecificUserWorkflowDetailsPreferences |
Set specific user workflow details preferences
|
| SetTimeZone |
This method is obsolete.
|
| SetUserAdminMenuSettings |
Set user preferences for admin menu settings.
|
| SetUserAdvancedSearchSettings |
Set specific user preferences for advanced search settings
|
| SetUserAlertSettings |
Set specific user preferences for alerts
|
| SetUserDownloadPreferencesInWebClient |
Set default document action in Web Client
|
| SetUserFDAAdvancedSettings |
Set specific user preferences for fda advanced settings
|
| SetUserLanguage |
Set language preferences for the specified user.
|
| SetUserMiscSettings |
Set specific user preferences for misc settings
|
| SetUserPreferences |
Set preferences for the current user.
|
| SetUserPreferenceTaskDetailsCollapse |
Set task details collapse user preference
|
| SetUserPreferenceWorkflowChangesVisible |
Set workflow changes visibility user preference
|
| SetUserPreferenceWorkflowHistoryCollapse |
Set workflow history collapse user preference
|
| SetUserUseNewWorkflowInterface |
Set new workflow interface preference for a user
|
| SetUserWorkflowNotificationSettings |
Set specific user preferences for workflow notifications
|
| SetWorkflowDocumentsPanelPinSetting |
Set user's Workflow Documents panel pin setting
|
| SetWorkflowNotificationsSettings |
Set user preferences for workflow notifications
|
| SetWorkflowNotificationsSystemSettings |
Set system settings for workflow notifications
|
| UpdateReminder |
Change settings of a reminder.
|
| UpdateView |
Modify an existing personal or public view.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ConvertT | (Defined by ObjectExtension.) |
| ToJson | (Defined by ObjectExtension.) |
See Also