Skip to content

Commit fadaaa5

Browse files
authored
Update call-readiness-tutorial-part-1-browser-support.md
1 parent c257983 commit fadaaa5

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

articles/communication-services/tutorials/call-readiness/call-readiness-tutorial-part-1-browser-support.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.subservice: calling
1717

1818
[!INCLUDE [Public Preview Notice](../../includes/public-preview-include.md)]
1919

20-
In this tutorial, we'll be using Azure Communication Services with the [UI Library](https://aka.ms/acsstorybook) to create an experience that gets users ready to join a call. The UI Library provides a set of rich components and UI controls that can be used to produce a Call Readiness experience, as well as a rich set of APIs to understand the user state.
20+
In this tutorial, we are using Azure Communication Services with the [UI Library](https://aka.ms/acsstorybook) to create an experience that gets users ready to join a call. The UI Library provides a set of rich components and UI controls that can be used to produce a Call Readiness experience, and a rich set of APIs to understand the user state.
2121

2222
## Prerequisites
2323

@@ -30,13 +30,13 @@ Access the full code for this tutorial on [GitHub](https://github.com/Azure-Samp
3030
## Checking for Browser Support
3131

3232
To ensure the user gets the best experience, we want to first make sure they're on a [supported browser](../../concepts/voice-video-calling/calling-sdk-features.md#javascript-calling-sdk-support-by-os-and-browser).
33-
In this section, we'll create a page that displays "Preparing your session" whilst we perform a quick support check in the background on the user's browser.
33+
In this section, we create a page that displays "Preparing your session" whilst we perform a quick support check in the background on the user's browser.
3434

3535
![Gif showing browser check being performed](../media/call-readiness/checking-browser-support.gif)
3636

3737
### Preparing Your Session Page
3838

39-
Create a new file called `PreparingYourSession.tsx` where we'll create a spinner to show to the user while we perform asynchronous checks in the background:
39+
Create a new file called `PreparingYourSession.tsx` where we create a spinner to show to the user while we perform asynchronous checks in the background:
4040

4141
`src/PreparingYourSession.tsx`
4242

@@ -85,7 +85,7 @@ const spinnerContainerStyles = (theme: ITheme): IStackStyles => ({
8585
```
8686

8787
We can then hook up this Preparing your session screen into our App.
88-
In the `App.tsx` and a variable `testState` to track the state of the app and while `testState` is in `runningEnvironmentChecks` state we'll show the Preparing Your Session Screen.
88+
In the `App.tsx` and a variable `testState` to track the state of the app and while `testState` is in `runningEnvironmentChecks` state we show the Preparing Your Session Screen.
8989

9090
First, add the following imports to our `App.tsx` file that we created in the overview:
9191

@@ -112,17 +112,17 @@ const App = (): JSX.Element => {
112112
</>
113113
)}
114114

115-
{/* After the device setup is complete, take the user to the call. For this sample we will just show a test complete page. */}
115+
{/* After the device setup is complete, take the user to the call. For this sample we show a test complete page. */}
116116
{testState === 'finished' && <TestComplete />}
117117
</CallClientProvider>
118118
</FluentThemeProvider>
119119
);
120120
}
121121
```
122122

123-
### Performing a Environment information check
123+
### Performing an Environment information check
124124

125-
First create a utility file call `environmentSupportUtils.ts`. Inside this call, we'll add a method `checkEnvironmentSupport`. This method will use the [Calling Stateful Client](https://azure.github.io/communication-ui-library/?path=/docs/statefulclient-overview--page) to perform a request for the environment information that the Calling Stateful Client is running on.
125+
First create a utility file call `environmentSupportUtils.ts`. Inside this call, we add a method `checkEnvironmentSupport`. This method uses the [Calling Stateful Client](https://azure.github.io/communication-ui-library/?path=/docs/statefulclient-overview--page) to perform a request for the environment information that the Calling Stateful Client is running on.
126126

127127
`src/environmentSupportUtils.ts`
128128

@@ -147,14 +147,14 @@ The data that returns from this call is the following:
147147

148148
### Informing the user they are on an unsupported browser
149149

150-
Next, we will need to use this information provided from the Calling SDK to inform the user of the state of their environment if there is a issue. The UI library provides three different components to serve this purpose depending on what the issue is.
150+
Next, we need to use this information provided from the Calling SDK to inform the user of the state of their environment if there's an issue. The UI library provides three different components to serve this purpose depending on what the issue is.
151151

152152
- `UnsupportedOperatingSystem`
153153
- `UnsupportedBrowser`
154154
- `UnsupportedBrowserVersion`
155155

156-
To do this, we'll host the UI Library's components inside a [FluentUI Modal](https://developer.microsoft.com/fluentui#/controls/web/modal):
157-
Create a new file called `UnsupportedEnvironmentPrompts.tsx` where we'll create the different prompts:
156+
We start by hosting the UI Library's components inside a [FluentUI Modal](https://developer.microsoft.com/fluentui#/controls/web/modal):
157+
Create a new file called `UnsupportedEnvironmentPrompts.tsx` where we create the different prompts:
158158

159159
`src/UnsupportedEnvironmentPrompts.tsx`
160160

@@ -201,9 +201,9 @@ export const OperatingSystemUnsupportedPrompt = (props: { isOpen: boolean }): JS
201201
);
202202
```
203203

204-
We can then show these prompts in a Environment Check Component.
205-
Create a file called `EnvironmentChecksComponent.tsx` that will contain the logic for showing this prompt:
206-
This component will have a callback `onTestsSuccessful` that can take the user to the next page in the App.
204+
We can then show these prompts in an Environment Check Component.
205+
Create a file called `EnvironmentChecksComponent.tsx` that contains the logic for showing this prompt:
206+
This component has a callback `onTestsSuccessful` that can take the user to the next page in the App.
207207

208208
`src/EnvironmentChecksComponent.tsx`
209209

@@ -237,21 +237,21 @@ export const EnvironmentChecksComponent = (props: {
237237
useEffect(() => {
238238
const runEnvironmentChecks = async (): Promise<void> => {
239239

240-
// First we will get the environment information from the calling SDK.
240+
// First we get the environment information from the calling SDK.
241241
const environmentInfo = await checkEnvironmentSupport(callClient);
242242

243243
if (!environmentInfo.isSupportedPlatform) {
244244
setCurrentCheckState('operatingSystemUnsupported');
245-
// If the platform or operating system is not supported we will stop here and display a modal to the user.
245+
// If the platform or operating system is not supported we stop here and display a modal to the user.
246246
return;
247247
} else if (!environmentInfo.isSupportedBrowser) {
248248
setCurrentCheckState('browserUnsupported');
249-
// If browser support fails, we will stop here and display a modal to the user.
249+
// If browser support fails, we stop here and display a modal to the user.
250250
return;
251251
} else if (!environmentInfo.isSupportedBrowserVersion) {
252252
setCurrentCheckState('browserVersionUnsupported');
253253
/**
254-
* If the browser version is unsupported, we will stop here and show a modal that can allow the user
254+
* If the browser version is unsupported, we stop here and show a modal that can allow the user
255255
* to continue into the call.
256256
*/
257257
return;
@@ -279,7 +279,7 @@ export const EnvironmentChecksComponent = (props: {
279279
}
280280
```
281281

282-
We can then add the `EnvironmentChecksComponent` to the `App.tsx`. The App will then move the user to the _Device Checks_ stage once the test is successful using the `onTestsSuccessful` callback:
282+
We can then add the `EnvironmentChecksComponent` to the `App.tsx`. The App then move the user to the _Device Checks_ stage once the test is successful using the `onTestsSuccessful` callback:
283283

284284
Let's now import the new component into our app in `App.tsx`
285285

@@ -306,7 +306,7 @@ const App = (): JSX.Element => {
306306
</>
307307
)}
308308

309-
{/* After the device setup is complete, take the user to the call. For this sample we will just show a test complete page. */}
309+
{/* After the device setup is complete, take the user to the call. For this sample we show a test complete page. */}
310310
{testState === 'finished' && <TestComplete />}
311311
</CallClientProvider>
312312
</FluentThemeProvider>

0 commit comments

Comments
 (0)