Skip to content

Commit 5081866

Browse files
authored
Merge pull request #101444 from metanMSFT/metan/reference-fixes
Update Immersive Reader reference
2 parents 33994c5 + eba8fad commit 5081866

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

articles/cognitive-services/immersive-reader/reference.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Immersive Reader SDK Reference"
33
titleSuffix: Azure Cognitive Services
4-
description: The Immersive Reader SDK is a JavaScript library that allows you to integrate the Immersive Reader into your web application.
4+
description: The Immersive Reader SDK contains a JavaScript library that allows you to integrate the Immersive Reader into your application.
55
services: cognitive-services
66
author: metanMSFT
77
manager: nitinme
@@ -15,7 +15,7 @@ ms.author: metan
1515

1616
# Immersive Reader SDK Reference Guide
1717

18-
The Immersive Reader SDK is a JavaScript library that allows you to integrate the Immersive Reader into your web application.
18+
The Immersive Reader SDK contains a JavaScript library that allows you to integrate the Immersive Reader into your application.
1919

2020
## Functions
2121

@@ -32,7 +32,7 @@ The SDK exposes the functions:
3232
Launches the Immersive Reader within an `iframe` in your web application.
3333

3434
```typescript
35-
launchAsync(token: string, subdomain: string, content: Content, options?: Options): Promise<HTMLDivElement>;
35+
launchAsync(token: string, subdomain: string, content: Content, options?: Options): Promise<LaunchResponse>;
3636
```
3737

3838
### Parameters
@@ -46,7 +46,7 @@ launchAsync(token: string, subdomain: string, content: Content, options?: Option
4646

4747
### Returns
4848

49-
Returns a `Promise<HTMLDivElement>`, which resolves when the Immersive Reader is loaded. The `Promise` resolves to a `div` element whose only child is an `iframe` element that contains the Immersive Reader page.
49+
Returns a `Promise<LaunchResponse>`, which resolves when the Immersive Reader is loaded. The `Promise` resolves to a [`LaunchResponse`](#launchresponse) object.
5050

5151
### Exceptions
5252

@@ -105,6 +105,17 @@ A single chunk of data, which will be passed into the Content of the Immersive R
105105
}
106106
```
107107

108+
### LaunchResponse
109+
110+
Contains the response from the call to `ImmersiveReader.launchAsync`.
111+
112+
```typescript
113+
{
114+
container: HTMLDivElement; // HTML element which contains the Immersive Reader iframe
115+
sessionId: string; // Globally unique identifier for this session, used for debugging
116+
}
117+
```
118+
108119
### CookiePolicy enum
109120

110121
An enum used to set the policy for the Immersive Reader's cookie usage. See [options](#options).
@@ -123,6 +134,7 @@ enum CookiePolicy { Disable, Enable }
123134
| application/vnd.openxmlformats-officedocument.wordprocessingml.document | Microsoft Word .docx format document.
124135

125136
### HTML Support
137+
126138
| HTML | Supported Content |
127139
| --------- | ----------- |
128140
| Font Styles | Bold, Italic, Underline, Code, Strikethrough, Superscript, Subscript |
@@ -182,7 +194,7 @@ Contains information about the error.
182194

183195
## Launching the Immersive Reader
184196

185-
The SDK provides default styling for the button for launching the Immersive Reader. Use the `immersive-reader-button` class attribute to enable this styling.
197+
The SDK provides default styling for the button for launching the Immersive Reader. Use the `immersive-reader-button` class attribute to enable this styling. See [this article](./how-to-customize-launch-button.md) for more details.
186198

187199
```html
188200
<div class='immersive-reader-button'></div>

0 commit comments

Comments
 (0)