> ## Documentation Index
> Fetch the complete documentation index at: https://audio-app-kit-docs.upgrade-api.int.bragi-dev.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Actions

Actions are events that are dispatched to the native app.

## Using Actions

<CodeGroup>
  ```typescript Typescript
  import { AudioAppKit } from '@bragiai/audio-app-kit';
  // Usage: AudioAppKit.chatAgent.toggleState(state);
  ```

  ```javascript Javascript (CommonJS)
  const { AudioAppKit } = require('@bragiai/audio-app-kit');
  // Usage: AudioAppKit.chatAgent.toggleState(state);
  ```

  ```javascript Javascript (ESM)
  import { AudioAppKit } from '@bragiai/audio-app-kit';
  // Usage: AudioAppKit.chatAgent.toggleState(state);
  ```
</CodeGroup>

## List of Actions

### Toggle State

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.toggleState(agentShared.StatePayload_State.ON);
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.toggleState(agentShared.StatePayload_State.ON);
  ```
</CodeGroup>

### Toggle Mute

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.toggleMute(agentShared.StatePayload_State.ON);
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.toggleMute(agentShared.StatePayload_State.ON);
  ```
</CodeGroup>

### Send Message

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.send('What is superconductivity?');
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.send('What is superconductivity?');
  ```
</CodeGroup>

### Regenerate Message

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.send({
    prompt: 'What is superconductivity?',
    uuid: 'd61ff9f3-c41b-4967-9963-1791599db445'
  });
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.send({
    prompt: 'What is superconductivity?',
    uuid: 'd61ff9f3-c41b-4967-9963-1791599db445'
  });
  ```
</CodeGroup>

### Language Update

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.languageUpdate('en'); // English
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.languageUpdate('en'); // English
  ```
</CodeGroup>

### Enable Voice Control

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.enableVoiceControl();
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.enableVoiceControl();
  ```
</CodeGroup>

### Clear Chat History

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.clearChatHistory();
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.clearChatHistory();
  ```
</CodeGroup>

### Shortcut Button Tapped

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.shortcutButtonTapped();
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.shortcutButtonTapped();
  ```
</CodeGroup>

### Complete Session

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.completeSession({
    silent: false, // If true, the session will complete silently without triggering UI or sound feedback.
    unsubscribe: false, // If true, the session will be terminated after the response is generated.
  });
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.completeSession({
    silent: false, // If true, the session will complete silently without triggering UI or sound feedback.
    unsubscribe: false, // If true, the session will be terminated after the response is generated.
  });
  ```
</CodeGroup>

### Paywall Button Tapped

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.paywallButtonTapped(); // Paywall button tapped
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.paywallButtonTapped(); // Paywall button tapped
  ```
</CodeGroup>

### Notification Badge State

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.notificationBadgeState(type, isActive); // Notification badge state
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.notificationBadgeState(type, isActive); // Notification badge state
  ```
</CodeGroup>

### Share Message

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.shareText("Superconductivity is a phenomenon where ...");
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.shareText("Superconductivity is a phenomenon where ...");
  ```
</CodeGroup>

### Banner Tapped

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.bannerTapped();
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.bannerTapped();
  ```
</CodeGroup>

### Input Mode Changed

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.inputModeChanged(agentAction.InputTypePayload_Type.TEXT);
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.inputModeChanged(agentAction.InputTypePayload_Type.TEXT);
  ```
</CodeGroup>

### Open App Settings

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.openAppSettings();
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.openAppSettings();
  ```
</CodeGroup>

### Download Language Model

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.downloadLanguageModel('de'); // language code
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.downloadLanguageModel('de'); // language code
  ```
</CodeGroup>

### Cancel Downloading Language Model

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.cancelDownloadLanguageModel();
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.cancelDownloadLanguageModel();
  ```
</CodeGroup>

### Delete Language Model

<CodeGroup>
  ```typescript Typescript
  AudioAppKit.chatAgent.deleteLanguageModel('de'); // language code
  ```

  ```javascript Javascript
  AudioAppKit.chatAgent.deleteLanguageModel('de'); // language code
  ```
</CodeGroup>