Browse API 1 documentation
GroveAPI 1preview

grove.dismissCard()

Remove a native card owned by this instance.

Mango 3.1+View Markdown

Remove a native card owned by this instance.

Signature

ts
grove.dismissCard(id: string): void

Availability

IRC-bound runtimes with commands.register.

Parameters

Parameter Required Description
id Yes Identifier used in grove.card; surrounding whitespace is trimmed.

Return value

Returns undefined; no indication of whether a matching card existed.

Behavior and errors

Only this instance’s cards can be removed. Unknown IDs have no visible effect. Missing permission or an unsupported application/composer/settings context refuses the command.

Example

js
grove.dismissCard('service-status')

See grove.card().