PFSite Methods |
The PFSite type exposes the following members.
Methods| 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.
|
Extension Methods| 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.) |
See Also