Browse API 1 documentation
GroveAPI 1preview

grove.composer.complete()

Insert a utility result into Mango's draft and close the utility.

Mango 3.1+View Markdown

Insert a utility result into Mango’s draft and close the utility.

Signature

ts
grove.composer.complete(text: string): void

Availability

Exclusive composer surface with application scope. No additional capability required.

Parameters

Parameter Required Description
text Yes Result text. Leading/trailing whitespace is removed; up to 4,096 characters are retained.

Return value

Returns undefined. No Promise, draft object, or sent message is returned.

Behavior and errors

Empty or whitespace-only text closes the utility without a contribution. Longer text is truncated with a warning. Other surfaces are refused. Mango inserts the result into the native draft for the user to review and send; this call itself sends no IRC message.

Example

js
grove.composer.complete('https://example.com/polls/123')

See grove.composer.close() and Composer utilities.