Tam Ekran Okuyucu JavaScript SDK başvurusu (v 1.1)

Tam Ekran Okuyucu SDK, Tam Ekran Okuyucu uygulamanıza tümleştirmenize olanak tanıyan bir JavaScript kitaplığı içerir.

İşlevler

SDK işlevleri kullanıma sunar:

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

• ImmersiveReader.close()

• ImmersiveReader.renderButtons(options)

launchAsync

Tam Ekran Okuyucu web uygulamanızdaki bir içinde başlatır iframe . İçeriğinizin boyutunun en fazla 50 MB ile sınırlı olduğunu unutmayın.

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

launchAsync parametreleri

Döndürülenler

Promise<LaunchResponse>Tam Ekran Okuyucu yüklendiğinde çözümlenen bir döndürür. PromiseBir nesne olarak çözümlenir LaunchResponse .

Özel durumlar

PromiseTam Ekran Okuyucu yüklenamazsa, döndürülen bir nesne ile reddedilir Error . Daha fazla bilgi için bkz. hata kodları.

close

Tam Ekran Okuyucu kapatır.

Bu işlev için bir örnek kullanım örneği, hideExitButton: true Seçenekler' de ayar yaparak çıkış düğmesidir. Ardından, farklı bir düğme (örneğin, bir mobil üstbilginin geri oku) tıklandığında bu işlevi çağırabilir close .

close(): void;

Tam Ekran Okuyucu Başlat düğmesi

SDK, Tam Ekran Okuyucu başlatmaya yönelik düğme için varsayılan stil sağlar. immersive-reader-buttonBu stillendirme özelliğini etkinleştirmek için Class özniteliğini kullanın. daha fazla ayrıntı için bkz. Tam Ekran Okuyucu düğmesini özelleştirme .

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

İsteğe bağlı öznitelikler

Düğmenin genel görünümünü yapılandırmak için aşağıdaki öznitelikleri kullanın.

renderButtons

renderButtons Tam Ekran Okuyucu düğme kılavuzunu özelleştirmeyi özelleştirmek için işlevi gerekli değildir.

bu işlev stilleri ve belgenin Tam Ekran Okuyucu düğmesi öğelerini güncelleştirir. options.elementsSağlanırsa, düğmeleri ' de verilen her öğe içinde işlenir options.elements . , options.elements belgenizde Tam Ekran Okuyucu başlatılacak birden çok bölüm varsa ve aynı stille birden çok düğme işlemek veya düğmeleri basit ve tutarlı bir tasarım düzeniyle işlemek istiyorsanız, parametresini kullanmak faydalıdır. Bu işlevi RenderButtons seçenekleri parametresiyle birlikte kullanmak için, ImmersiveReader.renderButtons(options: RenderButtonsOptions); Aşağıdaki kod parçacığında gösterildiği gibi sayfa yüküne çağrı yapın. aksi halde, düğmeler, immersive-reader-button ' ın nasıl Tam Ekran Okuyucu özelleştirileceği ile gösterildiği gibi, sınıfının bulunduğu öğeler içinde işlenir.

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

Daha fazla işleme seçeneği için yukarıdaki Isteğe bağlı öznitelikleri inceleyin. Bu seçenekleri kullanmak için, HTMLDivElement sayfa HTML 'inizdeki her bir seçenek özniteliğini ekleyin.

renderButtons(options?: RenderButtonsOptions): void;

renderButtons parametreleri

renderButtons seçenekleri

Tam Ekran Okuyucu düğmelerini işleme seçenekleri.

{
    elements: HTMLDivElement[];
}

renderButtons seçenek parametreleri

elements

Type: HTMLDivElement[]
Required: false

LaunchResponse

Çağrısının yanıtını içerir ImmersiveReader.launchAsync . iframeile Tam Ekran Okuyucu içeren bir başvuruya aracılığıyla erişilebileceğini unutmayın container.firstChild .

{
    container: HTMLDivElement;
    sessionId: string;
}

LaunchResponse parametreleri

Hata

Bir hata hakkındaki bilgileri içerir.

{
    code: string;
    message: string;
}

Hata parametreleri

Hata kodları

Türler

Content

Tam Ekran Okuyucu gösterilecek içeriği içerir.

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

İçerik parametreleri

title

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

chunks

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

Öbek

Tam Ekran Okuyucu içeriğine geçirilecek tek bir veri öbeği.

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

Öbek parametreleri

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"

Desteklenen MIME türleri

Seçenekler

Tam Ekran Okuyucu belirli davranışlarını yapılandıran özellikler içerir.

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

Seçenek parametreleri

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 Parametreleri

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 Parametreleri

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 Parametreleri

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 Seçenekleri

enum CookiePolicy { Disable, Enable }

Aşağıda listelenen ayarlar yalnızca bilgilendirme amaçlıdır. Bu Tam Ekran Okuyucu ayarlarını veya kullanıcı tercihlerini tanımlama bilgilerinde depolar. Bu cookiePolicy seçeneği, AB Tanımlama Bilgisi Uyumluluğu yasalarına uymak için tanımlama bilgilerinin kullanımını varsayılan olarak devre dışı bırakmaktadır. Tanımlama bilgilerini yeniden etkinleştirmek ve Tam Ekran Okuyucu tercihleri için varsayılan işlevselliği geri yüklemek istemeniz, web sitenizin veya uygulamanın tanımlama bilgilerini etkinleştirmek için kullanıcıdan doğru onayı ala olduğundan emin olmak gerekir. Ardından, tanımlama bilgilerini Tam Ekran Okuyucu yeniden etkinleştirmek için, tanımlama bilgilerini etkinleştirirken cookiePolicy seçeneğini CookiePolicy.Enable olarak açıkça Tam Ekran Okuyucu. Aşağıdaki tabloda, cookiePolicy seçeneği Tam Ekran Okuyucu tanımlama bilgisinde hangi ayarları depolay olduğu açıklanmıştır.

Ayarlar Parametre

Desteklenen Diller

Tam Ekran Okuyucu çeviri özelliği birçok dili destekler. Daha fazla bilgi için bkz. dil desteği .

HTML desteği

biçimlendirme etkinleştirildiğinde, aşağıdaki içerik Tam Ekran Okuyucu HTML olarak işlenir.

Desteklenmeyen Etiketler comparably işlenecek. Görüntüler ve tablolar şu anda desteklenmiyor.

Tarayıcı desteği

Tam Ekran Okuyucu en iyi deneyim için aşağıdaki tarayıcıların en son sürümlerini kullanın.

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

Sonraki adımlar

• GitHub Tam Ekran Okuyucu SDK 'sını keşfet
• hızlı başlangıç: Tam Ekran Okuyucu başlatan bir web uygulaması oluşturma (C#)