Interface IViewerConfiguration

Interface that represents the configuration with which the PSPDFKit viewer should be loaded.

Inherited Members

INotifyPropertyChanged.PropertyChanged

Namespace: PSPDFKit.Api

Assembly: Api.dll

Syntax

public interface IViewerConfiguration : INotifyPropertyChanged

Properties

AIAssistantConfiguration

Configuration for the AI Assistant.

Declaration

IAIAssistantConfiguration AIAssistantConfiguration { get; }

Property Value

Type	Description
IAIAssistantConfiguration

InstantJson

Gets or sets the Instant JSON to be applied while loading the document.

Declaration

JObject InstantJson { get; set; }

Property Value

Type	Description
JObject

ToolbarPlacement

Placement of toolbar. By default, it's set to the top.

Declaration

ToolbarPlacement ToolbarPlacement { get; set; }

Property Value

Type	Description
ToolbarPlacement

UseInBuiltFilePicker

Specifies if the SDK should be loaded with the built-in file picker.

Declaration

bool UseInBuiltFilePicker { get; set; }

Property Value

Type	Description
bool

Methods

SetAIAssistantConfiguration(string, string, string, string?)

Sets the configuration for the AI Assistant.

Declaration

void SetAIAssistantConfiguration(string sessionId, string jwt, string backendUrl, string? userId = null)

Parameters

Type	Name	Description
string	sessionId	The session to reopen, or an ID for the new session to create. This ID should be unique for each session and should use alphanumeric characters only.
string	jwt	The JWT token to authenticate the user.
string	backendUrl	The URL that hosts AI Assistant service. e.g. 'https://localhost:4000'.
string	userId	An optional user ID for the current user. This ID should be unique for each user and should use alphanumeric characters only.