Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - buzzCommentType

  • Article
  • 1 minutes to read

Description

This type is used to represent a comment.

Properties

Name Type Occurrence Description
id xs:anyURI Required The unique resource name identifier for this activity.
actorInfo accountBasicDetailsType Required Person or object that posted this activity.
icon xs:anyURI Optional Icon that should be displayed against the comment.
comment xs:string Required The comments text body.
language xs:language Required The language the comment is written in.
extra xs:string Optional Used to store a JSON structure that represents a referenced resource or application-specific additional content.
read xs:boolean Required
Default=true		 Indicates that the person querying the activity stream has read this comment.
published xs:dateTime Required The date/time the comment was published.
likes xs:unsignedInt Required Indicates the number of people that like this comment.
youLike xs:boolean Required Indicates that the person querying the activity stream likes this comment.
activityOwnerLikes xs:boolean Required Indicates that the owner of the activity that this comment belongs to likes this comment.
thumbnailAccessToken xs:string Optional If the activity included embedded content, this access token will provide time-limited access to the thumbnail image for the content via WebDAV cafs_raw.
visibility activityVisibilityType Optional The visibility the method invoker has on this comment.
fileAttachment Array<serverFileAttachmentType> Optional Information about the file attachment.
replyToActorInfo accountBasicDetailsType Optional Actor information of the comment being replied to.
replyToID xs:anyURI Optional ID of the comment being replied to.
replyToExtra xs:string Optional Extra information relating to reply to comment
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document