ApplicationExtensionBase Class

Initializes a new instance of the ApplicationExtensionBase class

Returns the application object.

Gets whether or not the extension is a platform extension vs. a custom extension.

Gets/Sets the owner of this object

Returns this instance's properties.

Returns a collection of TextItems loaded from metadata related to this component.

Fired immediately after the configured IAuthenticationProvider object's Authenticate(String, String, NameValueCollection, Int64) method is called. At this point the user has been authenticated and the profiles for the user have been loaded.

Called immediately after the application is loaded.

Called after sending email and after the email is logged. Return values are ignored, throw an exception if an error happens in the after event.

Called when an an alert is about to be delivered to the user. Such alerts include user messages created using DisplayMessage(Alert) or one of its overloads.

Fired immediately when the configured IAuthenticationProvider object's Authenticate(String, String, NameValueCollection, Int64) method fails. This event gives us the opportunity to perform certain actions when this event is fired. An example use-case for this event would be to capture the fact that authentication failed in an audit table / database.

Fired immediately before the configured IAuthenticationProvider object's Authenticate(String, String, NameValueCollection, Int64) method is called. This event give you an opportunity to change the user and password of the user being logged in. If you return any other value besides Continue an exception is thrown and the login is cancelled.

Called before profiles are loaded by the IAuthenticationProvider. Currently (version 2.4) only the DatabaseAuthenticationProvider fires this event.

Called before sending email and before the email is logged. Set e.Result to Cancel to stop sending and exit, ContinueNoExec to skip sending.

Called immediately before showing a report resulting in the ApplicationBeforeShowReport event being fired. This is part of the platform security mechanism used to prevent inproper access to SSRS reports.

Called to start the 2-factor authentication process. The normal result here would be to send a text or email with the code and set the ValidationPage and Profiles properties on the e parameter. If the ValidationPage value is set then, following this event, a redirect to the page will be performed. The 2-factor authentication code to send will already have been stored and is provided in the AuthCode. You can set AuthCode and/or AuthCodeExpires during this event if you want different values and those new values will be stored.

Called during Breadcrumbs(IAppContext, BreadcrumbsEventArgs) creation to provide the application with an opportunity to construct a custom breadcrumb trail instead of the standard platform breadcrumb trail. Breadcrumbs are normally automatically constructed by the platform to represent a navigation history, but by handling this event your application can create a custom breadcrumb trail. One example of a custom breadcrumb trail would be a breadcrumb trail representing the application's object hierarchy rather than a navigation history. Before constructing the standard platform breadcrumb trail, the ApplicationBreadcrumbs event is fired. If the event handler returns a DataChanged result then the Breadcrumbs will be used instead of the standard breadcrumbs. You can return ContinueNoExec to suppress the breadcrumb trail. Note that you can call the GetBreadcrumbs(IAppContext, String) method during the event handling to get the standard breadcrumbs.

Fired when an incoming call is received by the application.

Determines whether the specified Object is equal to the current Object.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

Serves as a hash function for a particular type.

Called before the Mail Service is constructed. This happens before the BeforeSendMail event

Gets a descriptive name for the provided object (which is presumably the extension owner object).

Gets the Type of the current instance.

Method overridden in dervied classes that handles type specfic events.

Return requested information about the extension.

Called when an email message is parsed by the SendGrid parse API.

Called by a IMapper at the end of its Load, immediately following the mapper's MapperAfterLoad event. This provides the application with the opportunity to "hook" every mapper. One possible use would be to add a "global" extension to every mapper.

Creates a shallow copy of the current Object.

Fired when an incoming message is received by the application.

Fired when a message is delivered, sent, or failed.

IExtension.OnEvent handler. Note that generally speaking, you will want to override the individual methods specific to the event and not implement the interface directly.

Called when the password is changed by a user

When the Owner is attached to this extension, verifies that the object an application object (implementing IAppContext). Attaching any other object indicates that this extension was likely attached to the wrong type of object and results in a devlog to that effect.

Notifies the extension that it should perform any cleanup necessary just prior to being unloaded.

Called during page initialization in response to a ApplicationPageHtml event. Currently this is called for some HTML-only pages which are typically the result of AJAX requests.

A common use for this event is to register application-wide .js and .css files.

This event is NOT fired for pages built from a standard IPageTemplate-implementing template. For such, the ApplicationPageInit event is fired instead.

Called during page initialization in response to a ApplicationPageInit event. Currently this is called for all pages built from a standard IPageTemplate-implementing template. This includes the ConsoleTemplate, BootConsoleTemplate, WizTemplate, TabbedSubformTemplate, ExpandedSubformTemplate, and PopupDialogTemplate as well as other special-purpose templates. The event is fired at the end of the standard page template initialization, but before template-specific initialization. In essense this means that the event is fired mid-initialization and the extact state of the initialization will vary from template-type to template-type.

A common use for this event is to register application-wide .js and .css files.

For HTML-only pages, the ApplicationPageHtml event may be fired instead.

The password has been changed. Fired before email is sent to the user. See related events PasswordReset(IAppContext, ApplicationPasswordArgs) and PasswordSend(IAppContext, ApplicationPasswordArgs).

The password has been reset. Fired before email is sent to the user. See related events PasswordChanged(IAppContext, ApplicationPasswordArgs) and PasswordSend(IAppContext, ApplicationPasswordArgs).

The password is about to be sent to the user. Fired before email is sent to the user. See related events PasswordChanged(IAppContext, ApplicationPasswordArgs) and PasswordReset(IAppContext, ApplicationPasswordArgs).

Returns a String that represents the current Object.

Fired when an outbound call is made through Dial(String, String, String) (or any Dial overload).

Fired when call status changes.

Called after the application has been re-initialized (databases reconnected, pages and navigators reloaded, if necessary)

Called when a webhook is processed.

Fired when an incoming WebService request is received by the application.

Called when the Zoom service receives a meeting webhook request. See IZoom for more information about the Zoom service. Examples of Zoom meeting events include:

1. meeting.started
2. meeting.ended
3. meeting.participant_joined
4. meeting.participant_left
5. meeting.participant_jbh_waiting

Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.