Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Commit

Permalink
GITBOOK-1297: update apps engine commands table
Browse files Browse the repository at this point in the history
  • Loading branch information
rachana-visavadiya authored and gitbook-bot committed May 30, 2024
1 parent e331a96 commit d65f919
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,13 @@ Here is an example of how to handle it:
{% code overflow="wrap" lineNumbers="true" fullWidth="false" %}
```typescript
export class MyApp extends App implements IUIKitInteractionHandler {
public async executeActionButtonHandler(
protected async extendConfiguration(configuration: IConfigurationExtend, environmentRead: IEnvironmentRead): Promise<void> {
configuration.ui.registerButton({
actionId: 'my-action-id', // this identifies your button in the interaction event
labelI18n: 'my-action-name', // key of the i18n string containing the name of the button
context: UIActionButtonContext.MESSAGE_ACTION, // the context in which the action button will be displayed on the UI
});
} public async executeActionButtonHandler(
context: UIKitActionButtonInteractionContext,
read: IRead,
http: IHttp,
Expand Down
2 changes: 1 addition & 1 deletion apps-engine/getting-started/creating-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ On this page, you will learn about the Apps-Engine commands and create a basic a

Here is a list of commands that Rocket.Chat Apps-Engine supports:&#x20;

<table><thead><tr><th width="204.5">Command</th><th>Description</th></tr></thead><tbody><tr><td><code>autocomplete</code></td><td>Automatically displays installation instructions.</td></tr><tr><td><code>create</code></td><td>Simplifies the process of creating an app.</td></tr><tr><td><code>deploy</code></td><td>Deploys an app to the server.</td></tr><tr><td><code>generate</code></td><td>Adds boilerplate code for numerous functions.</td></tr><tr><td><code>help</code></td><td>Displays help for <code>rc-apps</code>.</td></tr><tr><td><code>login</code></td><td>Provides the steps for logging into Rocket.Chat Cloud.</td></tr><tr><td><code>logout</code></td><td>Revokes the Rocket.Chat Cloud credentials.</td></tr><tr><td><code>package</code></td><td>Packages the app for distribution.</td></tr><tr><td><code>submit</code></td><td>Submits an app to the marketplace for review.</td></tr><tr><td><code>watch</code></td><td>Monitors app changes and redeploys the modified app to the server.</td></tr></tbody></table>
<table><thead><tr><th width="192.5">Command</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>autocomplete</code></td><td><p>Displays installation instructions.</p><p><strong>Note</strong>: This command is not supported on Windows.</p></td><td><code>rc-apps autocomplete</code></td></tr><tr><td><a href="creating-an-app.md#create-a-basic-app"><code>create</code></a></td><td>Simplifies the process of creating an app.</td><td><code>rc-apps create</code></td></tr><tr><td><a href="creating-an-app.md#step-5-deploy-to-the-server"><code>deploy</code></a></td><td>Deploys an app to the server.</td><td><code>rc-apps deploy --url &#x3C;server_url> -u &#x3C;user> -p &#x3C;pwd></code></td></tr><tr><td><code>generate</code></td><td><p>Creates boilerplate code files in the current directory for the following:</p><ul><li><strong>Api Extension</strong>: Enter the name and path of the endpoint. The <code>.ts</code> file is created in a new <code>endpoints</code> folder.</li><li><strong>Slash Command Extension</strong>: Enter the name of the command class that you want to create. The <code>.ts</code> file is created in a new <code>slashCommands</code> folder. </li><li>Settings Extension: A <code>settings.ts</code> file is created.</li></ul></td><td><code>rc-apps generate</code></td></tr><tr><td><code>help</code></td><td>Displays the CLI tool for helping with Rocket.Chat Apps.</td><td><code>rc-apps help</code></td></tr><tr><td><code>login</code></td><td>Provides the steps for logging into Rocket.Chat Cloud.</td><td><code>rc-apps login</code></td></tr><tr><td><code>logout</code></td><td>Revokes the Rocket.Chat Cloud credentials.</td><td><code>rc-apps logout</code></td></tr><tr><td><a href="creating-an-app.md#step-5-deploy-to-the-server"><code>package</code></a></td><td>Packages the app for distribution.</td><td><code>rc-apps package</code></td></tr><tr><td><a href="../app-submission-to-the-marketplace/"><code>submit</code></a></td><td>Submits an app to the marketplace for review.</td><td><code>rc-apps submit</code></td></tr><tr><td><code>watch</code></td><td>Monitors app changes and redeploys the modified app to the server.</td><td><code>rc-apps watch</code></td></tr></tbody></table>

## Create a Basic App

Expand Down

0 comments on commit d65f919

Please sign in to comment.