Avancerad läsare JavaScript SDK-referens (v1.1)

Sdk:Avancerad läsare innehåller ett JavaScript-bibliotek som gör att du kan integrera Avancerad läsare i ditt program.

Functions

SDK:n exponerar funktionerna:

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

• ImmersiveReader.close()

• ImmersiveReader.renderButtons(options)

launchAsync

Startar Avancerad läsare i en iframe i ditt webbprogram. Observera att storleken på ditt innehåll är begränsad till högst 50 MB.

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

launchAsync-parametrar

Returer

Returnerar Promise<LaunchResponse> en , som matchas när Avancerad läsare läses in. Promisematchas mot ett LaunchResponse -objekt.

Undantag

Returnerade Promise avvisas med ett Error -objekt om Avancerad läsare inte kan läsas in. Mer information finns i felkoderna.

stäng

Stänger Avancerad läsare.

Ett exempel på ett användningsfall för den här funktionen är om avslutsknappen är dold genom att hideExitButton: true ange i alternativen. Sedan kan en annan knapp (till exempel en mobil rubriks bakåtpil) anropa den close här funktionen när den klickas.

close(): void;

Avancerad läsare Starta knapp

SDK:n tillhandahåller standardformat för knappen för att starta Avancerad läsare. Använd immersive-reader-button klassattributet för att aktivera det här format. Mer information finns i Anpassa Avancerad läsare för mer information.

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

Valfria attribut

Använd följande attribut för att konfigurera utseendet och känslan för knappen.

renderButtons

Funktionen är inte nödvändig om du använder anvisningar för att anpassa renderButtons Avancerad läsare knappvägledning.

Den här funktionen utformar och uppdaterar dokumentets Avancerad läsare knappelement. Om options.elements anges återges knapparna i varje element som anges i options.elements . Att använda parametern är användbart när du har flera avsnitt i dokumentet där du kan starta Avancerad läsare och vill ha ett förenklat sätt att rendera flera knappar med samma format, eller om du vill rendera knapparna med ett enkelt och konsekvent options.elements designmönster. Om du vill använda den här funktionen med parametern renderButtons-alternativ anropar du vid sidinläsning ImmersiveReader.renderButtons(options: RenderButtonsOptions); enligt nedanstående kodfragment. Annars renderas knapparna i dokumentets element som har klassen som visas i Anpassa immersive-reader-button Avancerad läsare knappen .

// 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});

Se ovanstående valfria attribut för fler återgivningsalternativ. Om du vill använda de här alternativen lägger du till något av alternativattributen till HTMLDivElement var och en på sidans HTML.

renderButtons(options?: RenderButtonsOptions): void;

renderButtons-parametrar

renderButtons-alternativ

Alternativ för att återge Avancerad läsare knappar.

{
    elements: HTMLDivElement[];
}

renderButtons-alternativparametrar

elements

Type: HTMLDivElement[]
Required: false

LaunchResponse

Innehåller svaret från anropet till ImmersiveReader.launchAsync . Observera att en referens till iframe som innehåller Avancerad läsare kan nås via container.firstChild .

{
    container: HTMLDivElement;
    sessionId: string;
}

LaunchResponse-parametrar

Fel

Innehåller information om ett fel.

{
    code: string;
    message: string;
}

Felparametrar

Felkoder

Typer

Innehåll

Innehåller det innehåll som ska visas i Avancerad läsare.

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

Innehållsparametrar

title

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

chunks

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

Segment

Ett enda data segment som skickas till innehållet i Avancerad läsare.

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

Segmentparametrar

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"

MIME-typer som stöds

Alternativ

Innehåller egenskaper som konfigurerar vissa beteenden för Avancerad läsare.

{
    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;
}

Alternativparametrar

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

ReadOptions

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

ReadOptions-parametrar

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-parametrar

language

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

DisplayOptions

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

Parametrar för DisplayOptions

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-alternativ

enum CookiePolicy { Disable, Enable }

Inställningarna som anges nedan är endast i informationssyfte. Den Avancerad läsare lagrar sina inställningar, eller användarinställningar, i cookies. Det här cookiePolicy-alternativet inaktiverar användningen av cookies som standard för att följa EU:s lagar om cookieefterlevnad. Om du vill återaktivera cookies och återställa standardfunktionerna för Avancerad läsare-användarinställningar måste du se till att din webbplats eller ditt program får rätt medgivande från användaren för att aktivera cookies. Om du sedan vill återaktivera cookies i Avancerad läsare måste du uttryckligen ange alternativet cookiePolicy till CookiePolicy.Enable när du startar Avancerad läsare. Tabellen nedan beskriver vilka inställningar som Avancerad läsare i sin cookie när alternativet cookiePolicy är aktiverat.

Inställningar Parametrar

Språk som stöds

Översättningsfunktionen i Avancerad läsare stöder många språk. Mer information finns i Språkstöd.

HTML-stöd

När formatering har aktiverats återges följande innehåll som HTML i Avancerad läsare.

Taggar som inte stöds återges jämförelsevis. Avbildningar och tabeller stöds inte för närvarande.

Stöd för webbläsare

Använd de senaste versionerna av följande webbläsare för bästa möjliga upplevelse med Avancerad läsare.

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

Nästa steg

• Utforska Avancerad läsare SDK på GitHub
• Snabbstart: Skapa en webbapp som startar Avancerad läsare (C#)