> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Agents.IPreviewsAgent

# \<a id="SuperOffice\_WebApi\_Agents\_IPreviewsAgent">\</a> Interface IPreviewsAgent

Namespace: [SuperOffice.WebApi.Agents](SuperOffice.WebApi.Agents.md)\
Assembly: SuperOffice.WebApi.dll

Get preview strings from a hint

```csharp theme={null}
public interface IPreviewsAgent : IAgentBase, IDisposable
```

#### Implements

[IAgentBase](SuperOffice.WebApi.Agents.IAgentBase.md),
[IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable)

## Methods

### \<a id="SuperOffice\_WebApi\_Agents\_IPreviewsAgent\_GetPreviewAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetPreviewAsync(string, RequestOptions)

Parse a Preview hint and return a Preview. The returned Preview string may contain resource string identifiers (in square brackets), to be processed by the resource manager.\<para />The Preview hint is either a literal text, representing itself, or a set of key/value pairs enclosed in curly braces. Each key is separated from its value by an equals sign, and each pair from the next by an ampersand, according to usual conventions.\<para />A typical Preview hint could be \{contact\_id=123} or \{appointment\_id=222\&amp;mode=simple}

```csharp theme={null}
Task<string> GetPreviewAsync(string previewHint, RequestOptions requestOptions = null)
```

#### Parameters

`previewHint` [string](https://learn.microsoft.com/dotnet/api/system.string)

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;


## Related topics

- [SuperOffice.WebApi.Agents.PreviewsAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PreviewsAgent.md)
- [SuperOffice.WebApi.Agents.ITicketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ITicketAgent.md)
- [SuperOffice.WebApi.Agents.TicketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.TicketAgent.md)
- [SuperOffice.WebApi.Agents.IImportAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IImportAgent.md)
- [SuperOffice.WebApi.Agents.ImportAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ImportAgent.md)
- [SuperOffice.WebApi.Agents.DocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DocumentAgent.md)