> For the complete documentation index, see [llms.txt](https://docs.cuxial.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cuxial.com/scripts/gangs/cuxial-gang-app/developers.md).

# Exports & events

Public API of Cuxial Gang App: one client export to send messages to the app.

Cuxial Gang App exposes one client export and no public events. Its data comes from Cuxial Gang, so anything about organizations, zones or mules is read from Cuxial Gang, not from here.

## Client exports

### SendAppMessage

Sends a message to the app interface while it is open on the phone.

```lua
exports.cuxial_gang_app:SendAppMessage(action, data)
```

| Parameter | Type   | Description                |
| --------- | ------ | -------------------------- |
| `action`  | string | Name of the message.       |
| `data`    | any    | Payload delivered with it. |

**Returns:** nothing.

Actions the app answers to:

| Action        | Data | What it does                                                                                                                                       |
| ------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `roleChanged` | `{}` | The app asks for the player's role again and redraws the home screen. Use it after changing a player's organization or job from your own resource. |

```lua
exports.cuxial_gang_app:SendAppMessage('roleChanged', {})
```

## Events

There are no events meant for other resources. The `kokka:*` events and callbacks are internal and can change between versions.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cuxial.com/scripts/gangs/cuxial-gang-app/developers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.