IAppContext Methods |
The IAppContext type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AuthenticateUser(String) |
Authenticates a user and populates the UserContext object.
Note that if the application is being used to authenticate a different user than the one associated
with the application (and therefore the user represented by UserContext) you
must use the AuthenticateUser command.
|
| AuthenticateUser(String, String, String) |
Authenticates the current user and populates/creates the UserContext object
using the specified IAuthenticationProvider.
Note that if the application is being used to authenticate a different user than the one associated
with the application (and therefore the user represented by UserContext) you
must use the AuthenticateUser command.
|
| AuthenticateUser(String, String, String, Int32) |
Authenticates the current user and populates/creates the UserContext object
using the specified IAuthenticationProvider.
Note that if the application is being used to authenticate a different user than the one associated
with the application (and therefore the user represented by UserContext) you
must use the AuthenticateUser command.
|
| Clone |
Clones this object and returns a new AppContext object.
|
| Clone(String, String) |
Clones this object and returns a new AppContext object.
|
| Clone(String, String, String) |
Clones this object and returns a new AppContext object.
|
| Close |
Closes the application's internal datasources and clean's up any user token state that exist.
|
| DisplayMessage(Alert) |
Registers a message, specified by the Alert object, for display on the next page rendering.
Note that this page message facility is built on top of the existing Alerts functionality. The message
information is stored in the xot_alerts table and delivered asynchronously via an AJAX call upon
the next page rendering.
|
| DisplayMessage(String, String, AlertDelivery, Int32, AlertAttrs) |
Registers a message for display on the next page rendering.
Note that this page message facility is built on top of the existing Alerts functionality. The message
information is stored in the xot_alerts table and delivered asynchronously via an AJAX call upon
the next page rendering.
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| Exec |
The Exec method provides extended functionality.
(Inherited from IEAPBase.) |
| GetFirstNavigablePage |
Returns the first navigable page for this user
|
| GetPageInfo(String) |
Get the PageInfo object for the specified MOP.
|
| GetPageInfo(String, GetPageFlags) |
Get the PageInfo object for the specified MOP per the provided flags.
|
| GetPermaLink |
Returns a permanant link to an item by inserting the QueryString parameters supplied into the
main database's xot_url table.
|
| GetResourceString |
Returns the string for the given resource for this application's Culture.
|
| GetText(String) |
Returns a string from the TextItems collection
|
| GetText(String, String) |
Returns a string from the TextItems collection
|
| HasFeature(String) |
Returns true if the feature is implemented on the application.
|
| HasFeature(String, String) |
Returns true if the feature is implemented on the application and the requested property is used.
|
| HasPermission |
Returns true if the specified object "has" the specified ObjectPermissions. If the object has no assigned permisions,
the return value is true.
|
| HasPolicy(String) | Obsolete.
Returns true if the current user has not been explicitly denied the policy.
NOTE: This method is deprecated. Use HasPolicy(String, Boolean) instead for improved security. |
| HasPolicy(String, Boolean) |
Returns true if the current user has been granted the policy.
|
| Hibernate |
Command the AppContext object to hibernate until next round trip.
Hibernated applications's are awoken via WakeUp.
|
| Init |
Initialize the AppContext object.
|
| Init(AppContextInitOptions) |
Initialize the AppContext object based on the provieded AppContextInitOptions.
|
| Load |
Load the AppContext object from the database.
|
| LoadComponent |
Finds the specified component in the application's Components collection, loads
it, verfies that it implements the requested interface (if specified), and returns the object.
Normally an appropriate AssemblyLoadFail exception will be thrown if the component could not be found, loaded
or requested interface obtained for any reason. However, if OkIfNotFound is set
a failure will suppress any such error and result in null being returned.
|
| LogPerformance |
Log the performance metric of an object using a diagnostic service
|
| Navigate(String) |
Causes a Redirect to the specified page.
|
| Navigate(String, String) |
Causes a Redirect to the specified page.
|
| Navigate(String, String, String) |
Causes a Redirect to the specified page.
|
| Navigate(String, String, String, String) |
Causes a Redirect to the specified page.
|
| Navigate(String, String, String, String, NavigateAttrs, String) |
Causes a Redirect to the specified page.
|
| OpenRepository |
Open the repository IDatabase.
|
| Permissions |
Returns a bitmask of the object's ObjectPermissions. If the object has no assigned permissions,
the return value is 0xffffffff (All permission bits are set)
|
| RegisterDebugInfo(Page, String, String) |
Register a dbginfo item on the page.
These items will be emitted into the page HTML for debugging
purposes and may be viewed by hitting F8 on the page.
|
| RegisterDebugInfo(Page, String, String, String) |
Register a dbginfo item on the page (with category information).
These items will be emitted into the page HTML for debugging
purposes and may be viewed by hitting F8 on the page.
|
| RegisterDebugInfo(Page, String, String, String, LogMessageLevel) |
Register a dbginfo item on the page (with caetgory and severity level).
These items will be emitted into the page HTML for debugging
purposes and may be viewed by hitting F8 on the page.
|
| RegisterDebugInfo(Page, String, String, String, String) |
Register a dbginfo item on the page (with category and sublist information).
These items will be emitted into the page HTML for debugging
purposes and may be viewed by hitting F8 on the page.
|
| RegisterDebugInfo(Page, String, String, String, String, LogMessageLevel) |
Register a dbginfo item on the page (with full information).
These items will be emitted into the page HTML for debugging
purposes and may be viewed by hitting F8 on the page.
|
| RegisterEmbeddedFunction(String, String) |
Registers an embedded function for use in SQL statments. The function name should not include
the leading lowercase 'fn' associated with embedded functions.
See EmbeddedParser for more information on embedded functions. |
 | RegisterEmbeddedFunction(String, String, String) |
Registers an embedded function for use in SQL statments. The function name should not include
the leading lowercase 'fn' associated with embedded functions.
See EmbeddedParser for more information on embedded functions. Embedded functions are automatically resolved for both DefaultValues on Field objects and Filters on Mapper objects. Normally, you register an extension to run at startup and register custom functions in the ExtensionEvents.ApplicationAfterLoad event. |
| ResolveEmbeddedFunctions |
Resolve an expression string for embedded functions.
See EmbeddedParser for more information on embedded functions.
|
| Send(MailMessage) |
Sends an email message using the contents of the message object.
|
| Send(MailMessage, String) |
Sends an email message using the contents of the message object and the specified email service.
|
| SetUserTimeZone |
Sets the user's timezone.
|
| UrlRead |
Reads a URL from the database xot_url table. URL's are generally stored in this manner for one of two purposes:
1) For permanent use as a saved reference of some type, and
2) As a temporary URL whose reference is passed as a query parameter (for security and to reduce query parameter size).
Use UrlSave(String, UrlLinkType, NullableDateTime) to save URL's.
|
| UrlSave |
Stores a URL in the database xot_url table. URL's are generally stored in this manner for one of two purposes:
1) For permanent use as a saved reference of some type, and
2) As a temporary URL whose reference is passed as a query parameter (for security and to reduce query parameter size).
Use UrlRead(String) to retrieve saved URL's.
|
| UsesImplicitVocab |
Returns true if the locationAttrs supports implicit vocab.
|
| ValidateCSRFToken |
Validates the specified token against the CSRFToken.
Note that if the ThrowStandardError option is specified then
this method will throw the standard invalid CSRF token exception and will not return.
|
| WakeUp |
Command the AppContext object to wake up the database connections.
Applications are hibernated via Hibernate.
|
| WakeUp(WakeUpFlags) |
Command the AppContext object to wake up the database connections.
Applications are hibernated via Hibernate.
|
Extension Methods| Name | Description | |
|---|---|---|
 | BootstrapVersion |
Returns the current Bootstrap version.
For example, if the current version is 3.3.6
then this method returns 336. If it was version
4.1.3 then this method returns 413.
(Defined by AppContextExtensions.) |
| LogException |
Logs an error and writes it to the request log
(Defined by ApplicationExtensionMethods.) |
| LogNextMapperSource |
Extension method to IAppContext object to set a one-time-use logSource to be used on the next IMapper Init().
(Defined by AppContextExtensions.) |
| UIStyle |
Gets the AppUIStyle application UI style.
(Defined by AppContextExtensions.) |
| UseBootstrap |
Determines of this is a Bootstrap-based application.
Note that currently this determination is based on whether or not bootstrap.master is set as the MasterPageFile.
(Defined by AppContextExtensions.) |
| UserAuthenticationView |
Gets the AuthenticationView for the application
which is the view to use for the DatabaseAuthenticationProvider during authentication. By default this is 'users'.
(Defined by ApplicationExtensionMethods.) |
See Also