INDEX

Documentation Library

Search for information on Hornbill Documentation.

Filter

Books

All
{{book.title}}
{{book.foundCount}}

Products

{{product.name}} {{docApp.searchFilteredProducts[product.id].returnedCount}}

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

{{resultItem.title}}

{{resultItem.url}}

{{resultItem.content}}

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}}

{{book.title}}

{{book.title}}

More...

/ activity / conversationStart

Description

Initiate a conversation between yourself and one or more other users.

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.startConversation`	`---`	`---`	`---`

Request Parameters

The conversationStart 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
`participant`	`xs:anyURI`	Required Array (1/∞)	The participants you are starting a conversation with.
`content`	`xs:string`	Optional	The conversation title.
`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 embedded or referenced content for the message.
`location`	`geoLocationType`	Optional	You can specify a geographical location to associate to this conversation.
`messageContent`	`xs:string`	Optional	The first message in the conversation.
`messageExtra`	`xs:string`	Optional	A JSON structure representing additional embedded or referenced content for the first message in the conversation.
`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.

Response Parameters

Name	Type	Attributes	Description
`conversationId`	`xs:anyURI`	Required	The unique ID of the conversation.
`messageId`	`xs:anyURI`	Optional	The unique ID of the conversation message.

In This Document

{{docApp.title}}

{{docApp.description}}