Documentation

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?


What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

/ activity / activityPostMessage

Description

Posts an update to the specified activity stream. The activity stream must exist.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
sys.e.postMessage
--- --- ---

Request Parameters

The activityPostMessage method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
activityStreamID xs:anyURI Required The ID of the activity stream you are posting a message to.
content xs:string Required The status update text.
language xs:language Optional If you are posting the update in a language other than your current language then you should specify the language code here. If not specified then your current language will be assumed
extra xs:string Optional An arbitary string value, could be a JSON/XML/Other undocumented (here) structure defined by the front end devs, representing additional content for the message.
visibility activityVisibilityType Optional
Default=following
The visibility of this activity.
location geoLocationType Optional You can specify a geographical location to associate to this activity.
type xs:string Optional The type of activity. When querying activities this can be used to filter activities
objectRefUrn xs:anyURI Optional The urn of the object associated with this activity
activityType activityType Optional The type of the activity
attachLocalFile embeddedFileAttachmentType Optional
Array (0/∞)
EXPERIMENTAL: The files to attach. Use this type if you are embedding the file content within this XMLMC message
attachServerFile serverFileAttachmentType Optional
Array (0/∞)
EXPERIMENTAL: The files to attach. Use this type if you the file content is accessible to the server, for example a temporary file on the session folder
supressFollowerNotification xs:boolean Optional
Default=false
You can supress follower notifications for this post, useful when adding content to the activity stream where the user does not need to be notified

Response Parameters

Name Type Attributes Description
activityID xs:anyURI Required The ID of the activity record created.This is DEPRECATED and should not be used, USE activity INSTEAD
activity buzzActivityType Required The posted message
In This Document