Heartbeat implementations

Heartbeat is an API but holds built-in implementation to get people starting. Especially using the rules module, it gets you going real quickly. However in my opinion, activity streams are very custom to specific needs and requirements. That's when the API part comes to play.

Heartbeat makes it real easy to alter or extend all functionality. As all data is written in classes, we can extends or write custom classes to fit the needs. You can read how to do this in the activity streams documentation.

Hooks

• hook_heartbeat_message_info This is code that defines default heartbeat message templates. The code is provided through the heartbeat export UI.
• hook_heartbeat_register_access_types Registers heartbeat streams (also called access types since they query the activity the currently logged-in person has access to.
• hook_heartbeat_messages_alter This hook will let you alter each message individually. Note here that all messages from the query result are still there. There are still access checks, grouping of similar messages and such going on.  This hook is ment to deny messages very customly, site exceptions and so on which are not configurable through UI. You do NOT want to use this function to alter the output, there you use "hook_heartbeat_theme_alter".
  The parameters you can alter is a references messages array of activity objects and the heartbeatAccessType (stream) object.
• hook_heartbeat_theme_alter The parameters you can alter is a references messages array of activity objects and the heartbeatAccessType (stream) object. Use this method to rewrite output. You can alter the message->message part easily. You can even rebuild the whole activity message after changing some run-time variables with $message->rebuild_message() which returns the altered message text.
• hook_heartbeat_view
  Gets the same parameters as hook_heartbeat_messages_alter but comes absolutely last of all things. Heartbeat display suite hooks into this to build the fields in the appropriate regions for this matter. Because all themed and altered stuff has to be in it, this hook gets called very late in the stream building process.
• hook_heartbeat_stream_filters Heartbeat filters are links that come above (or themed left) to the activity stream filtering the messages. Each filter needs to have a conventional callback that will limit the result. There is an option to let these filter links behave as radio or as checkboxes (accumulating or not). If the filter is called "myfilter" => t('My filter'), registered in this hook, then the callback where you can alter/limit the result will be "hook_heatbeat_filter_<yourfilter>". Implement this and restrict the messages. Not that   [yourfilter] will replace non-func chars to underscores". You will find an example of this in heartbeat_example to filter stories.
• hook_heartbeat_attachments Attachments are widgets that add functionality and output to a heartbeat activity message in the streams. Heartbeat comments, i like flags, etc ... . Register your attachments through this hook and create a callback function to deal with the widget form and the site output.