Asistivní čtečka Referenční dokumentace sady JavaScript SDK (v 1.1)

sada Asistivní čtečka SDK obsahuje knihovnu javascriptu, která umožňuje integrovat Asistivní čtečka do aplikace.

Functions

Sada SDK zpřístupňuje funkce:

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

• ImmersiveReader.close()

• ImmersiveReader.renderButtons(options)

launchAsync

spustí Asistivní čtečka v rámci iframe ve vaší webové aplikaci. Všimněte si, že velikost vašeho obsahu je omezená na maximálně 50 MB.

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

Parametry launchAsync

Návraty

vrátí hodnotu Promise<LaunchResponse> , která se vyřeší při načtení Asistivní čtečka. PromisePřekládá na LaunchResponse objekt.

Výjimky

vrácený Promise objekt bude odmítnut s Error objektem, pokud se Asistivní čtečka nezdaří načíst. Další informace najdete v tématu kódy chyb.

close

zavře Asistivní čtečka.

Příkladem případu použití této funkce je, že je tlačítko Ukončit skryto nastavením hideExitButton: true v Možnosti. Pak jiné tlačítko (například šipky zpět pro mobilní hlavičku) může zavolat tuto close funkci, když na ni kliknete.

close(): void;

Asistivní čtečka Tlačítko pro spuštění

sada SDK poskytuje výchozí styl pro tlačítko pro spuštění Asistivní čtečka. immersive-reader-buttonPro povolení tohoto stylu použijte atribut class. další podrobnosti najdete v tématu jak přizpůsobit tlačítko Asistivní čtečka .

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

Volitelné atributy

Pomocí následujících atributů můžete nakonfigurovat vzhled a chování tlačítka.

renderButtons

tato renderButtons funkce není nutná, pokud používáte pokyny k přizpůsobení Asistivní čtečkaho tlačítka .

tato funkce styly a aktualizuje elementy Asistivní čtečkaho tlačítka dokumentu. Pokud options.elements je k dispozici, pak se tlačítka vykreslí v rámci každého prvku, který je součástí options.elements . použití options.elements parametru je užitečné, pokud máte ve svém dokumentu více oddílů, na kterých chcete spustit Asistivní čtečka, a chcete zjednodušit vykreslení více tlačítek se stejným stylem nebo chcete vykreslit tlačítka pomocí jednoduchého a konzistentního vzoru návrhu. Chcete-li použít tuto funkci s parametrem renderButtons Options , zavolejte ImmersiveReader.renderButtons(options: RenderButtonsOptions); na načtení stránky, jak je znázorněno v následujícím fragmentu kódu. v opačném případě se tlačítka vykreslí v rámci prvků dokumentu, které mají třídu immersive-reader-button , jak je znázorněno v postupu přizpůsobení Asistivní čtečkaho tlačítka .

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

Další možnosti vykreslování najdete na výše uvedených volitelných atributech . Chcete-li použít tyto možnosti, přidejte všechny atributy možností na každou HTMLDivElement stránku ve formátu HTML stránky.

renderButtons(options?: RenderButtonsOptions): void;

Parametry renderButtons

renderButtons možnosti

možnosti pro vykreslování tlačítek Asistivní čtečka

{
    elements: HTMLDivElement[];
}

Parametry možností renderButtons

elements

Type: HTMLDivElement[]
Required: false

LaunchResponse

Obsahuje odpověď od volání ImmersiveReader.launchAsync . všimněte si, že odkaz na iframe , který obsahuje Asistivní čtečka, je k dispozici prostřednictvím container.firstChild .

{
    container: HTMLDivElement;
    sessionId: string;
}

Parametry LaunchResponse

Chyba

Obsahuje informace o chybě.

{
    code: string;
    message: string;
}

Parametry chyby

Kódy chyb

Typy

Content

Obsahuje obsah, který se má zobrazit v Asistivní čtečka.

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

Parametry obsahu

title

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

chunks

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

Blok dat

Jeden blok dat, který se předá do obsahu Asistivní čtečka.

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

Parametry bloků dat

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"

Podporované typy MIME

Možnosti

Obsahuje vlastnosti, které konfigurují určité chování Asistivní čtečka.

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

Parametry možností

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

Parametry ReadAloudOptions

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 (Možnosti překladu)

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

TranslationOptions – parametry

language

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

Možnosti zobrazení

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

Parametry 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"

Možnosti CookiePolicy

enum CookiePolicy { Disable, Enable }

Nastavení uvedená níže jsou jenom pro informační účely. Aplikace Asistivní čtečka ukládá nastavení (nebo předvolby uživatelů) do souborů cookie. Tato možnost cookiePolicy ve výchozím nastavení zakazuje používání souborů cookie, aby byly v souladu se zákony EU o dodržování předpisů ohledně souborů cookie. Pokud chcete soubory cookie znovu povolit Asistivní čtečka obnovit výchozí funkce pro předvolby uživatelů, budete muset zajistit, aby váš web nebo aplikace získaly od uživatele správný souhlas s povolením souborů cookie. Pokud pak chcete znovu povolit soubory cookie v Asistivní čtečka, musíte při spuštění souboru explicitně nastavit možnost cookiePolicy na CookiePolicy.Enable Asistivní čtečka. Následující tabulka popisuje, jaká nastavení Asistivní čtečka uloží do souboru cookie, když je povolená možnost cookiePolicy.

Nastavení Parametry

Podporované jazyky

Funkce překladu v Asistivní čtečka podporuje mnoho jazyků. Další podrobnosti najdete v tématu Podpora jazyků.

Podpora HTML

Pokud je formátování povolené, vykreslí se následující obsah ve formátu HTML v Asistivní čtečka.

Nepodporované značky se vykreslí porovnatelně. Obrázky a tabulky se v současné době nepodporují.

Podpora prohlížečů

Pro nejlepší prostředí s tímto rozhraním použijte nejnovější verze následujících Asistivní čtečka.

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

Další kroky

• Prozkoumání sady Asistivní čtečka SDK na GitHub
• Rychlý start: Vytvoření webové aplikace, která spustí Asistivní čtečka (C#)