> For the complete documentation index, see [llms.txt](https://cachebox.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cachebox.ortusbooks.com/for-the-geeks/cachebox-architecture/icoldboxapplicationcache.md).

# IColdboxApplicationCache

**class** : `cachebox.system.cache.IColdboxApplicationCache`

This interface extends from the original cache provider interface and adds certain methods that MUST be implemented so the cache can work for ColdBox applications. This includes functionality to do event/view caching, clearing/expiring by certain regular expressions and reporting. So if you want to create your own cache implementation for ColdBox applications, then it must adhere to this contract.

## Interface Methods

| Method                                                                      | Description                                                    |
| --------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `getViewCacheKeyPrefix()`                                                   | Get the string prefix used when building view cache keys       |
| `getEventCacheKeyPrefix()`                                                  | Get the string prefix used when building event cache keys      |
| `getColdbox()`                                                              | Get the linked ColdBox application controller                  |
| `setColdBox( required coldbox )`                                            | Link a ColdBox application controller to this provider         |
| `getEventURLFacade()`                                                       | Get the event URL facade helper object used for key generation |
| `clearAllEvents( [boolean async=false] )`                                   | Clear all cached events; optionally run asynchronously         |
| `clearEvent( required string eventSnippet, [string queryString=""] )`       | Clear a cached event by snippet and optional query string      |
| `clearEventMulti( required string eventsnippets, [string queryString=""] )` | Clear multiple cached events by a comma-delimited snippet list |
| `clearView( required string viewSnippet )`                                  | Clear a specific cached view by snippet                        |
| `clearViewMulti( required string viewSnippets )`                            | Clear multiple cached views by a comma-delimited snippet list  |
| `clearAllViews( [boolean async=false] )`                                    | Clear all cached views; optionally run asynchronously          |


---

# 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://cachebox.ortusbooks.com/for-the-geeks/cachebox-architecture/icoldboxapplicationcache.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.