Skip to content

Commit 2fb40b4

Browse files
rzdorrzdor
committed
doc reivew
1 parent 1c9d22a commit 2fb40b4

File tree

6 files changed

+87
-90
lines changed

6 files changed

+87
-90
lines changed

‎articles/communication-services/how-tos/calling-sdk/includes/raise-hand/raise-hand-android.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@ ms.author: ruslanzdor
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-android.md)]
99

10-
> [!NOTE]
11-
> Raise Hand API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. To use this api please use 'beta' release of Azure Communication Services Calling Web SDK
12-
13-
Raise Hand is an extended feature of the core `Call` API. You first need to import calling Features from the Calling SDK:
10+
The Raise Hand feature allows participants in a call to indicate that they have a question, comment, or concern without interrupting the speaker or other participants. This feature can be used in any call type, including 1:1 calls and calls with many participants, in Azure Communication Service and in Teams calls.
11+
You first need to import calling Features from the Calling SDK:
1412

1513
```java
1614
import com.azure.android.communication.calling.RaiseHandFeature;
@@ -23,9 +21,8 @@ RaiseHandFeature raiseHandFeature = call.feature(Features.RAISE_HAND);
2321
```
2422

2523
### Raise and lower hand for current participant:
26-
Raise Hand state can be used in any call type: on 1:1 calls and on calls with many participants, in ACS and in Teams calls.
27-
If it Teams meeting - organizer will have ability to enable or disable raise hand states for all participants.
28-
To change state for current participant, you can use methods:
24+
To change the Raise Hand state for the current participant, you can use the `raiseHand()` and `lowerHand()` methods.
25+
This is async methods, to verify results can be used `RaisedHandReceived` and `LoweredHandReceived` listeners.
2926
```java
3027
RaiseHandFeature raiseHandFeature = call.feature(Features.RAISE_HAND);
3128
//raise
@@ -35,7 +32,9 @@ raiseHandFeature.lowerHand();
3532
```
3633

3734
### Lower hands for other participants
38-
Currently ACS calls aren't allowed to change state of other participants, for example, lower all hands. But Teams calls allow it using these methods:
35+
This feature allows users with the Organizer and Presenter roles to lower all hands for other participants on Teams calls. In Azure Communication calls, changing the state of other participants is not allowed unless roles have been added.
36+
37+
To use this feature, you can use the following code:
3938
```java
4039
RaiseHandFeature raiseHandFeature = call.feature(Features.RAISE_HAND);
4140
//lower all hands on the call
@@ -50,7 +49,9 @@ raiseHandFeature.lowerHands(identifiers);
5049
```
5150

5251
### Handle changed states
53-
The `Raise Hand` API allows you to subscribe to `raiseHandChanged` or `loweredHandChanged` events. Event comes from a `call` instance and contain information about participant and new state.
52+
With the Raise Hand API, you can subscribe to the `RaisedHandReceived` and `LoweredHandReceived` events to handle changes in the state of participants on a call. These events are triggered by a call instance and provide information about the participant whose state has changed.
53+
54+
To subscribe to these events, you can use the following code:
5455
```java
5556
RaiseHandFeature raiseHandFeature = call.feature(Features.RAISE_HAND)
5657

@@ -59,22 +60,21 @@ call.feature(Features.RAISE_HAND).addOnRaisedHandReceivedListener(raiseHandEvent
5960
Log.i(TAG, String.format("Raise Hand: %s : %s", Utilities.toMRI(raiseHandEvent.getIdentifier()), raiseHandEvent.isRaised()));
6061
});
6162
```
63+
The `RaisedHandReceived` and `LoweredHandReceived` events contain an object with the `identifier` property, which represents the participant's communication identifier. In the example above, we log a message to the console indicating that a participant has raised their hand.
64+
65+
To unsubscribe from the events, you can use the `off` method.
66+
6267

6368
### List of all participants with active state
64-
To get information about all participants that have Raise Hand state on current call, you can use this api array is sorted by order field:
69+
To get information about all participants that have raised hand state on current call, you can use the `getRaisedHands` api. he returned array is sorted by the order field.
70+
Here's an example of how to use the `getRaisedHands` API:
6571
```java
6672
RaiseHandFeature raiseHandFeature = call.feature(Features.RAISE_HAND);
67-
List<RaiseHand> activeStates = raiseHandFeature.getRaisedHands();
73+
List<RaiseHand> participantsWithRaisedHands = raiseHandFeature.getRaisedHands();
6874
```
6975

7076
### Order of raised Hands
71-
It possible to get order of all raised hand states on the call, this order is started from 1.
72-
In event subscription when any participant will lower a hand - call will generate only one event, but not for all participants with order above.
73-
74-
```java
75-
const raiseHandFeature = call.feature(Features.RaiseHand );
76-
for (RaiseHand state : raiseHandFeature.getRaisedHands() {
77-
CommunicationIdentifier identifier = state.getIdentifier();
78-
int order = state.getOrder();
79-
}
80-
```
77+
The `participantsWithRaisedHands` variable will contain an array of participant objects, where each object has the following properties:
78+
`identifier`: the communication identifier of the participant
79+
`order`: the order in which the participant raised their hand
80+
You can use this information to display a list of participants with the Raise Hand state and their order in the queue.```

‎articles/communication-services/how-tos/calling-sdk/includes/raise-hand/raise-hand-ios.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@ ms.author: ruslanzdor
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-ios.md)]
99

10-
> [!NOTE]
11-
> Raise Hand API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. To use this api please use 'beta' release of Azure Communication Services Calling Web SDK
12-
13-
Raise Hand is an extended feature of the core `Call` API. You first need to import calling Features from the Calling SDK:
10+
The Raise Hand feature allows participants in a call to indicate that they have a question, comment, or concern without interrupting the speaker or other participants. This feature can be used in any call type, including 1:1 calls and calls with many participants, in Azure Communication Service and in Teams calls.
11+
You first need to import calling Features from the Calling SDK:
1412

1513
```swift
1614
import AzureCommunicationCalling
@@ -25,9 +23,7 @@ raiseHandFeature = self.call!.feature(Features.raiseHand)
2523
```
2624

2725
### Raise and lower hand for current participant:
28-
Raise Hand state can be used in any call type: on 1:1 calls and on calls with many participants, in ACS and in Teams calls.
29-
If it Teams meeting - organizer will have ability to enable or disable raise hand states for all participants.
30-
To change state for current participant, you can use methods:
26+
To change the Raise Hand state for the current participant, you can use the `raiseHand()` and `lowerHand()` methods.
3127
```swift
3228
//publish raise hand state for local participant
3329
raisehandFeature.raiseHand(completionHandler: { (error) in
@@ -46,7 +42,9 @@ raisehandFeature.lowerHand(completionHandler: { (error) in
4642
```
4743

4844
### Lower hands for other participants
49-
Currently ACS calls aren't allowed to change state of other participants, for example, lower all hands. But Teams calls allow it using these methods:
45+
This feature allows users with the Organizer and Presenter roles to lower all hands for other participants on Teams calls. In Azure Communication calls, changing the state of other participants is not allowed unless roles have been added.
46+
47+
To use this feature, you can use the following code:
5048
```swift
5149

5250
// remove raise hand states for all participants on the call
@@ -76,7 +74,9 @@ raisehandFeature.lowerHands(participants: identifiers, completionHandler: { (err
7674
```
7775

7876
### Handle changed states
79-
The `Raise Hand` API allows you to subscribe to `didReceiveRaisedHand` and `didReceiveLoweredHand` events. Event comes from a `call` instance and contain information about participant and new state.
77+
With the Raise Hand API, you can subscribe to the `RaisedHandReceived` and `LoweredHandReceived` events to handle changes in the state of participants on a call. These events are triggered by a call instance and provide information about the participant whose state has changed.
78+
79+
To subscribe to these events, you can use the following code:
8080
```swift
8181
self.callObserver = CallObserver(view:self)
8282

@@ -100,9 +100,14 @@ public class CallObserver : NSObject, RaiseHandCallFeatureDelegate
100100
}
101101
}
102102
```
103+
The `RaisedHandReceived` and `LoweredHandReceived` events contain an object with the `identifier` property, which represents the participant's communication identifier. In the example above, we log a message to the console indicating that a participant has raised their hand.
104+
105+
To unsubscribe from the events, you can use the `off` method.
106+
103107

104108
### List of all participants with active state
105-
To get information about all participants that have Raise Hand state on current call, you can use this api array is sorted by order field:
109+
To get information about all participants that have raised hand state on current call, you can use the `getRaisedHands` api. he returned array is sorted by the order field.
110+
Here's an example of how to use the `raisedHands` API:
106111
```swift
107112
raisehandFeature = self.call!.feature(Features.raiseHand)
108113
raisehandFeature.raisedHands.forEach { raiseHand in
@@ -111,13 +116,7 @@ raisehandFeature.raisedHands.forEach { raiseHand in
111116
```
112117

113118
### Order of raised Hands
114-
It possible to get order of all raised hand states on the call, order is started from 1 and will be sorted.
115-
There are two ways: get all raise hand state on the call or use `didReceiveRaisedHand` event subscription.
116-
In event subscription when any participant will lower a hand - call will generate only one event, but not for all participants with order above.
117-
118-
```swift
119-
raisehandFeature = self.call!.feature(Features.raiseHand)
120-
raisehandFeature.raisedHands.forEach { raiseHand in
121-
os_log("Raise hand active: %s with order %d", log:log, Utilities.toMri(raiseHand.identifier), raiseHand.order)
122-
}
123-
```
119+
The `raisedHands` variable will contain an array of participant objects, where each object has the following properties:
120+
`identifier`: the communication identifier of the participant
121+
`order`: the order in which the participant raised their hand
122+
You can use this information to display a list of participants with the Raise Hand state and their order in the queue.```

‎articles/communication-services/how-tos/calling-sdk/includes/raise-hand/raise-hand-web.md

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@ ms.author: rifox
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-web.md)]
99

10-
> [!NOTE]
11-
> Raise Hand API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. To use this api please use 'alpha' release of Azure Communication Services Calling Web SDK
12-
13-
Raise Hand is an extended feature of the core `Call` API. You first need to import calling Features from the Calling SDK:
10+
The Raise Hand feature allows participants in a call to indicate that they have a question, comment, or concern without interrupting the speaker or other participants. This feature can be used in any call type, including 1:1 calls and calls with many participants, in Azure Communication Service and in Teams calls.
11+
You first need to import calling Features from the Calling SDK:
1412

1513
```js
1614
import { Features} from "@azure/communication-calling";
@@ -23,9 +21,8 @@ const raiseHandFeature = call.feature(Features.RaiseHand );
2321
```
2422

2523
### Raise and lower hand for current participant:
26-
Raise Hand state can be used in any call type: on 1:1 calls and on calls with many participants, in ACS and in Teams calls.
27-
If it Teams meeting - organizer will have ability to enable or disable raise hand states for all participants.
28-
To change state for current participant, you can use methods:
24+
To change the Raise Hand state for the current participant, you can use the `raiseHand()` and `lowerHand()` methods.
25+
This is async methods, to verify results can be used `raisedHandChanged` and `loweredHandChanged` listeners.
2926
```js
3027
const raiseHandFeature = call.feature(Features.RaiseHand );
3128
//raise
@@ -35,7 +32,9 @@ raiseHandFeature.lowerHand();
3532
```
3633

3734
### Lower hands for other participants
38-
Currently ACS calls aren't allowed to change state of other participants, for example, lower all hands. But Teams calls allow it using these methods:
35+
This feature allows users with the Organizer and Presenter roles to lower all hands for other participants on Teams calls. In Azure Communication calls, changing the state of other participants is not allowed unless roles have been added.
36+
37+
To use this feature, you can use the following code:
3938
```js
4039
const raiseHandFeature = call.feature(Features.RaiseHand );
4140
//lower all hands on the call
@@ -48,7 +47,9 @@ raiseHandFeature.lowerHands(participants);
4847
```
4948

5049
### Handle changed states
51-
The `Raise Hand` API allows you to subscribe to `raisedHandEvent` or `loweredHandEvent` events. Events comes from a `call` instance and contain information about participant.
50+
With the Raise Hand API, you can subscribe to the `raisedHandChanged` and `loweredHandChanged` events to handle changes in the state of participants on a call. These events are triggered by a call instance and provide information about the participant whose state has changed.
51+
52+
To subscribe to these events, you can use the following code:
5253
```js
5354
const raiseHandFeature = call.feature(Features.RaiseHand );
5455

@@ -59,30 +60,23 @@ const raisedHandChangedHandler = (event) => {
5960
const loweredHandChangedHandler = (event) => {
6061
console.log(`Participant ${event.identifier} lowered hand`);
6162
};
62-
raiseHandFeature.feature(SDK.Features.RaiseHand).on('raisedHandEvent', raisedHandChangedHandler):
63-
raiseHandFeature.feature(SDK.Features.RaiseHand).on('loweredHandEvent', loweredHandChangedHandler):
63+
raiseHandFeature.on('raisedHandChanged', raisedHandChangedHandler):
64+
raiseHandFeature.on('loweredHandChanged', loweredHandChangedHandler):
6465
```
66+
The `raisedHandChanged` and `loweredHandChanged` events contain an object with the `identifier` property, which represents the participant's communication identifier. In the example above, we log a message to the console indicating that a participant has raised their hand.
67+
68+
To unsubscribe from the events, you can use the `off` method.
6569

6670
### List of all participants with active state
67-
To get information about all participants that have Raise Hand state on current call, you can use this api array is sorted by order field:
71+
To get information about all participants that have raised hand state on current call, you can use the `getRaisedHands` api. he returned array is sorted by the order field.
72+
Here's an example of how to use the `getRaisedHands` API:
6873
```js
6974
const raiseHandFeature = call.feature(Features.RaiseHand );
70-
let activeStates = raiseHandFeature.getRaisedHands();
75+
let participantsWithRaisedHands = raiseHandFeature.getRaisedHands();
7176
```
7277

7378
### Order of raised Hands
74-
It possible to get order of all raised hand states on the call, this order is started from 1.
75-
In event subscription when any participant will lower a hand - call will generate only one event, but not for all participants with order above.
76-
77-
```js
78-
const raiseHandFeature = call.feature(Features.RaiseHand );
79-
80-
// event : {identifier: CommunicationIdentifier, isRaised: true, order:1}
81-
const raiseHandChangedHandler = (event) => {
82-
console.log(`List of participants with raised hand`);
83-
for (let state : raiseHandFeature.getRaisedHands()) {
84-
console.log(`Participant ${state.identifier} has order ${state.order}`);
85-
}
86-
};
87-
raiseHandFeature.feature(SDK.Features.RaiseHand).on('raisedHandEvent', raiseHandChangedHandler):
88-
```
79+
The `participantsWithRaisedHands` variable will contain an array of participant objects, where each object has the following properties:
80+
`identifier`: the communication identifier of the participant
81+
`order`: the order in which the participant raised their hand
82+
You can use this information to display a list of participants with the Raise Hand state and their order in the queue.

0 commit comments

Comments
 (0)