Skip to content

Commit 0c40100

Browse files
Merge pull request #284912 from mikehang-msft/mhang/AddCommunicationUserIdentityToRoomQuickStart
Added a note to indicate Rooms support CommunicationUserIdentity only
2 parents 7a4d2af + 2985a37 commit 0c40100

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The following table lists the main properties of `room` objects:
2727
| `validFrom` | Earliest time a `room` can be used. |
2828
| `validUntil` | Latest time a `room` can be used. |
2929
| `pstnDialOutEnabled` | Enable or disable dialing out to a PSTN number in a room.|
30-
| `participants` | List of participants to a `room`. Specified as a `CommunicationIdentifier`. |
30+
| `participants` | List of participants to a `room`. Specified as a `CommunicationUserIdentifier`. |
3131
| `roleType` | The role of a room participant. Can be either `Presenter`, `Attendee`, or `Consumer`. |
3232

3333
::: zone pivot="platform-azcli"

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 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`. ACS Rooms currently supports a room participant of type CommunicationUserIdentifier only, using other types of CommunicationIdentity will result in a runtime error.
127127

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 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`. ACS Rooms currently supports a room participant of type CommunicationUserIdentifier only, using other types of CommunicationIdentity will result in a runtime error.
9393

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ RoomsClient roomsClient = new RoomsClient(connectionString);
9191

9292
### Set up room participants
9393

94-
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-csharp) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
94+
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-csharp) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`. ACS Rooms currently supports a room participant of type CommunicationUserIdentifier only, using other types of CommunicationIdentity will result in a runtime error.
9595

9696
To use the `CommunicationIdentityClient`, install the following package:
9797

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ rooms_client = RoomsClient.from_connection_string(connection_string)
7979
## Create a room
8080

8181
### Set up room participants
82-
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-python) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
82+
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-python) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`. ACS Rooms currently supports a room participant of type CommunicationUserIdentifier only, using other types of CommunicationIdentity will result in a runtime error.
8383

8484
To use the `CommunicationIdentityClient`, install the following package:
8585

articles/communication-services/quickstarts/rooms/manage-rooms-call.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ call_connection_properties = client.connect_call(call_locator=room_call_locator,
6767
Once successfully connected to a room call, a `CallConnect` event is notified via Callback URI. You can use `callConnectionId` to retrieve a call connection on the room call as needed. The following sample code snippets use the `callConnectionId` to demonstrate this function.
6868

6969

70-
### Add PSTN Participant
70+
### Add PSTN participant
7171
Using Call Automation you can dial out to a PSTN number and add the participant into a room call. You must, however, set up a room to enable PSTN dial-out option (`EnabledPSTNDialout` set to `true`) and the Azure Communication Services resource must have a valid phone number provisioned.
7272

7373
For more information, see [Rooms quickstart](../../quickstarts//rooms/get-started-rooms.md?tabs=windows&pivots=platform-azcli#enable-pstn-dial-out-capability-for-a-room).
@@ -120,7 +120,7 @@ result = call_connection_client.add_participant(
120120
```
121121
-----
122122

123-
### Remove PSTN Participant
123+
### Remove PSTN participant
124124

125125
### [csharp](#tab/csharp)
126126

@@ -218,7 +218,7 @@ result = call_connection_client.send_dtmf_tones(
218218
```
219219
-----
220220

221-
### Call Recording
221+
### Call recording
222222
Azure Communication Services rooms support recording capabilities including `start`, `stop`, `pause`, `resume`, and so on, provided by Call Automation. See the following code snippets to start/stop/pause/resume a recording in a room call. For a complete list of actions, see [Call Automation recording](../../concepts/voice-video-calling/call-recording.md#get-full-control-over-your-recordings-with-our-call-recording-apis).
223223

224224
### [csharp](#tab/csharp)
@@ -315,7 +315,7 @@ stop_recording = call_automation_client.stop_recording(recording_id = recording_
315315
```
316316
-----
317317

318-
### Terminate a Call
318+
### Terminate a call
319319
You can use the Call Automation SDK Hang Up action to terminate a call. When the Hang Up action completes, the SDK publishes a `CallDisconnected` event.
320320

321321
### [csharp](#tab/csharp)
@@ -347,7 +347,7 @@ call_connection_client.hang_up(is_for_everyone=True)
347347
```
348348
-----
349349

350-
## Other Actions
350+
## Other actions
351351
The following in-call actions are also supported in a room call.
352352
1. Add participant (ACS identifier)
353353
1. Remove participant (ACS identifier)

0 commit comments

Comments
 (0)