# Custom Protocol

The `CustomProtocol` class defines a set of URI-like prefixes that can be used to trigger specific actions within the system by providing a package ID. These custom protocol handlers are designed to streamline operations such as syncing, installing, upgrading, or initiating remote support for software packages.

| Constant                   | Description                                       | Example Usage                  |
| -------------------------- | ------------------------------------------------- | ------------------------------ |
| `realmjoin:`               | Base prefix for all custom protocol actions.      |                                |
| `realmjoin:sync:`          | Triggers a sync operation for the RealmJoin agent | `realmjoin:sync:`              |
| `realmjoin:install:`       | Initiates installation of the specified package.  | `realmjoin:install:package-id` |
| `realmjoin:upgrade:`       | Starts an upgrade process for the package.        | `realmjoin:upgrade:package-id` |
| `realmjoin:remotesupport:` | Launches a remote support session.                | `realmjoin:remotesupport:`     |


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.realmjoin.com/dev-reference/custom-protocol.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.