PFUser Class |
Namespace: Packflow.Core
public class PFUser : PFRelationalObject, IPrincipal
The PFUser type exposes the following members.
Name | Description | |
---|---|---|
AvailableInFields |
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. | |
AvailableInOrganisation |
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. | |
AvailableInRoles |
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. | |
BeforeSaveValues |
Gets the previous values of modified fields before the latest Save.
(Inherited from PFBaseObject.)Note: this feature is NOT persisted in the database and therefore only concerns this instance. | |
CanDelete |
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.) | |
CanRead |
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.) | |
CanUpdate |
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.) | |
Created |
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.) | |
CreatedAt |
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.) | |
CreatedBy |
Gets the user who created this object in the database.
(Inherited from PFBaseObject.) | |
CustomSettings |
Gets the dictionary hosting custom settings. Use this object to store user application-related settings.
| |
DashboardId |
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. | |
Data |
Gets the data collection of this object.
(Inherited from PFBaseObject.) | |
DateObjectCreation |
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.) | |
Deleted |
True if this object is flagged as deleted.
(Inherited from PFBaseObject.) | |
DeletedAt |
Date of the suppression of this object.
(Inherited from PFBaseObject.) | |
DeletedBy |
The user who deleted this object.
(Inherited from PFBaseObject.) | |
DisplayName |
Gets or sets the user's display name.
| |
EffectiveLanguageCode |
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.
| |
EffectiveLocale |
Gets the locale code corresponding to the current EffectiveLanguageCode.
E.g. "en-gb" is returned for the "en" language code.
| |
EffectiveNotificationSystem |
Gets the effective notification system.
| |
EmailAddress |
Gets or sets the user's email address.
| |
Enabled |
Gets or sets a value indicating whether the user is enabled in Packflow.
This value has an impact on various other properties like "SiteAccess".
| |
EnableVersionMergeToResolveSaveConflicts |
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.) | |
Exists |
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.) | |
ForbiddenChararacters |
Gets the list of characters forbidden in a user display name.
| |
Guid |
Gets the GUID identifying this object.
Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.) | |
HasAssociatedIdentity |
Gets a value indicating whether this user has an associated identity.
| |
HasPendingModifications |
Checks if there is pending changes.
Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.) | |
HasPendingPermissionsModifications |
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.) | |
HasPicture |
Gets a value indicating whether this user has a picture.
| |
Id |
Gets the id identifying this object.
Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.) | |
Identity |
Gets the identity of this user. Not available for system users.
| |
IsSystemUser |
Gets a value indicating whether this user is a system user (=not a person).
| |
JobTitle |
Gets or sets the job title.
| |
KeepBeforeSaveValues |
Gets or sets a value indicating whether
the Save should keep a collection of the modified fields previous values.
(Inherited from PFBaseObject.)Note: this feature is NOT persisted in the database and therefore only concerns this instance. | |
Logger |
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.) | |
LogIdentification |
Gets a technical text representing this object.
(Inherited from PFBaseObject.) | |
LoginName |
Gets the user's login name.
| |
NavigationEntries |
Gets a relation allowing to access all navigation entries of this user.
| |
Notifications |
Gets a relation allowing to access all notifications of this user.
| |
PermissionContext |
Gets an object calculating permissions on demand.
| |
Permissions |
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.) | |
PermissionSetDeleteId |
Id of the permission set for Delete access.
(Inherited from PFBaseObject.) | |
PermissionSetDeleteXml |
XML of serialized permission set for Delete access.
(Inherited from PFBaseObject.) | |
PermissionSetReadId |
Id of the permission set for Read access.
(Inherited from PFBaseObject.) | |
PermissionSetReadXml |
XML of serialized permission set for Read access.
(Inherited from PFBaseObject.) | |
PermissionSetUpdateId |
Id of the permission set for Update access.
(Inherited from PFBaseObject.) | |
PermissionSetUpdateXml |
XML of serialized permission set for Update access.
(Inherited from PFBaseObject.) | |
Picture |
Gets or sets the user picture.
| |
PrincipalGuid |
Gets the GUID of the principal corresponding to this user.
Note : local (computer) users do not have principal GUID. | |
Settings |
Gets the user settings.
| |
SID |
Gets the Security ID (SID) of the principal corresponding to this user.
| |
Site |
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.) | |
SiteAccess |
Gets or sets a value indicating how the user can access the Packflow site.
Note : this property returns None if Enabled is False. | |
ThemeId |
Gets or sets the theme id, referencing the theme used by the user.
If set, this overrides the ThemeId property on the PFSite. | |
UpdatedAt |
Gets the date of the last update of this object.
(Inherited from PFBaseObject.) | |
UpdatedBy |
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.) | |
UserGuid |
Gets the user GUID.
| |
VersionNumber |
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.) |
Name | Description | |
---|---|---|
CompareIdentity |
Compares the current user with the specified identity.
| |
Delete |
Flags this object as deleted.
(Inherited from PFBaseObject.)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. | |
GetActiveTheme |
Gets the theme currently used by the user. Returns null if current user has no active theme.
| |
GetCustomHomeDashboard |
Gets the home dashboard currently used by the user.
Returns null if current user has no custom home dashboard.
| |
GetItemComments |
Gets a list of comments made by this user on items.
The ParentItem property of returned comments will not be initialized. | |
GetItemsFiltersForCurrentContextFilters |
This will generate PFQuery filters allowing
to filter items according to this user current context filters.
| |
GetItemSubscriptions |
Gets a list of subscriptions made by this user on items.
The ParentItem property of returned comments will not be initialized. | |
GetLocks |
Gets the list of object locks owned by this user, ordered by creation date descending.
| |
GetNewPermissionContext |
Creates a new permission context based on current object type.
(Overrides PFBaseObjectGetNewPermissionContext.) | |
GetObjectRelationByName |
Gets a children entities relation by its name.
(Inherited from PFRelationalObject.) | |
GetPictureRelativeURL(Boolean) |
Gets the relative URL of this user's picture.
| |
GetPictureRelativeURL(Boolean, Int64) |
Gets the relative URL of the specified user's picture.
| |
GetTemporaryKey |
Gets a daily temporary key for this user.
| |
GetUserUrl |
Gets the user form URL.
| |
GetUserUrl(PFSite, Int64) |
Gets the form URL of the specified user having the specified parent site.
| |
InitializeLogger |
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.) | |
IsInRole |
IPrincipal implementation. Throws NotImplementedException.
| |
Notify(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.
| |
Notify(String, String, Guid, Int64, Boolean) |
Creates a new user notification for this user with the specified message.
Note: The returned notification has been saved.
| |
ProcessPermissions |
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.) | |
RunInTransactionArea |
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.) | |
Save |
Applies the data of this object in the database.
(Overrides PFBaseObjectSave.) | |
SaveObjectsInDataCollection |
Saves data loaded from temp specialized object
in data properties collection before save or check hasPendingChanges.
(Overrides PFBaseObjectSaveObjectsInDataCollection.) | |
ToString |
Returns a string that represents this user
(Overrides ObjectToString.) |
Name | Description | |
---|---|---|
FieldName_AssociatedIdentity |
Column name in database.
| |
FieldName_AvailableInFields |
Column name in database.
| |
FieldName_AvailableInOrganisation |
Column name in database.
| |
FieldName_AvailableInRoles |
Column name in database.
| |
FieldName_DashboardId |
Column name in database.
| |
FieldName_DisplayName |
Column name in database.
| |
FieldName_EmailAddress |
Column name in database.
| |
FieldName_Enabled |
Column name in database.
| |
FieldName_HasPicture |
Column name in database.
| |
FieldName_JobTitle |
Column name in database.
| |
FieldName_LoginName |
Column name in database.
| |
FieldName_Picture |
Column name in database.
| |
FieldName_PrincipalGuid |
Column name in database.
| |
FieldName_SID |
Column name in database.
| |
FieldName_SiteAccess |
Column name in database.
| |
FieldName_ThemeId |
Column name in database.
| |
SystemUserName_AdminAccount |
Name of a standard system account.
|
Name | Description | |
---|---|---|
AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) | |
EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) | |
EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) | |
GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) | |
IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) | |
IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) | |
Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) | |
Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) | |
SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) | |
SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) | |
SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |