Query Manager — Reference
Read and update state represented in the page’s URL query string.
Read and update state represented in the page’s URL query string.
Before you begin
Section titled “Before you begin”- An App Connect page with the State Management component included. Use a dedicated test key for experiments.
Query Manager
Section titled “Query Manager”Read and update state represented in the page’s URL query string.
Properties, data and actions
Section titled “Properties, data and actions”| Part | Meaning |
|---|---|
| ID | The component name, for example queryState. |
| Define Query Params | Declares parameter names for the editor’s pickers. It does not add them to the address bar. |
| Values | Read queryState.data.name. Parsed query values are strings, including numeric-looking values such as page=2. |
| Set: Name / Value | Sets or replaces a query value and uses browser history navigation to update the URL. For example, Set page to 2 gives a query parameter rather than changing a database record. |
| Remove | Removes the named parameter. The installed implementation checks the existing value for truthiness, so a parameter with an empty value can remain; verify the actual URL. |
| Remove All | Clears the query parameters while preserving the URL’s other parts. Use it only when removing all current query state is intended. |
Worked example
Section titled “Worked example”Read a page with ?page=2 and confirm queryState.data.page is the string ‘2’. Set a search parameter to Notebook and verify the address bar and binding. Remove that non-empty search parameter, then reload/bookmark the URL to check which state it preserves.
Lifetime and boundaries
Section titled “Lifetime and boundaries”Query values are visible, editable and shareable. Convert numeric values deliberately and validate any values used by the server. A query-manager update does not itself perform an API request; the relevant component or event must use that query state.
Choose the right storage
Section titled “Choose the right storage”Compare URL, cookie, session and local state before choosing where application data belongs. Browser state never replaces server-side access checks.
Check your result
Section titled “Check your result”You can use the correct data path, configure a value and verify the storage/removal scope.