PFApplication Methods |
The PFApplication type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | 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. |
 | Finalize |
Finalizes an instance of the PFApplication class.
(Overrides ObjectFinalize.) |
| GetActiveTheme |
Gets the theme currently active on the application.
Note: if there is no theme set on the application, the theme of the parent site is returned. |
| GetContextCorrespondingReferenceGroup |
Gets the reference group id corresponding to the specified application context in this application.
A reference group is an organizational (site scope) group used as reference on a context. This method uses an optimized cache. |
| GetContextName |
Gets a context name from its id.
This method uses an optimized cache. |
| GetCurrentUserAvailableContexts |
Gets the list of application contexts available to the current user.
This method uses an optimized cache. |
| 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.) |
| GetReferenceGroupCorrespondingContext |
Gets the application context id corresponding to the specified reference group id in this application.
A reference group is an organizational (site scope) group used as reference on a context. This method uses an optimized cache. |
| GetSupportFileInfo |
Gets the FileInfo of a given file from the folder containing the support files of this application.
|
| GetSupportFilePath |
Gets the full path of a given file from the folder containing the support files of this application.
|
| GetTranslation(Resource, Boolean) |
Gets a translation from a resource, using the current site language or the current user language.
|
| GetTranslation(Resource, String, Boolean) |
Gets a translation from a resource, using the current site language or the current user language.
|
| GetUserAvailableContexts |
Gets the list of application contexts available to the specified user.
This method uses an optimized cache. |
| InitializeLogger |
Use this method to override the way the logger is initialized.
(Inherited from PFStructureObject.) |
| IsContextAvailableForCurrentUser(Int64) |
Determines whether this application is visible for the current user through a specific application context.
This indicates if the user has any membership in the context.
This method uses an optimized cache. |
| IsContextAvailableForCurrentUser(String) |
Determines whether this application is visible for the current user through a specific application context.
This indicates if the user has any membership in the context.
This method uses an optimized cache. |
| IsContextAvailableForUser(Int64, PFUser) |
Determines whether this application is visible for a given user through a specific application context.
This indicates if the user has any membership in the context.
This method uses an optimized cache. |
| IsContextAvailableForUser(String, PFUser) |
Determines whether this application is visible for a given user through a specific application context.
This indicates if the user has any membership in the context.
This method uses an optimized cache. |
| IsCurrentUserContextAdmin(Int64) |
Determines whether the current user is administrator
of a context (any or the specified one) of this application.
This method uses an optimized cache. |
| IsCurrentUserContextAdmin(String) |
Determines whether the current user is administrator
of a context (any or the specified one) of this application.
This method uses an optimized cache. |
| IsUserContextAdmin(PFUser, Int64) |
Determines whether the specified user is administrator
of a context (any or the specified one) of this application.
This method uses an optimized cache. |
| IsUserContextAdmin(PFUser, String) |
Determines whether the specified user is administrator
of a context (any or the specified one) of this application.
This method uses an optimized cache. |
| IsVisibleForCurrentUser |
Determines whether this application is visible for the current user.
This indicates if the user has any membership in the application contexts.
This method uses an optimized cache. |
| IsVisibleForUser |
Determines whether this application is visible for the specified user.
This indicates if the user has any membership in the application contexts.
This method uses an optimized cache. |
| ProcessPermissions |
Compute permissions from permission context and set in data properties.
(Inherited from PFStructureObject.) |
| 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 PFStructureObjectSave.)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). Application visibility cache is also updated. |
| SaveObjectsInDataCollection |
Saves data loaded from temp specialized object
in data properties collection before save or check hasPendingChanges.
(Overrides PFBaseObjectSaveObjectsInDataCollection.) |
| SaveSettings |
Saves the application settings and theme.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TriggerEvent |
Triggers the specified event.
This will call the OnEventTriggered method on the PFApplicationEvents classes of the target applications.
|
| TryGetSupportFileContent |
Tries to get the content of a given file from the folder containing the support files of this application.
|
| TryGetSupportFileStream |
Tries to get the stream of a given file from the folder containing the support files of this application.
|
| TryTranslateApplicationContextId |
Tries to get corresponding application context id from this application to another using reference group.
If an application context with the same reference group is found, its id is returned. Else -1.
|
| Visibility_GetAdminUsers |
Gets the ids of users having an administrator access to this application,
through a specific context if specified.
This method uses an optimized cache. |
| Visibility_GetGroups |
Gets the ids of groups having access to this application, through a specific context if specified.
This method uses an optimized cache. |
| Visibility_GetUsers |
Gets the ids of users having access to this application, through a specific context if specified.
This method uses an optimized cache. |
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.) |
| GetApplicationMapLinks |
Gets the list of links of an application's map (modeling).
(Defined by CoreExtensions.) |
| 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