Skip to content

Commit f212917

Browse files
Merge pull request #271869 from mayssamm/main
update ACS Rooms quickstarts to remove pstnDialOutEnabled public preview status
2 parents 5b00336 + 61c8fbf commit f212917

File tree

7 files changed

+39
-48
lines changed

7 files changed

+39
-48
lines changed

articles/communication-services/quickstarts/rooms/get-started-rooms.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,17 @@ This quickstart helps you get started with Azure Communication Services Rooms. A
1919

2020
## Object model
2121

22-
The table below lists the main properties of `room` objects:
22+
The following table lists the main properties of `room` objects:
2323

2424
| Name | Description |
2525
|-----------------------|-------------------------------------------|
2626
| `roomId` | Unique `room` identifier. |
2727
| `validFrom` | Earliest time a `room` can be used. |
2828
| `validUntil` | Latest time a `room` can be used. |
29-
| `pstnDialOutEnabled`* | Enable or disable dialing out to a PSTN number in a room.|
29+
| `pstnDialOutEnabled` | Enable or disable dialing out to a PSTN number in a room.|
3030
| `participants` | List of participants to a `room`. Specified as a `CommunicationIdentifier`. |
3131
| `roleType` | The role of a room participant. Can be either `Presenter`, `Attendee`, or `Consumer`. |
3232

33-
*pstnDialOutEnabled is currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
34-
3533
::: zone pivot="platform-azcli"
3634
[!INCLUDE[Use rooms with Azure CLI](./includes/rooms-quickstart-az-cli.md)]
3735
::: zone-end
@@ -63,7 +61,7 @@ This quickstart helps you get started with Azure Communication Services Rooms. A
6361

6462
## Next steps
6563

66-
Once you've created the room and configured it, you can learn how to [join a rooms call](join-rooms-call.md).
64+
You can learn how to [join a rooms call](join-rooms-call.md) after creating and configuring the room.
6765

6866
In this section you learned how to:
6967
> [!div class="checklist"]

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-az-cli.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ az extension add --name communication
2929
```
3030

3131
### Sign in to Azure CLI
32-
You'll need to [sign in to Azure CLI](/cli/azure/authenticate-azure-cli). You can sign in running the ```az login``` command from the terminal and providing your credentials.
32+
You need to [sign in to Azure CLI](/cli/azure/authenticate-azure-cli). You can sign in by running the ```az login``` command from the terminal and providing your credentials.
3333

3434

3535
### Store your connection string in an environment variable
@@ -42,7 +42,7 @@ You can configure the `AZURE_COMMUNICATION_CONNECTION_STRING` environment variab
4242
setx AZURE_COMMUNICATION_CONNECTION_STRING "<connectionString>"
4343
```
4444

45-
After you add the environment variable, you may need to restart any running programs that will need to read the environment variable, including the console window. For example, if you're using Visual Studio as your editor, restart Visual Studio before running the example.
45+
After you add the environment variable, you might need to restart any running programs that need to read the environment variable, including the console window. For example, if you're using Visual Studio as your editor, restart Visual Studio before running the example.
4646

4747
##### [macOS](#tab/unix)
4848

@@ -52,7 +52,7 @@ Edit your **`.zshrc`**, and add the environment variable:
5252
export AZURE_COMMUNICATION_CONNECTION_STRING="<connectionString>"
5353
```
5454

55-
After you add the environment variable, run `source ~/.zshrc` from your console window to make the changes effective. If you created the environment variable with your IDE open, you may need to close and reopen the editor, IDE, or shell in order to access the variable.
55+
After you add the environment variable, run `source ~/.zshrc` from your console window to make the changes effective. If you created the environment variable with your IDE open, you might need to close and reopen the editor, IDE, or shell in order to access the variable.
5656

5757
##### [Linux](#tab/linux)
5858

@@ -62,7 +62,7 @@ Edit your **`.bash_profile`**, and add the environment variable:
6262
export AZURE_COMMUNICATION_CONNECTION_STRING="<connectionString>"
6363
```
6464

65-
After you add the environment variable, run `source ~/.bash_profile` from your console window to make the changes effective. If you created the environment variable with your IDE open, you may need to close and reopen the editor, IDE, or shell in order to access the variable.
65+
After you add the environment variable, run `source ~/.bash_profile` from your console window to make the changes effective. If you created the environment variable with your IDE open, you might need to close and reopen the editor, IDE, or shell in order to access the variable.
6666

6767
---
6868

@@ -76,22 +76,20 @@ Use the `rooms create` command to create a room.
7676
az communication rooms create --presenter-participants "<participantId>" --consumer-participants "<participantId>" --attendee-participant "<participantId>" --valid-from "<valid-from>" --valid-until "<valid-until>" --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --connection-string "<connection-string>"
7777
```
7878

79-
- Use `<participantId>` optionally to specify the type of participant as presenter-participants, consumer-participants, or attendee-participants. If you do not specify a value, the default is empty.
79+
- Use `<participantId>` optionally to specify the type of participant as presenter-participants, consumer-participants, or attendee-participants. If you don't specify a value, the default is empty.
8080
- Replace `<connection-string>` with your Azure Communication Services connection string.
8181
- Use `<valid-from>` optionally to specify the timestamp when the room is open for joining, in ISO8601 format, ex: 2022-07-14T10:21.
8282
- Use `<valid-until>` optionally to specify the timestamp when the room can no longer be joined, in ISO8601 format, ex: 2022-07-14T10:21.
83-
- Use `<pstn-dial-out-enabled>`* optionally by setting this flag ("True" or "False") to enable or disable PSTN dial out for a room. By default, this flag is set to "False" when creating a room.
84-
85-
*`<pstn-dial-out-enabled>` is currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
83+
- Use `<pstn-dial-out-enabled>` optionally by setting this flag ("True" or "False") to enable or disable PSTN dial out for a room. By default, this flag is set to "False" when creating a room.
8684

8785
If you've stored the connection string in environment variables as stated above, you won't need to pass them to the command.
8886

8987
```azurecli-interactive
9088
az communication rooms create
9189
```
9290

93-
### Enable PSTN Dial Out Capability for a Room (Currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/))
94-
The PSTN dial out can be enabled during `rooms create` by defining the `--pstn-dial-out-enabled` parameter as "True". This capability may also be modified during `rooms update` by specifying the `--pstn-dial-out-enabled` parameter.
91+
### Enable PSTN dial out capability for a room
92+
The PSTN dial out can be enabled during `rooms create` by defining the `--pstn-dial-out-enabled` parameter as "True". This capability can also be modified during `rooms update` by specifying the `--pstn-dial-out-enabled` parameter.
9593

9694
```azurecli-interactive
9795
az communication rooms create --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --connection-string "<connection-string>"
@@ -101,7 +99,7 @@ az communication rooms create --pstn-dial-out-enabled "<pstn-dial-out-enabled>"
10199
az communication rooms update --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --room "<roomId>"
102100
```
103101

104-
- Use `<pstn-dial-out-enabled>` set this flag ("True" or "False") to enable or disable PSTN dial out for a room.
102+
- To enable or disable PSTN dial out for a room, set `<pstn-dial-out-enabled>` flag ("True" or "False").
105103

106104
### Get the rooms
107105

@@ -144,13 +142,13 @@ Use the `identity user create` command to create a new participant, identified b
144142
az communication identity user create
145143
```
146144

147-
Add a user as a participant to the room
145+
Add a user as a participant to the room.
148146

149147
```azurecli-interactive
150148
az communication rooms participant add-or-update --attendee-participant "<participantId>" --room "<roomId>"
151149
```
152150

153-
- Replace `<participantId>` with your participant ID. If the `<participantId>` does not exist in the room, the participant will be added to the room as an attendee role. Otherwise, the participant's role is updated to an attendee role.
151+
- Replace `<participantId>` with your participant ID. If the `<participantId>` doesn't exist in the room, the participant will be added to the room as an attendee role. Otherwise, the participant's role is updated to an attendee role.
154152
- Replace `<roomId>` with your room ID.
155153

156154
### Get list of participants in a room

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-call-ios.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ In Xcode, create a new iOS project and select the Single View App template. This
2525
:::image type="content" source="../../voice-video-calling/media/ios/xcode-new-ios-project.png" alt-text="Screenshot showing the New Project window within Xcode.":::
2626

2727
### Installing CocoaPods
28-
Please use this guide to [install CocoaPods](https://guides.cocoapods.org/using/getting-started.html) on your Mac.
28+
Use this guide to [install CocoaPods](https://guides.cocoapods.org/using/getting-started.html) on your Mac.
2929

3030
### Install the package and dependencies with CocoaPods
31-
1. To create a Podfile for your application open the terminal and navigate to the project folder and run pod init.
31+
1. To create a Podfile for your application, open the terminal and navigate to the project folder and run pod init.
3232

3333
2. Add the following code to the Podfile and save:
3434

@@ -43,11 +43,11 @@ end
4343

4444
3. Run pod install.
4545

46-
4. Open the .xcworkspace with Xcode.
46+
4. Open the `.xcworkspace` file with Xcode.
4747

4848

49-
### Request access to the Microphone and Camera
50-
To access the device's microphone and camera, you need to update your app's Information Property List with an `NSMicrophoneUsageDescription` and `NSCameraUsageDescription`. You set the associated value to a string that will be included in the dialog the system uses to request access from the user.
49+
### Request access to the microphone and camera
50+
To access the device's microphone and camera, you need to update your app's Information Property List with `NSMicrophoneUsageDescription` and `NSCameraUsageDescription`. Set the associated value to a string that will be included in the dialog the system uses to request access from the user.
5151

5252
Right-click the `Info.plist` entry of the project tree and select Open As > Source Code. Add the following lines the top level `<dict>` section, and then save the file.
5353

@@ -74,11 +74,11 @@ The following classes and interfaces handle some of the major features of the Az
7474
| CallClient | The CallClient is the main entry point to the Calling SDK. |
7575
| CallAgent | The CallAgent is used to start and manage calls. |
7676
| CommunicationTokenCredential | The CommunicationTokenCredential is used as the token credential to instantiate the CallAgent. |
77-
| CommunicationIdentifier | The CommunicationIdentifier is used to represent the identity of the user which can be one of the following: CommunicationUserIdentifier/PhoneNumberIdentifier/CallingApplication. |
77+
| CommunicationIdentifier | The CommunicationIdentifier is used to represent the identity of the user, and can have one of the following values: CommunicationUserIdentifier/PhoneNumberIdentifier/CallingApplication. |
7878
| RoomCallLocator | The RoomCallLocator is used by CallAgent to join a Room call|
7979

8080
## Create the Call Agent
81-
Replace the implementation of the ContentView struct with some simple UI controls that enable a user to initiate and end a call. We will attach business logic to these controls in this quickstart.
81+
Replace the implementation of the ContentView struct with some simple UI controls that enable a user to initiate and end a call. We'll attach business logic to these controls in this quickstart.
8282

8383
```Swift
8484
struct ContentView: View {
@@ -199,10 +199,10 @@ struct HomePageView_Previews: PreviewProvider {
199199
}
200200
```
201201

202-
### Authenticate the Client
203-
In order to initialize a CallAgent instance we need a User Access Token which will enable us to join Room calls.
202+
### Authenticate the client
203+
In order to initialize a CallAgent instance, we need a User Access Token which will enable us to join Room calls.
204204

205-
Once you have a token, Add the following code to the `onAppear` callback in `ContentView.swift`. You will need to replace `<USER ACCESS TOKEN>` with a valid user access token for your resource:
205+
Once you have a token, add the following code to the `onAppear` callback in `ContentView.swift`. You need to replace `<USER ACCESS TOKEN>` with a valid user access token for your resource:
206206

207207
```Swift
208208
var userCredential: CommunicationTokenCredential?
@@ -325,7 +325,7 @@ private func leaveRoomCall() {
325325
```
326326

327327
## Broadcasting video
328-
During a Room call we can use `startVideo` or `stopVideo` to start or stop sending `LocalVideoStream` to remote participants.
328+
During a Room call, we can use `startVideo` or `stopVideo` to start or stop sending `LocalVideoStream` to remote participants.
329329

330330
```Swift
331331
func toggleLocalVideo() {
@@ -422,7 +422,7 @@ self.callAgent!.delegate = callHandler
422422
```
423423

424424
## Remote participant management
425-
All remote participants are represented by the `RemoteParticipant` type and are available through the `remoteParticipants` collection on a call instance. We can implement a `Participant` class to manage the updates on remote video streams of remote participants amongst other things.
425+
All remote participants are represented by the `RemoteParticipant` type and are available through the `remoteParticipants` collection on a call instance. We can implement a `Participant` class to manage the updates on remote video streams of remote participants among other things.
426426

427427
```swift
428428
class Participant: NSObject, RemoteParticipantDelegate, ObservableObject {

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-java.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ You can review and download the sample code for this quick start on [GitHub](htt
2727

2828
### Create a new Java application
2929

30-
In a console window (such as cmd, PowerShell, or Bash), use the `mvn` command below to create a new console app with the name `rooms-quickstart`. This command creates a simple "Hello World" Java project with a single source file: **App.java**.
30+
In a console window (such as cmd, PowerShell, or Bash), use the `mvn` command to create a new console app with the name `rooms-quickstart`. This command creates a simple "Hello World" Java project with a single source file: **App.java**.
3131

3232
```console
3333
mvn archetype:generate -DgroupId=com.communication.quickstart -DartifactId=communication-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false
3434
```
3535

3636
### Include the package
3737

38-
You'll need to use the Azure Communication Rooms client library for Java [version 1.0.0](https://search.maven.org/artifact/com.azure/azure-communication-rooms/1.0.0/jar) or above.
38+
You need to use the Azure Communication Rooms client library for Java [version 1.1.0](https://search.maven.org/artifact/com.azure/azure-communication-rooms/1.1.0/jar) or above.
3939

4040
#### Include the BOM file
4141

@@ -123,7 +123,7 @@ RoomsClient roomsClient = new RoomsClientBuilder().connectionString(connectionSt
123123
## Create a room
124124

125125
### Set up room participants
126-
In order to set up who can join a room, you'll need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-java) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
126+
In order to set up who can join a room, you need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-java) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
127127

128128
To use `CommunicationIdentityClient`, add the following package:
129129

@@ -184,11 +184,9 @@ System.out.println("\nCreated a room with id: " + roomCreated.getRoomId());
184184

185185
```
186186

187-
*setPstnDialOutEnabled is currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
188-
189187
Since `rooms` are server-side entities, you may want to keep track of and persist the `roomId` in the storage medium of choice. You can reference the `roomId` to view or update the properties of a `room` object.
190188

191-
### Enable PSTN Dial Out Capability for a Room (Currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/))
189+
### Enable PSTN dial out capability for a room
192190
Each `room` has PSTN dial out disabled by default. The PSTN dial out can be enabled for a `room` at creation, by defining the `pstnDialOutEnabled` parameter as true. This capability may also be modified for a `room` by issuing an update request for the `pstnDialOutEnabled` parameter.
193191

194192
```java
@@ -360,7 +358,7 @@ mvn package
360358

361359
```
362360

363-
Execute the app
361+
Execute the app.
364362

365363
```console
366364
mvn exec:java -D"exec.mainClass"="com.communication.rooms.quickstart" -D"exec.cleanupDaemonThreads"="false"

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-javascript.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Create a new file `index.js` where the code for this quickstart will be added.
4242

4343
### Install the packages
4444

45-
You'll need to use the Azure Communication Rooms client library for JavaScript [version 1.0.0](https://www.npmjs.com/package/@azure/communication-rooms) or above.
45+
You need to use the Azure Communication Rooms client library for JavaScript [version 1.1.0](https://www.npmjs.com/package/@azure/communication-rooms) or above.
4646

4747
Use the `npm install` command to install the below Communication Services SDKs for JavaScript.
4848

@@ -52,7 +52,7 @@ npm install @azure/communication-rooms --save
5252

5353
### Set up the app framework
5454

55-
In the `index.js` file add the following code. We will be adding the code for the quickstart in the `main` function.
55+
In the `index.js` file, add the following code. We'll be adding the code for the quickstart in the `main` function.
5656

5757
``` javascript
5858
const { RoomsClient } = require('@azure/communication-rooms');
@@ -89,7 +89,7 @@ const roomsClient = new RoomsClient(connectionString);
8989

9090
### Set up room participants
9191

92-
In order to set up who can join a room, you'll need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-javascript) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
92+
In order to set up who can join a room, you need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-javascript) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
9393

9494
To use the CommunicationIdentityClient, install the following npm package:
9595

@@ -147,11 +147,10 @@ const createRoom = await roomsClient.createRoom(createRoomOptions);
147147
const roomId = createRoom.id;
148148
console.log("\nCreated a room with id: ", roomId);
149149
```
150-
*pstnDialOutEnabled is currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
151150

152151
Since `rooms` are server-side entities, you may want to keep track of and persist the `roomId` in the storage medium of choice. You can reference the `roomId` to view or update the properties of a `room` object.
153152

154-
### Enable PSTN Dial Out Capability for a Room (Currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/))
153+
### Enable PSTN dial out capability for a room
155154
Each `room` has PSTN dial out disabled by default. The PSTN dial out can be enabled for a `room` at creation, by defining the `pstnDialOutEnabled` parameter as true. This capability may also be modified for a `room` by issuing an update request for the `pstnDialOutEnabled` parameter.
156155

157156
```javascript

0 commit comments

Comments
 (0)