Back to Website
Show / Hide Table of Contents

Class RuntimeConfiguration

Allows you to get and set the user ID and PDF metadata of a product at runtime.

Package: IframeApi

Methods

getPdfMetadata()

Reads PDF metadata of the current product.

Declaration
function getPdfMetadata()
Returns
Type Description
Promise<IPdfMetadata>

The IPdfMetadata structure with data to be saved in the hi-res output.

getUserId()

Reads ID of the user working on the product.

Declaration
function getUserId()
Returns
Type Description
Promise<string>

The user identifier.

setPdfMetadata(IPdfMetadata)

Sets PDF metadata to the current product.

Declaration
function setPdfMetadata(config: IPdfMetadata)
Parameters
Type Name Description
IPdfMetadata config

PDF metadata to be saved in the hi-res output.

Returns
Type Description
Promise<void>

setUserId(string)

Sets a new user identifier and moves user files to this user's folders. Before using this method, you must enable the secure mode and update an authentication token by using the additionalUserId parameter with the new user identifier.

Declaration
function setUserId(userId: string)
Parameters
Type Name Description
string userId

The new user identifier that needs to be set for the product.

Returns
Type Description
Promise<void>
Back to top Copyright © 2001–2022 Aurigma, Inc. All rights reserved.
Loading...