@empathyco/x-components/docs/API-reference/api/x-components.relatedpromptsactions.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsActions](./x-components.relatedpromptsactions.md)

## RelatedPromptsActions interface

Related prompts module actions.

**Signature:**

```typescript
export interface RelatedPromptsActions 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[cancelFetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.cancelfetchandsaverelatedprompts.md)


</td><td>


</td><td>

() =&gt; void


</td><td>

Cancels / interrupt [RelatedPromptsActions.fetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md) synchronous promise.


</td></tr>
<tr><td>

[fetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md)


</td><td>


</td><td>

(request: RelatedPromptsRequest \| null) =&gt; void


</td><td>

Requests a new set of related prompts and stores them in the module.


</td></tr>
<tr><td>

[fetchRelatedPrompts](./x-components.relatedpromptsactions.fetchrelatedprompts.md)


</td><td>


</td><td>

(request: RelatedPromptsRequest \| null) =&gt; RelatedPrompt\[\] \| null


</td><td>

Requests a new set of related prompts for the module query, and returns them.


</td></tr>
<tr><td>

[setUrlParams](./x-components.relatedpromptsactions.seturlparams.md)


</td><td>


</td><td>

(urlParams: [UrlParams](./x-components.urlparams.md)<!-- -->) =&gt; void


</td><td>

Checks if the URL has params on it and then updates the state with these values.


</td></tr>
</tbody></table>