Reference
All Reference
An edge has been deleted Note that the Context for this notification does not have the user who deleted the edge.
An edge has been inserted. Note that the Context for this notification does not have the user who created the edge.
An edge has been updated Note that the Context for this notification does not have the user who updated the edge.
Add a handler for receiving e-mail notifications
Bounced e-mail notification. The recipient is the e-mail that is bouncing. When the the message_nr is unknown the it is…
Return the options for the DKIM signature on outgoing emails. Called during email encoding.
Drop an e-mail handler for a user/resource id. (notify). The notification, user and resource should be the same as when…
observe_email_ensure_handler/2
Add a handler for receiving e-mail notifications
Notify that we could NOT send an e-mail (there might be a bounce later...) The Context is the depickled z_email:send/2…
Check if an email address is blocked
observe_email_is_recipient_ok/2
Check if an email address is safe to send email to. The email address is not blocked and is not marked as bouncing.
Notification sent to a site when e-mail for that site is received
Add a handler for receiving e-mail notifications
Notify that we could NOT send an e-mail (there might be a bounce later...) The Context is the depickled z_email:send/2…
Email status notification, sent when the validity of an email recipient changes
observe_export_resource_content_disposition/2
mod_export - return the \{ok, Disposition\} for the content disposition.
observe_export_resource_content_type/2
mod_export - Determine the mime type for the export.
observe_export_resource_data/2
mod_export - fetch a row for the export, can return a list of rows, a binary, and optionally a continuation state.
observe_export_resource_encode/2
mod_export - Encode a single data element.
observe_export_resource_filename/2
mod_export - return the \{ok, Filename\} for the content disposition.
observe_export_resource_footer/2
mod_export - Fetch the footer for the export. Should cleanup the continuation state, if needed.
observe_export_resource_header/2
mod_export - Fetch the header for the export.
observe_export_resource_visible/2
mod_export - Check if the resource or dispatch is visible for export.
Broadcast some file changed, used for livereload by mod_development
Signal that the hierarchy underneath a resource has been changed by mod_menu
Access log event for http. Called from the z_stats.
observe_identity_password_match/2
Check if passwords are matching. Uses the password hashing algorithms.
observe_identity_update_done/2
Notify that a user’s identity has been updated by the identity model.
observe_identity_verification/2
Request to send a verification to the user. Return ok or an error. Handled by mod_signup to send out verification…
Notify that a user’s identity has been verified. Signals to modules handling identities to mark this identity as…
observe_import_csv_definition/2
Find an import definition for a CSV file by checking the filename of the to be imported file.
An external feed delivered a resource. First handler can import it. Return:: {ok, m_rsc:resource_id()} , `{error
Notify that the session’s language has been changed
Try to detect the language of a translation. Set is_editable_only to false to detect any language, even if the language…
Check for logon options, called if logon_submit returns undefined. This is used to fetch external (or local…
Check where to go after a user logs on.
Handle a user logon. The posted query args are included. Return:: {ok, UserId} or {error, Reason}
Send a page to a mailinglist (notify) Use \{single_test_address, Email\} when sending to a specific e-mail address.
Send a welcome or goodbye message to the given recipient. The recipient is either a recipient-id or a recipient props.
Site configuration parameter was changed
observe_m_config_update_prop/2
Site configuration parameter was changed
observe_media_identify_extension/2
Try to find a filename extension for a mime type (example: <<".jpg"\>\> )
Try to identify a file, returning a map with file properties.
Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue…
Notification to import a medium record from external source. This is called for non-file medium records, for example…
observe_media_preview_options/3
Modify the options for an image preview url or tag. This is called for every image url generation, except if the…
Notification that a medium file has been changed (notify) The id is the resource id, medium contains the medium’s…
See if there is a ‘still’ image preview of a media item. (eg posterframe of a movie) Return:: {ok, ResourceId} or…
Media update done notification. action is ‘insert’, ‘update’ or ‘delete’
observe_media_upload_preprocess/2
Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue…
Notification that a medium file has been uploaded. This is the moment to change properties, modify the file etc. The…
observe_media_upload_rsc_props/3
Notification that a medium file has been uploaded. This is the moment to change resource properties, modify the file…
Request to generate a HTML media viewer for a resource. The HTML data can not contain any Javascript, as it might be…
observe_media_viewer_consent/2
Optionally wrap HTML with external content so that it adheres to the cookie/privacy settings of the current site…
Fetch the menu id belonging to a certain resource
Save the menu tree of a menu resource
Delegates the request processing.
A module has been activated and started.
A module has been stopped and deactivated.
Fold for mapping non-iolist output to iolist values.
Fetch the url of a resource’s html representation
Foldr to change or add pivot fields for the main pivot table. The rsc contains all rsc properties for this resource
Fold over the resource props map to extend/remove data to be pivoted
Pivot just before a m_rsc_update update. Used to pivot fields before the pivot itself.
Handle a javascript notification from the postback handler. The message is the the request, trigger the id of the…
Refresh the context or request process for the given request or action
Let all modules add resource specific response headers to the request. The accumulator is the list of headers to be set.
Resource will be deleted. This notification is part of the delete transaction, it’s purpose is to clean up associated…
Resource is read, opportunity to add computed fields Used in a foldr with the read properties as accumulator.
Fetch the data for an import of a resource. Returns data in the format used by m_rsc_export and m_rsc_import. Either…
Foldr for an resource insert, these are the initial properties and will overrule the properties in the insert request.
Map to signal merging two resources. Move any information from the loser to the winner. The loser will be deleted.
Signal that a resource pivot has been done.
Send a notification that the resource ‘id’ is added to the query query_id.
An updated resource is about to be persisted. Observe this notification to change the resource properties before they…
An updated resource has just been persisted. Observe this notification to execute follow-up actions for a resource…
Upload and replace the resource with the given data. The data is in the given format.
Sanitize an HTML element.
Sanitize an embed url. The hostpart is of the format: <<"youtube.com/v..."\>\> .
Add extra javascript with the \{% script %\} tag. (map) Used to let modules inject extra javascript depending on the…
Map a custom search term to a #search_sql_term{} record.
Map a custom search term to a #search_sql_term{} record.
Check and possibly modify the http response security headers All headers are in lowercase.
Refresh the context or request process for the given request or action
Set the language of the context to a user’s prefered language
Request a signup of a new or existing user. Arguments are similar to #signup_url\{\} Returns \{ok, UserId\} or \{error
signup_check Check if the signup can be handled, a fold over all modules. Fold argument/result is \{ok, Props
Signal that a user has been confirmed. (map, result is ignored)
observe_signup_confirm_redirect/2
Fetch the page a user is redirected to after signing up with a confirmed identity
Signal that a user has been signed up (map, result is ignored)
Signup failed, give the error page URL. Return \{ok, Url\} or undefined. Reason is returned by the signup handler for…
Handle a signup of a user, return the follow on page for after the signup. Return {ok, Url} ‘props’ is a map with…
Request the SSL certificates for this site. The server_name property contains the hostname used by the client. (first…
Fetch list of handlers for survey submits.
observe_survey_is_allowed_results_download/2
Check if the current user is allowed to download a survey.
Check if a question (page block) is a submitting question.
observe_survey_result_columns/3
Add header columns for export. The values are the names of the answers and the text displayed above the column. The…
observe_survey_result_column_values/3
Modify row with answers for export. The header columns are given and the values that are known are set in the folded…
A survey has been filled in and submitted.
Delete a value from the typed key/value store