Click or drag to resize

PFUser Class

Represents a Packflow user.
Inheritance Hierarchy

Namespace:  Packflow.Core
Assembly:  MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax
C#
public class PFUser : PFRelationalObject, IPrincipal

The PFUser type exposes the following members.

Properties
  NameDescription
Public propertyAvailableInFields
Gets or sets a value indicating whether the user is available for selection in user fields (PFFieldUser).

Note : this property returns False if Enabled is False.

Public propertyAvailableInOrganisation
Gets or sets a value indicating whether the user is available for selection in site organisation groups.

Note : this property returns False if Enabled is False.

Public propertyAvailableInRoles
Gets or sets a value indicating whether the user is available for selection in application roles.

Note : this property returns False if Enabled is False.

Public propertyBeforeSaveValues
Gets the previous values of modified fields before the latest Save.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFBaseObject.)
Public propertyCanDelete
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.)
Public propertyCanRead
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.)
Public propertyCanUpdate
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.)
Public propertyCreated
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.)
Public propertyCreatedAt
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.)
Public propertyCreatedBy
Gets the user who created this object in the database.
(Inherited from PFBaseObject.)
Public propertyCustomSettings
Gets the dictionary hosting custom settings. Use this object to store user application-related settings.
Public propertyDashboardId
Gets or sets the dashboard id, referencing the default dashboard shown to the user.

If set, this overrides the DashboardId property on the PFSite.

If not set, GetActiveDashboard returns null and the PFSite dashboard is used instead.

Public propertyData
Gets the data collection of this object.
(Inherited from PFBaseObject.)
Public propertyDateObjectCreation
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.)
Public propertyDeleted
True if this object is flagged as deleted.
(Inherited from PFBaseObject.)
Public propertyDeletedAt
Date of the suppression of this object.
(Inherited from PFBaseObject.)
Public propertyDeletedBy
The user who deleted this object.
(Inherited from PFBaseObject.)
Public propertyDisplayName
Gets or sets the user's display name.
Public propertyEffectiveLanguageCode
Gets the effective language code (in 2 letters format). Returns the language chosen in the user settings if provided, else the language code of the site settings.
Public propertyEffectiveLocale
Gets the locale code corresponding to the current EffectiveLanguageCode. E.g. "en-gb" is returned for the "en" language code.
Public propertyEffectiveNotificationSystem
Gets the effective notification system.
Public propertyEmailAddress
Gets or sets the user's email address.
Public propertyEnabled
Gets or sets a value indicating whether the user is enabled in Packflow. This value has an impact on various other properties like "SiteAccess".
Public propertyEnableVersionMergeToResolveSaveConflicts
Gets a value indicating whether versions can be merged to resolve save conflicts. If an object is saved with an older version than the last persisted (in database), the system will try to merge the versions values (if no conflicts between values) and will then save the merged item to database. Note : this setting is NOT persisted and will affect this object instance only.
(Inherited from PFBaseObject.)
Public propertyExists
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.)
Public propertyStatic memberForbiddenChararacters
Gets the list of characters forbidden in a user display name.
Public propertyGuid
Gets the GUID identifying this object. Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.)
Public propertyHasAssociatedIdentity
Gets a value indicating whether this user has an associated identity.
Public propertyHasPendingModifications
Checks if there is pending changes. Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.)
Public propertyHasPendingPermissionsModifications
Checks if there is pending modifications in permissions. Will compute permissions (RUD) and check if there is differences with current persisted permissions.
(Inherited from PFBaseObject.)
Public propertyHasPicture
Gets a value indicating whether this user has a picture.
Public propertyId
Gets the id identifying this object. Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.)
Public propertyIdentity
Gets the identity of this user. Not available for system users.
Public propertyIsSystemUser
Gets a value indicating whether this user is a system user (=not a person).
Public propertyJobTitle
Gets or sets the job title.
Public propertyKeepBeforeSaveValues
Gets or sets a value indicating whether the Save should keep a collection of the modified fields previous values.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFBaseObject.)
Public propertyLogger
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.)
Public propertyLogIdentification
Gets a technical text representing this object.
(Inherited from PFBaseObject.)
Public propertyLoginName
Gets the user's login name.
Public propertyNavigationEntries
Gets a relation allowing to access all navigation entries of this user.
Public propertyNotifications
Gets a relation allowing to access all notifications of this user.
Public propertyPermissionContext
Gets an object calculating permissions on demand.
Public propertyPermissions
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetDeleteId
Id of the permission set for Delete access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetDeleteXml
XML of serialized permission set for Delete access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetReadId
Id of the permission set for Read access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetReadXml
XML of serialized permission set for Read access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetUpdateId
Id of the permission set for Update access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetUpdateXml
XML of serialized permission set for Update access.
(Inherited from PFBaseObject.)
Public propertyPicture
Gets or sets the user picture.
Public propertyPrincipalGuid
Gets the GUID of the principal corresponding to this user.

Note : local (computer) users do not have principal GUID.

Public propertySettings
Gets the user settings.
Public propertySID
Gets the Security ID (SID) of the principal corresponding to this user.
Public propertySite
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.)
Public propertySiteAccess
Gets or sets a value indicating how the user can access the Packflow site.

Note : this property returns None if Enabled is False.

Public propertyThemeId
Gets or sets the theme id, referencing the theme used by the user.

If set, this overrides the ThemeId property on the PFSite.

Public propertyUpdatedAt
Gets the date of the last update of this object.
(Inherited from PFBaseObject.)
Public propertyUpdatedBy
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.)
Public propertyUserGuid
Gets the user GUID.
Public propertyVersionNumber
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.)
Top
Methods
  NameDescription
Public methodCompareIdentity
Compares the current user with the specified identity.
Public methodDelete
Flags this object as deleted.

If it fails, throws an error.

If the object could not be deleted because it does not yet exist in database, returns false.

If successful, returns true.

(Inherited from PFBaseObject.)
Public methodGetActiveTheme
Gets the theme currently used by the user. Returns null if current user has no active theme.
Public methodGetCustomHomeDashboard
Gets the home dashboard currently used by the user. Returns null if current user has no custom home dashboard.
Public methodGetItemComments
Gets a list of comments made by this user on items.

The ParentItem property of returned comments will not be initialized.

Public methodGetItemsFiltersForCurrentContextFilters
This will generate PFQuery filters allowing to filter items according to this user current context filters.
Public methodGetItemSubscriptions
Gets a list of subscriptions made by this user on items.

The ParentItem property of returned comments will not be initialized.

Public methodGetLocks
Gets the list of object locks owned by this user, ordered by creation date descending.
Protected methodGetNewPermissionContext
Creates a new permission context based on current object type.
(Overrides PFBaseObjectGetNewPermissionContext.)
Public methodGetObjectRelationByName
Gets a children entities relation by its name.
(Inherited from PFRelationalObject.)
Public methodGetPictureRelativeURL(Boolean)
Gets the relative URL of this user's picture.
Public methodStatic memberGetPictureRelativeURL(Boolean, Int64)
Gets the relative URL of the specified user's picture.
Public methodGetTemporaryKey
Gets a daily temporary key for this user.
Public methodGetUserUrl
Gets the user form URL.
Public methodStatic memberGetUserUrl(PFSite, Int64)
Gets the form URL of the specified user having the specified parent site.
Protected methodInitializeLogger
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.)
Public methodIsInRole
IPrincipal implementation. Throws NotImplementedException.
Public methodNotify(String, String, IUserNotificationRelatedObject, Boolean)
Creates a new user notification for this user with the specified message. Triggers events on the related object. Will return null if notification was cancelled, returns a persisted object otherwise.
Public methodNotify(String, String, Guid, Int64, Boolean)
Creates a new user notification for this user with the specified message. Note: The returned notification has been saved.
Protected methodProcessPermissions
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.)
Public methodRunInTransactionArea
Runs a code with a transaction on object connection. If there is no current transaction and if the code succeed, transaction is committed. If an exception is thrown, transaction is rollback.
(Inherited from PFBaseObject.)
Public methodSave
Applies the data of this object in the database.
(Overrides PFBaseObjectSave.)
Protected methodSaveObjectsInDataCollection
Saves data loaded from temp specialized object in data properties collection before save or check hasPendingChanges.
(Overrides PFBaseObjectSaveObjectsInDataCollection.)
Public methodToString
Returns a string that represents this user
(Overrides ObjectToString.)
Top
Fields
  NameDescription
Public fieldStatic memberFieldName_AssociatedIdentity
Column name in database.
Public fieldStatic memberFieldName_AvailableInFields
Column name in database.
Public fieldStatic memberFieldName_AvailableInOrganisation
Column name in database.
Public fieldStatic memberFieldName_AvailableInRoles
Column name in database.
Public fieldStatic memberFieldName_DashboardId
Column name in database.
Public fieldStatic memberFieldName_DisplayName
Column name in database.
Public fieldStatic memberFieldName_EmailAddress
Column name in database.
Public fieldStatic memberFieldName_Enabled
Column name in database.
Public fieldStatic memberFieldName_HasPicture
Column name in database.
Public fieldStatic memberFieldName_JobTitle
Column name in database.
Public fieldStatic memberFieldName_LoginName
Column name in database.
Public fieldStatic memberFieldName_Picture
Column name in database.
Public fieldStatic memberFieldName_PrincipalGuid
Column name in database.
Public fieldStatic memberFieldName_SID
Column name in database.
Public fieldStatic memberFieldName_SiteAccess
Column name in database.
Public fieldStatic memberFieldName_ThemeId
Column name in database.
Public fieldStatic memberSystemUserName_AdminAccount
Name of a standard system account.
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodGetString
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
See Also