PFSite Class |
Namespace: Packflow.Core
public sealed class PFSite : PFStructureObject, IDisposable
The PFSite type exposes the following members.
Name | Description | |
---|---|---|
ActivityLog |
Gets a relation allowing to access timer jobs.
| |
AdminAccount |
Gets the system admin account.
| |
AdministrationUrl |
Url of the site administration.
| |
AdministrationUrl_Roles |
Url of the site administration of roles.
| |
Applications |
All applications installed on this site.
| |
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.) | |
CurrentUser |
Gets the current PFUser of the site.
(Overrides PFStructureObjectCurrentUser.) | |
DashboardId |
Gets or sets the dashboard id, referencing the default dashboard shown to the user.
| |
Dashboards |
Gets a relation allowing to access all global and personal dashboards.
| |
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.) | |
Description |
Gets or sets the description of this object.
(Inherited from PFStructureObject.) | |
DisablePerformanceTestAutoStart |
Gets or sets a value indicating whether the performance test should be started
when the next performance area is encountered.
| |
DisplayName |
Gets or sets the display name of this object.
(Inherited from PFStructureObject.) | |
EnableVersionMergeToResolveSaveConflicts | Read-only property. Can be modified if overridden. 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. | |
EnableVersionMergeToResolveSaveConflicts_Global |
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 all objects loaded from this site instance.
| |
EngineVersion |
Gets the version of Engine (Core) currently running for this site.
| |
EntryRecording |
Gets performance test entry used to record this site performances.
| |
Exists |
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.) | |
Groups |
Gets a relation allowing to access all groups with a scope Site.
| |
Guid |
Gets the GUID identifying this object.
Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.) | |
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.) | |
HomeUrl |
Home page of this site.
| |
Id |
Gets the id identifying this object.
Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.) | |
InstallerAccount |
Gets the system installer account.
| |
ItemComments |
Gets a relation allowing to access comments made on content-type items.
It is usually best to use the relation from PFItem.
| |
ItemsRelations |
Gets a relation allowing to access items relations.
| |
ItemSubscriptions |
Gets a relation allowing to access item subscriptions made on content-type items.
It is usually best to use the relation from PFItem.
| |
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. | |
LanguageCode |
Gets the default language used on this site, in two-letters format.
This language is used for every user using the Default value in their settings. | |
Licence |
Gets the licence data.
| |
LoggedIdentity |
Gets the initial identity used to retrieve this PFSite.
| |
LoggedUser |
Gets the user having initially loaded this PFSite.
| |
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 PFStructureObject.) | |
Logs |
Log entries related to this object.
(Inherited from PFStructureObject.) | |
MembershipProviderAccount |
Gets the membership provider account.
| |
Name |
Gets the name of this object.
(Inherited from PFStructureObject.) | |
NavigationMap |
Gets the navigation map. This map is used in quick launch bars and breadcrumbs.
| |
OrganisationalTypes |
Gets a relation allowing to access organisational types.
| |
PerformanceEntries |
Gets a relation allowing to access performance reports entries.
| |
PerformanceReports |
Gets a relation allowing to access performance reports.
| |
PerformanceTest_IncludeHtmlGenerationDetails |
Gets a value indicating whether the performance test will generate messages with HTML generation.
| |
PerformanceTest_IncludeItemBindingDetails |
Gets a value indicating whether the performance test will include binding operations details.
| |
PermissionContext |
Gets an object calculating permissions on demand.
| |
Permissions |
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.) | |
PersistFileDuringSiteLifeCycle |
Gets or sets a value indicating whether a file should be persisted for each site instance.
When the site instance is disposed, the file is deleted.
Such files are stored in the temp folder of Windows %temp%\PFSites\.
| |
Plugins |
Gets the site plugins.
| |
RunningJobs |
Gets a relation allowing to access running timer jobs.
| |
RunningPerformanceTestReportId |
Gets or sets the id of the currently running test of performance.
| |
Settings |
Gets the site settings.
| |
Site |
Will return the current object.
(Overrides PFBaseObjectSite.) | |
StoredProcedures |
Gets a relation allowing to access stored procedures.
| |
SubViews |
Gets a relation allowing to access the subviews of this site's views.
| |
SupportContact |
Gets the address to contact for support.
| |
ThemeId |
Gets or sets the theme id, referencing the theme commonly used on the site.
See GetActiveTheme method for more information. | |
Themes |
Gets a relation allowing to access all global and personal themes.
| |
TimerJobs |
Gets a relation allowing to access timer jobs.
| |
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.) | |
Url |
Url of the navigation of this site.
(Overrides PFStructureObjectUrl.) | |
UserAlternativeIdentities |
Gets a relation allowing to access all user alternative identities.
| |
Users |
Gets a relation allowing to access the users of this site.
| |
VersionNumber |
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.) | |
Views |
Gets a relation allowing to access all views with a scope Site.
| |
WaitOtherThreadsBeforeDisposing |
Gets or sets a value indicating whether this site should wait for other threads
using this site instance to close before disposing object and connection.
Default value: false. |
Name | Description | |
---|---|---|
CallPluginsT |
Calls plugins of the specified type.
| |
CloseCurrentThreadConnection |
Closes the current thread connection.
This method should always be called at the end of a (new) thread execution using a PFSite.
| |
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. | |
DeleteExpiredLocks |
Deletes all the locks for which the expiration date is exceeded.
| |
Dispose |
Disposes this site.
Ensures that performances are not recorded anymore, disposes the data connection and calls the GC.
| |
EnsureUser |
Will check if PFUser exists based on principal or alternative identity.
If not found, will validate login against AD or local accounts.
If login exists, PFUser will be created and returned.
Throws ValidationException is user could not be found in domain or Packflow.
| |
Finalize |
PFSite destructor, ensuring that the data connection is disposed.
(Overrides ObjectFinalize.) | |
GetActiveTheme |
Gets the theme currently active on the site.
| |
GetApplicationVisibilitiesDisplay |
Gets the list of all application visibilities.
The results contain the display names of Application, Context and User.
| |
GetConnections |
Gets external connections across multiple content-types (or all if not specified) in one query.
| |
GetContentTypes |
Get content-types across multiple applications.
| |
GetContentTypesByIds |
Get content-types across multiple applications.
| |
GetHomeDashboard |
Gets the home dashboard.
Referenced by the CurrentUser.DashboardId if set, else the PFSite.DashboardId. | |
GetObjectRelationByName |
Gets a children entities relation by its name.
(Inherited from PFRelationalObject.) | |
GetObjects |
Gets all objects on specified relations.
Note : do NOT call this method with relations targeting the same SQL table! | |
GetPluginDefinitions |
Gets all available plugins' definitions.
| |
GetPluginInstancesDefinitions |
Gets the definitions of plugin instances created on this site. (not using cache)
| |
GetPluginsT |
Gets plugins of the specified type.
| |
GetSite(String) |
Gets a local Packflow Site by its name.
| |
GetSite(String, IIdentity) |
Gets a local Packflow Site by its name using a specific identity.
| |
GetSite(String, WindowsIdentity) |
Gets a local Packflow Site by its name using a specific identity.
| |
GetSite(String, PFConnectionSelectionMode, String) |
Gets a local Packflow Site by its name.
| |
GetSite(String, IIdentity, PFConnectionSelectionMode, String) |
Gets a local Packflow Site by its name using a specific identity.
| |
GetSite(String, WindowsIdentity, PFConnectionSelectionMode, String) |
Gets a local Packflow Site by its name using a specific identity.
| |
GetSiteSettings |
Gets the settings of a local Packflow Site by its name.
| |
GetSiteTheme |
Gets the default theme for given site name.
| |
GetUserNotifications |
Gets user notifications across multiple users in one query.
| |
GetUserVisibilities |
Gets the complete application/context tree that a user can see from a PFSite.
| |
LoadAllContentTypes |
Ensures that all content-types are loaded in the cache of each application.
This method is optimized because only 2 requests are executed : one for applications and one for content-types. | |
RunCodeInPerformanceArea |
Will automatically start a performance recording/entry
if not already started but in that case Entry name will be 'Unknown'.
| |
RunInPerformanceArea |
Will automatically start a performance recording/entry
if not already started but in that case Entry name will be 'Unknown'.
| |
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.
(Inherited from PFStructureObject.)If this object does not exist in the database yet, the children tables will be ensured. After the save, Insert permissions of children objects are updated in the database (RLS). | |
SavePlugins |
Saves site plugins to database.
Important : access will be denied if the user is not Site Admin. Important : this saves a separated instance of PFSite. To save this site again, you have to reload this object. | |
SaveSettings |
Saves site settings to database.
Important : access will be denied if the user is not Site Admin. Important : this saves a separated instance of PFSite. To save this site again, you have to reload this object. | |
SendMail(String, ListPFUser, IHtmlString, Boolean, PFMailInvitation) |
Sends an email to multiple Packflow users.
| |
SendMail(String, IHtmlString, PFUser, Boolean, PFMailInvitation) |
Sends an email to a Packflow user.
| |
SendMail(String, IHtmlString, String, Boolean, PFMailInvitation, String) |
Sends an email to a given address.
| |
SendMailFromCustomHost |
Sends an email to a Packflow user, using a different host from default.
| |
SendPlainTextMail(String, ListPFUser, String, Boolean, PFMailInvitation) |
Sends an email to multiple Packflow users.
| |
SendPlainTextMail(String, String, PFUser, Boolean, PFMailInvitation) |
Sends an email to a Packflow user.
| |
SendPlainTextMail(String, String, String, Boolean, PFMailInvitation, String) |
Sends an email to a given address.
| |
SetLicence |
Sets the licence for this Site.
| |
SetPlugins |
Saves the plugin definitions.
| |
StartPerformanceTest | Starts a global performance test filling a given performance report. This test will include all web requests targeting this PFSite, but not the current one. Use the method StopPerformanceTest to stop the global test. | |
StartRecordingPerformances |
Starts recording performance on this site.
| |
StopPerformanceTest |
Stops the global performance test started with the method StartPerformanceTest.
| |
StopRecordingPerformances |
Saves the current performance entry and stops the recording.
| |
SynchronizeAllExternalContent |
Synchronizes the external connections of all content-types.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TryGetSite(String) |
Tries to get a local Packflow Site by its name.
| |
TryGetSite(String, IIdentity) |
Tries to get a local Packflow Site by its name using a specific identity.
| |
TryGetSite(String, WindowsIdentity) |
Tries to get a local Packflow Site by its name using a specific identity.
| |
TryTranslateApplicationContextId |
Tries to get corresponding application context id from an application to another using reference group.
If an application context with the same reference group is found, his id is returned. Else -1.
|
Name | Description | |
---|---|---|
ItemCommentCreated |
Event called when a PFItemComment was created.
| |
ItemCommentUpdated |
Event called when a PFItemComment was updated.
| |
ItemEventCreated |
Event called when a PFItemEvent was created.
| |
ItemSubscriptionCreated |
Event called when a PFItemSubscription was created.
| |
ItemSubscriptionUpdated |
Event called when a PFItemSubscription was updated.
| |
LockDeleted |
Event called if lock deleted.
| |
TaskCreated |
Event called if a task is created.
| |
UserNotified |
Event called when a user has been notified.
|
Name | Description | |
---|---|---|
FieldName_DashboardId |
Column name in database.
| |
FieldName_EngineVersion |
Column name in database.
| |
FieldName_RunningPerformanceTestReportId |
Column name in database.
| |
FieldName_ThemeId |
Column name in database.
|
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.) |