mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='https://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='https://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='https://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='https://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='https://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
MISSING BANNER
Code Details >> Core >> Users >> User_Object

User_Object Class



Represents a single mySobek user, including personal information, permissions, and preferences.


Namespace: SobekCM.Core.Users
Assembly: SobekCM_Core (in SobekCM_Core.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public class User_Object

Inheritance Hierarchy

System..::..Object
  SobekCM.Core.Users..::..User_Object

Constructors

  NameDescription
Public methodUser_Object
Constructor for a new instance of the User_Object class

Methods

  NameDescription
Public methodAdd_Aggregation
Add a new item aggregation to this user's collection of item aggregationPermissions
Public methodAdd_BibID
Adds a BibID to the list of bibid's this user can edit
Public methodAdd_Bookshelf_Item
Add an item to the list of items on the bookshelf for this user
Public methodAdd_Default_Metadata_Set
Adds a default metadata set to the list of sets this user can select
Public methodAdd_Editable_Regular_Expression
Adds a regular expression to this user to determine which titles this user can edit
Public methodAdd_Folder(User_Folder)
Adds a folder to the list of folders associated with this user
Public methodAdd_Folder(String, Int32)
Adds a folder name to the list of folders associated with this user
Public methodAdd_Setting(String, Object)
Add a new user option
Public methodAdd_Setting(String, Object, Boolean)
Add a new user option
Public methodAdd_Template
Adds a template to the list of templates this user can select
Public methodAdd_User_Group
Adds a user group to the list of user groups this user belongs to
Public methodCan_Delete_This_Item
Determines if this user can edit this item, based on several different criteria
Public methodCan_Edit_All_Items
Checks to see if this user can edit all the items within this aggregation
Public methodCan_Edit_This_Item
Determines if this user can edit this item, based on several different criteria
Public methodClear_Aggregations
Clear the list of aggregation permissions associated with this user
Public methodClear_Default_Metadata_Sets
Clears all default metadata sets associated with this user
Public methodClear_Folders
Clear all the folders linked to this user object
Public methodClear_Templates
Clears the list of templates associated with this user
Public methodClear_UserGroup_Membership
Clear all the user groups associated with this user
Public methodStatic memberDES_EncryptString
Encrypt a string, given the string.
Public methodFolder_Name
This checks that the folder name exists, and returns the proper format
Public methodGet_Folder
Get a folder obejct by folder name
Public methodGet_Setting(String)
Get the user option as an object, by option key
Public methodGet_Setting(String, Int32)
Get the user option as an integer, by option key
Public methodGet_Setting(String, String)
Get the user option as a string, by option key
Public methodGet_Value_By_Mapping
Gets a value from this user object, based on the user object attribute mapping enumeration
Public methodIs_Aggregation_Admin
Checks to see if this user can perform administrative tasks against an item aggregation
Public methodIs_Aggregation_Curator
Checks to see if this user can perform curatorial tasks against an item aggregation
Public methodIs_In_Bookshelf
Checks to see if an item exists in this user's bookshelf
Public methodIs_On_Home_Page
Checks to see if an aggregation is currently listed on the user's personalized home page
Public methodRemove_Folder
Removes a folder name from the list of folders associated with this user
Public methodRemove_From_Bookshelves
Removes an item from the list of items in the user's bookshelves
Public methodSecurity_Hash
Returns the security hash based on IP for this user
Public methodSet_Aggregation_Home_Page_Flag
Sets the flag that a particular aggregation exists on this user's home page
Public methodSet_Current_Default_Metadata
Sets the current default metadata set for this user
Public methodSet_Default_Template
Sets the default template for this user
Public methodSet_Value_By_Mapping
Set a value on this user object, based on the user object attribute mapping enumeration

Properties

  NameDescription
Public propertyAll_Folders
Gets the list of all folders, in alphabetical order
Public propertyAuthentication_Type
Enumeration indicates how the user authenticated with the system ( i.e., Sobek, Shibboleth, or LDAP )
Public propertyBibIDs
List of the BibID's for every item this user has submitted or been directly granted edit permissions against.
Public propertyCan_Delete_All
Simple flag indicates if this user can delete any item in this repository
Public propertyCan_Submit
Simple flag indicates if this user can submit items
Public propertyCollege
User's college affiliation information
Public propertyCurrent_Default_Metadata
Returns the current default metadata set for this user
Public propertyCurrent_Template
Returns the current template for this user
Public propertyDefault_Metadata_Sets
Ordered list of default metadata sets this user has access to
Public propertyDefault_Metadata_Sets_Count
Return the number of default metadata sets tied to this user group
Public propertyDefault_Rights
Default rights statement for this user
Public propertyDepartment
User's department affiliation information
Public propertyEdit_Template_Code_Complex
User's template code editing complex (MARC) records
Public propertyEdit_Template_Code_Simple
User's template code for editing simple (non-MARC) records
Public propertyEditable_Regular_Expressions
List of regular expressions for checking for edit by bibid
Public propertyEmail
User's email address
Public propertyFamily_Name
User's family (or last) name
Public propertyFolders
List of folders associated with this user
Public propertyFull_Name
Returns the user's full name in [first name last name] order
Public propertyGiven_Name
User's given (or first) name
Public propertyHas_Descriptive_Tags
Flag indicates if this user has descriptive tags associated with them
Public propertyHas_Item_Stats
Flag indicates this user has item statistics linked to their account
Public propertyInclude_Tracking_In_Standard_Forms
Flag indicates if users should see the tracking information when adding a new volume or performing standard operations within the system
Public propertyInternal_Notes
Internal notes about this user, which are not viewable by the actual user
Public propertyIs_A_Collection_Manager_Or_Admin
Checks to see if this user is a collection manager or collection admin
Public propertyIs_Host_Admin
Flag indicates if this user is the host administrator, if this is a hosted instance
Public propertyIs_Internal_User
Flag indicates if this is an internal user
Public propertyIs_Just_Registered
Flag indicates if this user was just registered
Public propertyIs_Portal_Admin
Flag indicates if this user has general admin rights over the appearance of portions of the system
Public propertyIs_System_Admin
Flag indicates if this user has general admin rights over the entire system, including very basic settings which impactt how the system runs
Public propertyIs_Temporary_Password
Flag indicates if this is a temporary password
Public propertyItems_Submitted_Count
Number of items this user has submitted
Public propertyLoggedOn
Flag indicates if this user is logged on, or if this represents a non-logged on user's session-specific data
Public propertyNickname
User's nickname
Public propertyOrganization
User's organization affiliation information
Public propertyOrganization_Code
User's organization code
Public propertyPermissionedAggregations
List of item aggregation permissions associated with this user
Public propertyPermissionedAggregations_Count
Return the number of aggregations tied to this user group
Public propertyPreferred_Language
User's preferred language
Public propertyProcessing_Technician
Flag indicates if this user should appear as a possible processing technician
Public propertyReceive_Stats_Emails
Flag indicates this user has chosen to receive statistics emails about their items
Public propertyReversed_Full_Name
Returns the user's full name in [last name, last name] format
Public propertyScanning_Technician
Flag indicates if this user should appear as a possible scanning technician
Public propertySend_Email_On_Submission
Flag indicates whether user wishes to receive an email after submission
Public propertyShibbID
User's shibboleth ID
Public propertyShould_Be_Able_To_Edit_All_Items
Flag is used when editing a users rights to indicate this user should be able to edit ALL items in the library
Public propertyTemplates
Ordered list of submittal templates this user has access to
Public propertyTemplates_Count
Return the number of templates tied to this user group
Public propertyUnit
User's unit affiliation information
Public propertyUser_Groups
List of user groups to which this user belongs
Public propertyUserID
UserID (or primary key) to this user from the database
Public propertyUserName
SobekCM username for this user

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )