Add MoveParticipants Functionality API and Event Handling Support (#45653)

* Adding Move Participants Functionality

* Updating the revapi checks to check in to the feature branch

* Update sdk/communication/azure-communication-callautomation/pom.xml

---------

Co-authored-by: Wes Haggard <[email protected]>

Author: v-vkaluri

sdk/communication/azure-communication-callautomation/pom.xml

@@ -53,6 +53,7 @@
     <checkstyle.suppressionsLocation>checkstyle-suppressions.xml</checkstyle.suppressionsLocation>
     <spotbugs.skip>false</spotbugs.skip>
     <spotbugs.excludeFilterFile>spotbugs-exclude.xml</spotbugs.excludeFilterFile>
+    <revapi.skip>true</revapi.skip> <!--Disabling RevAPI checks for this feature branch as it currently compares against the GA version, which is not relevant for these changes. Note: Do not apply this flag to the main branch -->
   </properties>
 
   <dependencies>

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/CallAutomationEventParser.java

@@ -40,6 +40,8 @@
 import com.azure.communication.callautomation.models.events.MediaStreamingFailed;
 import com.azure.communication.callautomation.models.events.MediaStreamingStarted;
 import com.azure.communication.callautomation.models.events.MediaStreamingStopped;
+import com.azure.communication.callautomation.models.events.MoveParticipantFailed;
+import com.azure.communication.callautomation.models.events.MoveParticipantSucceeded;
 import com.azure.communication.callautomation.models.events.ParticipantsUpdated;
 import com.azure.communication.callautomation.models.events.PlayCanceled;
 import com.azure.communication.callautomation.models.events.PlayCompleted;
@@ -161,6 +163,10 @@ private static CallAutomationEventBase parseSingleCloudEvent(String data, String
                 ret = RemoveParticipantFailed.fromJson(jsonReader);
             } else if (Objects.equals(eventType, "Microsoft.Communication.RemoveParticipantSucceeded")) {
                 ret = RemoveParticipantSucceeded.fromJson(jsonReader);
+            } else if (Objects.equals(eventType, "Microsoft.Communication.MoveParticipantFailed")) {
+                ret = MoveParticipantFailed.fromJson(jsonReader);
+            } else if (Objects.equals(eventType, "Microsoft.Communication.MoveParticipantSucceeded")) {
+                ret = MoveParticipantSucceeded.fromJson(jsonReader);
             } else if (Objects.equals(eventType, "Microsoft.Communication.ContinuousDtmfRecognitionToneReceived")) {
                 ret = ContinuousDtmfRecognitionToneReceived.fromJson(jsonReader);
             } else if (Objects.equals(eventType, "Microsoft.Communication.ContinuousDtmfRecognitionToneFailed")) {

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/CallConnection.java

@@ -10,6 +10,8 @@
 import com.azure.communication.callautomation.models.AddParticipantResult;
 import com.azure.communication.callautomation.models.CallConnectionProperties;
 import com.azure.communication.callautomation.models.CallInvite;
+import com.azure.communication.callautomation.models.MoveParticipantsOptions;
+import com.azure.communication.callautomation.models.MoveParticipantsResult;
 import com.azure.communication.callautomation.models.MuteParticipantOptions;
 import com.azure.communication.callautomation.models.MuteParticipantResult;
 import com.azure.communication.callautomation.models.RemoveParticipantOptions;
@@ -25,6 +27,7 @@
 import com.azure.core.http.rest.Response;
 import com.azure.core.util.Context;
 import com.azure.core.exception.HttpResponseException;
+import java.util.List;
 
 /**
  * CallConnection for mid-call actions
@@ -226,6 +229,48 @@ public RemoveParticipantResult removeParticipant(CommunicationIdentifier partici
         return callConnectionAsync.removeParticipantWithResponseInternal(removeParticipantOptions, context).block();
     }
 
+    /**
+     * Move participants from one call to another.
+     *
+     * @param targetParticipants participants to move.
+     * @param fromCall The CallConnectionId for the call you want to move the participant from.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+     * @return Result of moving participants to the call.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public MoveParticipantsResult moveParticipants(List<CommunicationIdentifier> targetParticipants, String fromCall) {
+        return callConnectionAsync.moveParticipants(targetParticipants, fromCall).block();
+    }
+
+    /**
+     * Move participants from one call to another.
+     *
+     * @param moveParticipantsOptions Options bag for moveParticipants
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+     * @return Result of moving participants to the call.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public MoveParticipantsResult moveParticipants(MoveParticipantsOptions moveParticipantsOptions) {
+        return callConnectionAsync.moveParticipants(moveParticipantsOptions).block();
+    }
+
+    /**
+     * Move participants from one call to another.
+     *
+     * @param moveParticipantsOptions Options bag for moveParticipants
+     * @param context A {@link Context} representing the request context.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+     * @return Response with result of moving participants to the call.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Response<MoveParticipantsResult>
+        moveParticipantsWithResponse(MoveParticipantsOptions moveParticipantsOptions, Context context) {
+        return callConnectionAsync.moveParticipantsWithResponseInternal(moveParticipantsOptions, context).block();
+    }
+
     /**
      * Mutes a participant in the call.
      *

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/CallConnectionAsync.java

@@ -9,6 +9,7 @@
 import com.azure.communication.callautomation.implementation.accesshelpers.AddParticipantResponseConstructorProxy;
 import com.azure.communication.callautomation.implementation.accesshelpers.CallConnectionPropertiesConstructorProxy;
 import com.azure.communication.callautomation.implementation.accesshelpers.CancelAddParticipantResponseConstructorProxy;
+import com.azure.communication.callautomation.implementation.accesshelpers.MoveParticipantsResponseConstructorProxy;
 import com.azure.communication.callautomation.implementation.accesshelpers.MuteParticipantsResponseConstructorProxy;
 import com.azure.communication.callautomation.implementation.accesshelpers.RemoveParticipantResponseConstructorProxy;
 import com.azure.communication.callautomation.implementation.accesshelpers.TransferCallResponseConstructorProxy;
@@ -19,6 +20,7 @@
 import com.azure.communication.callautomation.implementation.models.AddParticipantRequestInternal;
 import com.azure.communication.callautomation.implementation.models.CancelAddParticipantRequest;
 import com.azure.communication.callautomation.implementation.models.CustomCallingContext;
+import com.azure.communication.callautomation.implementation.models.MoveParticipantsRequest;
 import com.azure.communication.callautomation.implementation.models.MuteParticipantsRequestInternal;
 import com.azure.communication.callautomation.implementation.models.RemoveParticipantRequestInternal;
 import com.azure.communication.callautomation.implementation.models.TransferToParticipantRequestInternal;
@@ -30,6 +32,8 @@
 import com.azure.communication.callautomation.models.CallParticipant;
 import com.azure.communication.callautomation.models.CancelAddParticipantOperationOptions;
 import com.azure.communication.callautomation.models.CancelAddParticipantOperationResult;
+import com.azure.communication.callautomation.models.MoveParticipantsOptions;
+import com.azure.communication.callautomation.models.MoveParticipantsResult;
 import com.azure.communication.callautomation.models.MuteParticipantOptions;
 import com.azure.communication.callautomation.models.MuteParticipantResult;
 import com.azure.communication.callautomation.models.RemoveParticipantOptions;
@@ -59,6 +63,8 @@
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
 import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
 
 import static com.azure.core.util.FluxUtil.monoError;
 import static com.azure.core.util.FluxUtil.withContext;
@@ -441,6 +447,74 @@ public Mono<RemoveParticipantResult> removeParticipant(CommunicationIdentifier p
         }
     }
 
+    /**
+     * Move participants from one call to another.
+     *
+     * @param targetParticipants participants to move.
+     * @param fromCall The CallConnectionId for the call you want to move the participant from.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+     * @return Result of moving participants to the call.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Mono<MoveParticipantsResult> moveParticipants(List<CommunicationIdentifier> targetParticipants,
+        String fromCall) {
+        return moveParticipants(new MoveParticipantsOptions(targetParticipants, fromCall));
+    }
+
+    /**
+     * Move participants from one call to another.
+     *
+     * @param moveParticipantsOptions Options bag for moveParticipants
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+     * @return Result of moving participants to the call.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Mono<MoveParticipantsResult> moveParticipants(MoveParticipantsOptions moveParticipantsOptions) {
+        return moveParticipantsWithResponse(moveParticipantsOptions).flatMap(FluxUtil::toMono);
+    }
+
+    /**
+     * Move participants from one call to another.
+     *
+     * @param moveParticipantsOptions Options bag for moveParticipants
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+     * @return Response with result of moving participants to the call.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Mono<Response<MoveParticipantsResult>>
+        moveParticipantsWithResponse(MoveParticipantsOptions moveParticipantsOptions) {
+        return withContext(context -> moveParticipantsWithResponseInternal(moveParticipantsOptions, context));
+    }
+
+    Mono<Response<MoveParticipantsResult>>
+        moveParticipantsWithResponseInternal(MoveParticipantsOptions moveParticipantsOptions, Context context) {
+        try {
+            context = context == null ? Context.NONE : context;
+
+            MoveParticipantsRequest request = new MoveParticipantsRequest()
+                .setTargetParticipants(moveParticipantsOptions.getTargetParticipants()
+                    .stream()
+                    .map(CommunicationIdentifierConverter::convert)
+                    .collect(Collectors.toList()))
+                .setFromCall(moveParticipantsOptions.getFromCall())
+                .setOperationContext(moveParticipantsOptions.getOperationContext())
+                .setOperationCallbackUri(moveParticipantsOptions.getOperationCallbackUrl());
+
+            return callConnectionInternal.moveParticipantsWithResponseAsync(callConnectionId, request, context)
+                .map(response -> {
+                    MoveParticipantsResult result
+                        = MoveParticipantsResponseConstructorProxy.create(response.getValue());
+                    result.setEventProcessor(eventProcessor, callConnectionId, result.getOperationContext());
+                    return new SimpleResponse<>(response, result);
+                });
+        } catch (RuntimeException ex) {
+            return monoError(logger, ex);
+        }
+    }
+
     /**
      * Mutes a participant in the call.
      *

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/implementation/accesshelpers/MoveParticipantsResponseConstructorProxy.java

@@ -0,0 +1,60 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.communication.callautomation.implementation.accesshelpers;
+
+import com.azure.communication.callautomation.implementation.models.MoveParticipantsResponse;
+import com.azure.communication.callautomation.models.MoveParticipantsResult;
+
+/**
+ * Helper class to access private values of {@link MoveParticipantsResult} across package boundaries.
+ */
+public final class MoveParticipantsResponseConstructorProxy {
+    private static MoveParticipantsResponseConstructorAccessor accessor;
+
+    private MoveParticipantsResponseConstructorProxy() {
+    }
+
+    /**
+     * Type defining the methods to set the non-public properties of a {@link MoveParticipantsResponseConstructorAccessor}
+     * instance.
+     */
+    public interface MoveParticipantsResponseConstructorAccessor {
+        /**
+         * Creates a new instance of {@link MoveParticipantsResult} backed by an internal instance of
+         * {@link MoveParticipantsResult}.
+         *
+         * @param internalResponse The internal response.
+         * @return A new instance of {@link MoveParticipantsResult}.
+         */
+        MoveParticipantsResult create(MoveParticipantsResponse internalResponse);
+    }
+
+    /**
+     * The method called from {@link MoveParticipantsResult} to set it's accessor.
+     *
+     * @param accessor The accessor.
+     */
+    public static void setAccessor(final MoveParticipantsResponseConstructorAccessor accessor) {
+        MoveParticipantsResponseConstructorProxy.accessor = accessor;
+    }
+
+    /**
+     * Creates a new instance of {@link MoveParticipantsResult} backed by an internal instance of
+     * {@link MoveParticipantsResult}.
+     *
+     * @param internalResponse The internal response.
+     * @return A new instance of {@link MoveParticipantsResult}.
+     */
+    public static MoveParticipantsResult create(MoveParticipantsResponse internalResponse) {
+        // This looks odd but is necessary, it is possible to engage the access helper before anywhere else in the
+        // application accesses MoveParticipantsResult which triggers the accessor to be configured. So, if the accessor
+        // is null this effectively pokes the class to set up the accessor.
+        if (accessor == null) {
+            new MoveParticipantsResult();
+        }
+
+        assert accessor != null;
+        return accessor.create(internalResponse);
+    }
+}

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/models/MoveParticipantEventResult.java

@@ -0,0 +1,84 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.communication.callautomation.models;
+
+import com.azure.communication.callautomation.models.events.MoveParticipantFailed;
+import com.azure.communication.callautomation.models.events.MoveParticipantSucceeded;
+import com.azure.communication.common.CommunicationIdentifier;
+import com.azure.core.annotation.Immutable;
+
+/**
+ * The result of a move participant event.
+ */
+@Immutable
+public final class MoveParticipantEventResult {
+    private final boolean isSuccess;
+    private final MoveParticipantSucceeded successResult;
+    private final MoveParticipantFailed failureResult;
+    private final CommunicationIdentifier participant;
+    private final String fromCall;
+
+    /**
+     * Initializes a new instance of MoveParticipantEventResult.
+     *
+     * @param isSuccess the success status of the move participant operation.
+     * @param successResult the move participant succeeded event.
+     * @param failureResult the move participant failed event.
+     * @param participant the participant.
+     * @param fromCall the call connection id for the call to move the participant from.
+     */
+    MoveParticipantEventResult(boolean isSuccess, MoveParticipantSucceeded successResult,
+        MoveParticipantFailed failureResult, CommunicationIdentifier participant, String fromCall) {
+        this.isSuccess = isSuccess;
+        this.successResult = successResult;
+        this.failureResult = failureResult;
+        this.participant = participant;
+        this.fromCall = fromCall;
+    }
+
+    /**
+     * Gets the success status of the move participant operation.
+     *
+     * @return the success status of the move participant operation.
+     */
+    public boolean isSuccess() {
+        return isSuccess;
+    }
+
+    /**
+     * Gets the move participant succeeded event.
+     *
+     * @return the move participant succeeded event.
+     */
+    public MoveParticipantSucceeded getSuccessResult() {
+        return successResult;
+    }
+
+    /**
+     * Gets the move participant failed event.
+     *
+     * @return the move participant failed event.
+     */
+    public MoveParticipantFailed getFailureResult() {
+        return failureResult;
+    }
+
+    /**
+     * Gets the participant.
+     *
+     * @return the participant.
+     */
+    public CommunicationIdentifier getParticipant() {
+        return participant;
+    }
+
+    /**
+     * Gets the call connection id for the call to move the participant from.
+     *
+     * @return the from call connection id.
+     */
+    public String getFromCall() {
+        return fromCall;
+    }
+}