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 / activityPostCommentImage

Description

Posts an image comment to the specified activity.

API Details

  • Status:
  • The required privilege level to invoke this method is guest
System Rights Database Rights Mail Rights Calendar Rights
sys.e.postComment
--- --- ---

Request Parameters

The activityPostCommentImage 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
activityID xs:anyURI Required URI that identifies the activity for which this comment is targeted.
comment xs:string Optional Comment text
language xs:language Optional If you are posting the comment 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
sourceImage xs:anyURI Optional A URL where the image can be found. If the URL begins with a forward slash then the image is assumed
to be in the WebDAV path of our instance. If the URL begins with http:// or https:// then the image will be
fetched from that location. Please be aware that any external URL’s provided will need to be accessible by
the server.
deleteSourceFile xs:boolean Optional
Default=false
Set this to ‘true’ if you want the source image to be deleted once the profile image set has been created. This is
generally only needed when you have uploaded (via WebDav) a temporary image. If you reference an absolute external URL
then setting this either way will have no effect.
visibility activityVisibilityType Optional
Default=undefined
The visibility of this comment you are posting. If you specify the visibility it can not be more permissive than the activity you are posting the comment to.
postSummaryToWall xs:boolean Optional
Default=true
If true, a comment summary activity will be posted to the user’s Buzz.
The summary contains a copy of the text, and link back to the targeted activity.
replyToActor xs:anyURI Optional If replying to a comment, this is the UserURN of the comment being replied to
replyToID xs:anyURI Optional If replying to a comment, this is the ID of the comment being replied to
replyToExtra xs:string Optional Extra informaiton relating to the reply to info

Response Parameters

Name Type Attributes Description
commentID xs:anyURI Required URI that references the comment created. <font color=“red”><b>This is DEPRECATED and should not be used, USE comment INSTEAD</b></font>
comment buzzCommentType Required The comment posted to the activity.
In This Document