| Event | Triggered When | Default Event Handler | Parameters | Returns | Since |
|---|
| Appcontroller.preAction | A URI is requested | EventsAppControllerCallback::preAction() | void | void | 3.0 |
| Appcontroller.structure | A URI is requested without AJAX | EventsAppControllerCallback::structure() | - controller - The controller being requested
- action - The action being requested
- portal - The portal in use ('admin' or 'client')
| array Key/value pairs to be set as variables in the structure view. Special keys include: - head - Markup to set in the <head> tag
- body_start - Markup to set just after the <body> tag
- body_end - Markup to set just before the </body> tag
| 3.3 |
| Clients.create | A client is created | EventsClientsCallback::create() | - client - An object representing the client that was created.
| void | 3.1 |
| Emails.send | An email template is sent | EventsEmailsCallback::send() | - action - The action that specifies the email group being sent
- options - An array of options passed to Emails::send(), which may include:
- to_client_id - The ID of the client the message was sent to
- from_staff_id - The ID of the staff member the message was sent from
- from - The from address override
- from_name - The from name override
- reply_to - The reply to address override
- tags - A key/value pair of replacement tags for the email.
| array Key/value pairs to merge with tags. | 3.1 |
| Emails.sendCustom | A non-template based email is sent | EventsEmailsCallback::sendCustom() | - options - An array of options passed to Emails::send(), which may include:
- to_client_id - The ID of the client the message was sent to
- from_staff_id - The ID of the staff member the message was sent from
- reply_to - The reply to address override
- tags - A key/value pair of replacement tags for the email.
| array Key/value pairs to merge with tags. | 3.1 |
| Invoices.add | An invoice is created | EventsInvoicesCallback::add() | - invoice_id - The ID of the invoice created
| void | 3.1 |
| Invoices.edit | An invoice is updated | EventsInvoicesCallback::edit() | - invoice_id - The ID of the invoice updated
| void | 3.1 |
| Invoices.setClosed | An invoice is closed | EventsInvoicesCallback::setClosed() | - invoice_id - The ID of the invoice closed
| void | 3.1 |
| Transactions.add | A transaction is created | EventsTransactionsCallback::add() | - transaction_id - The ID of the transaction created
| void | 3.1 |
| Transactions.edit | A transaction is updated | EventsTransactionsCallback::edit() | - transaction_id - The ID of the transaction updated
| void | 3.1 |
| Users.login | A user logs in | EventsUsersCallback::login() | - user_id - The ID of the user that successfully logged in
| void | 3.1 |
| Users.logout | A user logs out | EventsUsersCallback::logout() | - user_id - The ID of the user attempting to log out
| void | 3.1 |
| Navigation.getSearchOptions | Staff search options are displayed | EventsNavigationCallback::getSearchOptions() | - options - A key/value pair of search options where each key is the URI to redirect search queries to and the value is the name of the search option. When implemented, the event handler should modify the options parameter using EventObject::setParams().
- base_uri - The base URI for the currently logged in user.
| void | 3.0 |