Documentation

Notifications

observe_dropbox_file/2

Handle a new file received in the ‘files/dropbox’ folder of a site. Unhandled files are deleted after an hour. If the handler returns ‘ok’ then the file is…

Notifications

observe_edge_delete/2

An edge has been deleted Note that the Context for this notification does not have the user who deleted the edge.

Notifications

observe_edge_insert/2

An edge has been inserted. Note that the Context for this notification does not have the user who created the edge.

Notifications

observe_edge_update/2

An edge has been updated Note that the Context for this notification does not have the user who updated the edge.

Notifications

observe_email_add_handler/2

Add a handler for receiving e-mail notifications

Notifications

observe_email_bounced/2

Bounced e-mail notification. The recipient is the e-mail that is bouncing. When the the message_nr is unknown the it is set to ‘undefined’. This can happen if…

Notifications

observe_email_dkim_options/2

Return the options for the DKIM signature on outgoing emails. Called during email encoding.

Notifications

observe_email_drop_handler/2

Drop an e-mail handler for a user/resource id. (notify). The notification, user and resource should be the same as when the handler was registered.

Notifications

observe_email_ensure_handler/2

Add a handler for receiving e-mail notifications

Notifications

observe_email_failed/2

Notify that we could NOT send an e-mail (there might be a bounce later...) The Context is the depickled z_email:send/2 context.

Notifications

observe_email_is_blocked/2

Check if an email address is blocked

Notifications

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.

Notifications

observe_email_received/2

Notification sent to a site when e-mail for that site is received

Notifications

observe_email_send_encoded/2

Add a handler for receiving e-mail notifications

Notifications

observe_email_sent/2

Notify that we could NOT send an e-mail (there might be a bounce later...) The Context is the depickled z_email:send/2 context.

Notifications

observe_email_status/2

Email status notification, sent when the validity of an email recipient changes

Notifications

observe_export_resource_content_disposition/2

mod_export - return the {ok, Disposition} for the content disposition.

Notifications

observe_export_resource_content_type/2

mod_export - Determine the mime type for the export.

Notifications

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. Where Values is [ term() ], i.e. a list of…

Notifications

observe_export_resource_encode/2

mod_export - Encode a single data element.

Notifications

observe_export_resource_filename/2

mod_export - return the {ok, Filename} for the content disposition.

Notifications

observe_export_resource_footer/2

mod_export - Fetch the footer for the export. Should cleanup the continuation state, if needed.

Notifications

observe_export_resource_header/2

mod_export - Fetch the header for the export.

Notifications

observe_export_resource_visible/2

mod_export - Check if the resource or dispatch is visible for export.

Notifications

observe_filewatcher/2

Broadcast some file changed, used for livereload by mod_development

Notifications

observe_hierarchy_updated/2

Signal that the hierarchy underneath a resource has been changed by mod_menu

Notifications

observe_identity_password_match/2

Check if passwords are matching. Uses the password hashing algorithms.

Notifications

observe_identity_update_done/2

Notify that a user’s identity has been updated by the identity model.

Notifications

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 emails. Identity may be undefined, or is an…

Notifications

observe_identity_verified/2

Notify that a user’s identity has been verified. Signals to modules handling identities to mark this identity as verified. Handled by mod_admin_identity to…

Notifications

observe_import_csv_definition/2

Find an import definition for a CSV file by checking the filename of the to be imported file.

Notifications

observe_import_resource/2

An external feed delivered a resource. First handler can import it. Return:: {ok, m_rsc:resource_id()} , {error, Reason} , or undefined

Notifications

observe_language/2

Notify that the session’s language has been changed

Notifications

observe_language_detect/2

Try to detect the language of a translation. Set is_editable_only to false to detect any language, even if the language is not enabled for the site. Return…

Notifications

observe_logon_options/3

Check for logon options, called if logon_submit returns undefined. This is used to fetch external (or local) authentication links for a username. Return:: map()

Notifications

observe_logon_ready_page/2

Check where to go after a user logs on.

Notifications

observe_logon_submit/2

Handle a user logon. The posted query args are included. Return:: {ok, UserId} or {error, Reason}

Notifications

observe_mailinglist_mailing/2

Send a page to a mailinglist (notify) Use {single_test_address, Email} when sending to a specific e-mail address.

Notifications

observe_mailinglist_message/2

Send a welcome or goodbye message to the given recipient. The recipient is either a recipient-id or a recipient props. ‘what’ is send_welcome, send_confirm

Notifications

observe_m_config_update/2

Site configuration parameter was changed

Notifications

observe_m_config_update_prop/2

Site configuration parameter was changed

Notifications

observe_media_identify_extension/2

Try to find a filename extension for a mime type (example: <<".jpg">> )

Notifications

observe_media_identify_file/2

Try to identify a file, returning a map with file properties.

Notifications

observe_media_import/2

Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue movies for conversion to mp4. You can set…

Notifications

observe_media_import_medium/2

Notification to import a medium record from external source. This is called for non-file medium records, for example embedded video. If the medium record is…

Notifications

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 ‘original’ image option is passed. The…

Notifications

observe_media_replace_file/2

Notification that a medium file has been changed (notify) The id is the resource id, medium contains the medium’s complete property map.

Notifications

observe_media_stillimage/2

See if there is a ‘still’ image preview of a media item. (eg posterframe of a movie) Return:: {ok, ResourceId} or undefined

Notifications

observe_media_update_done/2

Media update done notification. action is ‘insert’, ‘update’ or ‘delete’

Notifications

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 movies for conversion to mp4. You can set…

Notifications

observe_media_upload_props/3

Notification that a medium file has been uploaded. This is the moment to change properties, modify the file etc. The folded accumulator is the map with updated…

Notifications

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 etc. The folded accumulator is the map…

Notifications

observe_media_viewer/2

Request to generate a HTML media viewer for a resource. The HTML data can not contain any Javascript, as it might be serialized. This could happen if the…

Notifications

observe_media_viewer_consent/2

Optionally wrap HTML with external content so that it adheres to the cookie/privacy settings of the current site visitor. Typically called with a ‘first’ by…

Notifications

observe_menu_rsc/2

Fetch the menu id belonging to a certain resource

Notifications

observe_menu_save/2

Save the menu tree of a menu resource

Notifications

observe_middleware/3

Delegates the request processing.

Notifications

observe_module_activate/2

A module has been activated and started.

Notifications

observe_module_deactivate/2

A module has been stopped and deactivated.

Notifications

observe_module_ready/2

Signals that the active modules or their indexed templates, actions, models, and other components have changed.

Notifications

observe_output_html/3

Fold for mapping non-iolist output to iolist values.

Notifications

observe_page_url/2

Fetch the url of a resource’s html representation

Notifications

observe_pivot_fields/3

Foldr to change or add pivot fields for the main pivot table. The rsc contains all rsc properties for this resource, including pivot properties. Fold with a…

Notifications

observe_pivot_rsc_data/3

Fold over the resource props map to extend/remove data to be pivoted

Notifications

observe_pivot_update/3

Pivot just before a m_rsc_update update. Used to pivot fields before the pivot itself.

Notifications

observe_postback_notify/2

Handle a javascript notification from the postback handler. The message is the the request, trigger the id of the element which triggered the postback, and…

Notifications

observe_request_context/3

Refresh the context or request process for the given request or action

Notifications

observe_resource_headers/3

Let all modules add resource specific response headers to the request. The accumulator is the list of headers to be set.

Notifications

observe_rsc_delete/2

Resource will be deleted. This notification is part of the delete transaction, it’s purpose is to clean up associated data.

Notifications

observe_rsc_export_done/3

Extend the full resource-export envelope returned by m_rsc_export:full/2 . The accumulator is the export map, not the nested resource-properties map. Return…

Notifications

observe_rsc_get/3

Resource is read, opportunity to add computed fields Used in a foldr with the read properties as accumulator.

Notifications

observe_rsc_import_done/2

A resource import has completed. The options describe this particular import; recursively imported resources can have different options.

Notifications

observe_rsc_import_fetch/2

Fetch the data for an import of a resource. Returns data in the format used by m_rsc_export and m_rsc_import. Either returns the JSON data, the imported…

Notifications

observe_rsc_import_fetch_result/3

Enrich the decoded resource-export envelope with import metadata. The response headers belong to final_url , after any redirects. Return the updated envelope.

Notifications

observe_rsc_insert/3

Foldr for a resource insert, these are the initial properties and will overrule the properties in the insert request. Use with care. The props are the…

Notifications

observe_rsc_merge/2

Map to signal merging two resources. Move any information from the loser to the winner. The loser will be deleted.

Notifications

observe_rsc_pivot_done/2

Signal that a resource pivot has been done.

Notifications

observe_rsc_query_item/2

Send a notification that the resource ‘id’ is added to the query query_id.

Notifications

observe_rsc_update/3

An updated resource is about to be persisted. Observe this notification to change the resource properties before they are persisted.

Notifications

observe_rsc_update_done/2

An updated resource has just been persisted. Observe this notification to execute follow-up actions for a resource update.

Notifications

observe_rsc_upload/2

Upload and replace the resource with the given data. The data is in the given format.

Notifications

observe_sanitize_element/3

Sanitize an HTML element.

Notifications

observe_sanitize_embed_url/2

Sanitize an embed url. The hostpart is of the format: <<"youtube.com/v...">> .

Notifications

observe_scomp_script_render/2

Add extra javascript with the {% script %} tag. (map) Used to let modules inject extra javascript depending on the arguments of the {% script %} tag. Must…

Notifications

observe_search_query/2

Map a custom search term to a #search_sql_term{} record.

Notifications

observe_search_query_normalize_value/2

Normalize a search value for queries and indexing. An example is the normalization of texts by transliteration and removal of accents. Defaults for text values…

Notifications

observe_search_query_term/2

Map a custom search term to a #search_sql_term{} record.

Notifications

observe_security_headers/2

Check and possibly modify the http response security headers All headers are in lowercase.

Notifications

observe_session_context/3

Refresh the context or request process for the given request or action

Notifications

observe_set_user_language/2

Set the language of the context to a user’s prefered language

Notifications

observe_signup/2

Request a signup of a new or existing user. Arguments are similar to #signup_url{} Returns {ok, UserId} or {error, Reason}

Notifications

observe_signup_check/3

signup_check Check if the signup can be handled, a fold over all modules. Fold argument/result is {ok, Props, SignupProps} or {error, Reason}

Notifications

observe_signup_confirm/2

Signal that a user has been confirmed. (map, result is ignored)

Notifications

observe_signup_confirm_redirect/2

Fetch the page a user is redirected to after signing up with a confirmed identity

Notifications

observe_signup_done/2

Signal that a user has been signed up (map, result is ignored)

Notifications

observe_signup_failed_url/2

Signup failed, give the error page URL. Return {ok, Url} or undefined. Reason is returned by the signup handler for the particular signup method (username

Notifications

observe_signup_url/2

Handle a signup of a user, return the follow on page for after the signup. Return {ok, Url} ‘props’ is a map with properties for the person resource (email

Notifications

observe_ssl_options/2

Request the SSL certificates for this site. The server_name property contains the hostname used by the client. (first) Returns either ‘undefined’ or a list of…

Notifications

observe_survey_get_handlers/3

Fetch list of handlers for survey submits.

Notifications

observe_survey_is_allowed_results_download/2

Check if the current user is allowed to download a survey.