ChatResponseStream

The ChatResponseStream is how a participant is able to return content to the chat view. It provides several methods for streaming different types of content which will be rendered in an appropriate way in the chat view. A participant can use the helper method for the type of content it wants to return, or it can instantiate a ChatResponsePart and use the generic ChatResponseStream.push method to return it.

Online Documentation

Functions

anchor

abstract fun anchor(value: Location, title: String = definedExternally)

abstract fun anchor(value: Uri, title: String = definedExternally)

Push an anchor part to this stream. Short-hand for push(new ChatResponseAnchorPart(value, title)). An anchor is an inline reference to some type of resource.

button

abstract fun button(command: Command)

Push a command button part to this stream. Short-hand for push(new ChatResponseCommandButtonPart(value, title)).

filetree

abstract fun filetree(value: ReadonlyArray<ChatResponseFileTree>, baseUri: Uri)

Push a filetree part to this stream. Short-hand for push(new ChatResponseFileTreePart(value)).

markdown

abstract fun markdown(value: String)

Push a markdown part to this stream. Short-hand for push(new ChatResponseMarkdownPart(value)).

abstract fun markdown(value: MarkdownString)

progress

abstract fun progress(value: String)

Push a progress part to this stream. Short-hand for push(new ChatResponseProgressPart(value)).

push

abstract fun push(part: ChatResponsePart)

Pushes a part to this stream.

reference

abstract fun reference(value: Location, iconPath: IconPath = definedExternally)

abstract fun reference(value: Uri, iconPath: IconPath = definedExternally)

Push a reference to this stream. Short-hand for push(new ChatResponseReferencePart(value)).