Insluitende lezer Naslag voor JavaScript SDK (v1.1)

De Insluitende lezer SDK bevat een JavaScript-bibliotheek waarmee u de Insluitende lezer in uw toepassing kunt integreren.

Functions

De SDK maakt de volgende functies bekend:

• ImmersiveReader.launchAsync(token, subdomain, content, options)

• ImmersiveReader.close()

• ImmersiveReader.renderButtons(options)

launchAsync

Start de Insluitende lezer in een iframe in uw webtoepassing. Houd er rekening mee dat de grootte van uw inhoud is beperkt tot een maximum van 50 MB.

launchAsync(token: string, subdomain: string, content: Content, options?: Options): Promise<LaunchResponse>;

launchAsync Parameters

Retouren

Retourneert Promise<LaunchResponse> een , die wordt opgelost wanneer Insluitende lezer wordt geladen. De Promise wordt opgelost in een LaunchResponse -object.

Uitzonderingen

De Promise geretourneerde wordt geweigerd met een Error -object als de Insluitende lezer kan worden geladen. Zie de foutcodes voor meer informatie.

sluiten

Sluit de Insluitende lezer.

Een voorbeeld van een gebruiksvoorbeeld voor deze functie is als de knop Afsluiten wordt verborgen door hideExitButton: true in opties in te stellen. Vervolgens kan deze functie met een andere knop (bijvoorbeeld de pijl-terug van een mobiele koptekst) worden close aanroepen wanneer erop wordt geklikt.

close(): void;

Insluitende lezer Knop Starten

De SDK biedt de standaardstijl voor de knop voor het starten van Insluitende lezer. Gebruik het immersive-reader-button klassekenmerk om deze stijl in te stellen. Zie De knop Insluitende lezer aanpassen voor meer informatie.

<div class='immersive-reader-button'></div>

Optionele kenmerken

Gebruik de volgende kenmerken om het uiterlijk van de knop te configureren.

renderButtons

De functie is niet nodig als u de richtlijnen voor het aanpassen van de Insluitende lezer renderButtons gebruikt.

Met deze functie worden de knopelementen van het document Insluitende lezer bijgewerkt. Als options.elements is opgegeven, worden de knoppen weergegeven binnen elk element dat is opgegeven in options.elements . Het gebruik van de parameter is handig als u meerdere secties in uw document hebt waarin u de Insluitende lezer kunt starten en u op een vereenvoudigde manier meerdere knoppen met dezelfde stijl wilt renderen, of als u de knoppen wilt renderen met een eenvoudig en options.elements consistent ontwerppatroon. Als u deze functie wilt gebruiken met de parameter renderButtons-opties, roept u aan bij het laden van pagina's, zoals ImmersiveReader.renderButtons(options: RenderButtonsOptions); wordt gedemonstreerd in het onderstaande codefragment. Anders worden de knoppen weergegeven in de elementen van het document die de klasse hebben, zoals wordt weergegeven in De knop Insluitende lezer immersive-reader-button aanpassen.

// This snippet assumes there are two empty div elements in
// the page HTML, button1 and button2.
const btn1: HTMLDivElement = document.getElementById('button1');
const btn2: HTMLDivElement = document.getElementById('button2');
const btns: HTMLDivElement[] = [btn1, btn2];
ImmersiveReader.renderButtons({elements: btns});

Zie de bovenstaande optionele kenmerken voor meer renderingopties. Als u deze opties wilt gebruiken, voegt u een van de optiekenmerken toe aan elk HTMLDivElement kenmerk in de HTML-code van uw pagina.

renderButtons(options?: RenderButtonsOptions): void;

renderButtons Parameters

renderButtons-opties

Opties voor het weergeven van de Insluitende lezer knoppen.

{
    elements: HTMLDivElement[];
}

parameters voor renderButtons-opties

elements

Type: HTMLDivElement[]
Required: false

LaunchResponse

Bevat het antwoord van de aanroep naar ImmersiveReader.launchAsync . Houd er rekening mee dat een verwijzing naar de die Insluitende lezer iframe kan worden gebruikt via container.firstChild .

{
    container: HTMLDivElement;
    sessionId: string;
}

LaunchResponse-parameters

Fout

Bevat informatie over een fout.

{
    code: string;
    message: string;
}

Foutparameters

Foutcodes

Typen

Content

Bevat de inhoud die moet worden weergegeven in de Insluitende lezer.

{
    title?: string;
    chunks: Chunk[];
}

Inhoudsparameters

title

Type: String
Required: false
Default value: "Immersive Reader" 

chunks

Type: Chunk[]
Required: true
Default value: null 

Chunk

Eén gegevensslekken die worden doorgegeven aan de inhoud van de Insluitende lezer.

{
    content: string;
    lang?: string;
    mimeType?: string;
}

Segmentparameters

content

Type: String
Required: true
Default value: null 

lang

Type: String
Required: false
Default value: Automatically detected 

mimeType

Type: String
Required: false
Default value: "text/plain"

Ondersteunde MIME-typen

Opties

Bevat eigenschappen die bepaald gedrag van de Insluitende lezer.

{
    uiLang?: string;
    timeout?: number;
    uiZIndex?: number;
    useWebview?: boolean;
    onExit?: () => any;
    allowFullscreen?: boolean;
    hideExitButton?: boolean;
    cookiePolicy?: CookiePolicy;
    disableFirstRun?: boolean;
    readAloudOptions?: ReadAloudOptions;
    translationOptions?: TranslationOptions;
    displayOptions?: DisplayOptions;
    preferences?: string;
    onPreferencesChanged?: (value: string) => any;
    customDomain?: string;
}

Optiesparameters

uiLang

Type: String
Required: false
Default value: User's browser language 

timeout

Type: Number
Required: false
Default value: 15000

uiZIndex

Type: Number
Required: false
Default value: 1000

onExit

Type: Function
Required: false
Default value: null

preferences

Type: String
Required: false
Default value: null

onPreferencesChanged

Type: Function
Required: false
Default value: null

customDomain

Type: String
Required: false
Default value: null

ReadAloudOptions

type ReadAloudOptions = {
    voice?: string;
    speed?: number;
    autoplay?: boolean;
};

ReadAloudOptions-parameters

voice

Type: String
Required: false
Default value: "Female" or "Male" (determined by language) 
Values available: "Female", "Male"

speed

Type: Number
Required: false
Default value: 1
Values available: 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2, 2.25, 2.5

TranslationOptions

type TranslationOptions = {
    language: string;
    autoEnableDocumentTranslation?: boolean;
    autoEnableWordTranslation?: boolean;
};

TranslationOptions Parameters

language

Type: String
Required: true
Default value: null 
Values available: See the Supported Languages section

DisplayOptions

type DisplayOptions = {
    textSize?: number;
    increaseSpacing?: boolean;
    fontFamily?: string;
};

DisplayOptions-parameters

textSize

Type: Number
Required: false
Default value: 20, 36 or 42 (Determined by screen size)
Values available: 14, 20, 28, 36, 42, 48, 56, 64, 72, 84, 96

fontFamily

Type: String
Required: false
Default value: "Calibri"
Values available: "Calibri", "Sitka", "ComicSans"

CookiePolicy-opties

enum CookiePolicy { Disable, Enable }

De onderstaande instellingen zijn alleen ter informatie bedoeld. De Insluitende lezer slaat de instellingen of gebruikersvoorkeuren op in cookies. Met deze cookiePolicy-optie wordt het gebruik van cookies standaard uitgeschakeld om te voldoen aan de cookie-nalevingswetgeving van de EU. Als u cookies opnieuw wilt inschakelen en de standaardfunctionaliteit voor Insluitende lezer-gebruikersvoorkeuren wilt herstellen, moet u ervoor zorgen dat uw website of toepassing de juiste toestemming van de gebruiker krijgt om cookies in te schakelen. Als u vervolgens cookies in de Insluitende lezer wilt inschakelen, moet u de optie cookiePolicy expliciet instellen op CookiePolicy.Enable bij het starten van de Insluitende lezer. In de onderstaande tabel wordt beschreven welke Insluitende lezer in de cookie opgeslagen wanneer de optie cookiePolicy is ingeschakeld.

Instellingen Parameters

Ondersteunde talen

De vertaalfunctie van Insluitende lezer ondersteunt veel talen. Zie Taalondersteuning voor meer informatie.

HTML-ondersteuning

Wanneer opmaak is ingeschakeld, wordt de volgende inhoud weergegeven als HTML in de Insluitende lezer.

Niet-ondersteunde tags worden vergelijkbaar weergegeven. Afbeeldingen en tabellen worden momenteel niet ondersteund.

Browserondersteuning

Gebruik de meest recente versies van de volgende browsers voor de beste ervaring met de Insluitende lezer.

• Microsoft Edge
• Internet Explorer 11
• Google Chrome
• Mozilla Firefox
• Apple Safari

Volgende stappen

• De Insluitende lezer SDK op GitHub
• Quickstart: Een web-app maken waarmee de Insluitende lezer (C#)