@azure/communication-react 1.11.0-alpha-202312130012 → 1.11.0-alpha-202312150013

package/dist/communication-react.d.ts

@@ -32,6 +32,8 @@ import { CallEndReason } from '@azure/communication-calling';
 import { CallerInfo } from '@azure/communication-calling';
 import { CallKind } from '@azure/communication-calling';
 import { CallState as CallState_2 } from '@azure/communication-calling';
+import { CallSurvey } from '@azure/communication-calling';
+import { CallSurveyResponse } from '@azure/communication-calling';
 import { CapabilitiesChangeInfo } from '@azure/communication-calling';
 import { CaptionsResultType } from '@azure/communication-calling';
 import { ChatClient } from '@azure/communication-chat';
@@ -877,6 +879,12 @@ export declare interface CallAdapterCallOperations {
      * @public
      */
     updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
+    /**
+     * Send the end of call survey result
+     *
+     * @beta
+     */
+    submitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
 }
 
 /**
@@ -1534,6 +1542,38 @@ export declare type CallCompositeOptions = {
          */
         layout?: VideoGalleryLayout;
     };
+    /**
+     * Options for end of call survey
+     */
+    surveyOptions?: {
+        /**
+         * Hide call survey at the end of a call.
+         * @defaultValue false
+         */
+        hideSurvey?: boolean;
+        /**
+         * Optional callback to handle survey data including free form text response
+         * Note that free form text response survey option is only going to be enabled when this callback is provided
+         * User will need to handle all free form text response on their own
+         */
+        onSurveySubmitted?: (callId: string, surveyId: string, 
+        /**
+         * This is the survey results containing star survey data and API tag survey data.
+         * This part of the result will always be send to calling sdk
+         * This callback provides user with the ability to gain access to survey data
+         */
+        submittedSurvey: CallSurvey, 
+        /**
+         * This is the survey results containing free form text
+         * This part of the result will not be handled by composites
+         * User will need to collect and handle this information 100% on their own
+         * Free form text survey is not going to show in the UI if onSurveySubmitted is not populated
+         */
+        improvementSuggestions: {
+            category: 'audio' | 'video' | 'screenshare';
+            suggestion: string;
+        }[]) => Promise<void>;
+    };
     /**
      * Options for setting additional customizations related to personalized branding.
      */
@@ -2186,6 +2226,66 @@ export declare interface CallCompositeStrings {
      * All strings for capability changed notification
      */
     capabilityChangedNotification?: CapabilityChangedNotificationStrings;
+    /**
+     * Question for the survey
+     */
+    surveyQuestion: string;
+    /**
+     * Helper text to explain what the survey is for
+     */
+    starSurveyHelperText: string;
+    /**
+     * Helper text displayed below survey question after user select one star
+     */
+    starSurveyOneStarText: string;
+    /**
+     * Helper text displayed below survey question after user select two star
+     */
+    starSurveyTwoStarText: string;
+    /**
+     * Helper text displayed below survey question after user select three star
+     */
+    starSurveyThreeStarText: string;
+    /**
+     * Helper text displayed below survey question after user select four star
+     */
+    starSurveyFourStarText: string;
+    /**
+     * Helper text displayed below survey question after user select five star
+     */
+    starSurveyFiveStarText: string;
+    /**
+     * Aria Label for each individual star rating
+     */
+    starRatingAriaLabel: string;
+    /**
+     * Tags Survey Question
+     */
+    tagsSurveyQuestion: string;
+    /**
+     * Tags Survey helper text
+     */
+    tagsSurveyHelperText: string;
+    /**
+     * Confirm button label for survey
+     */
+    surveyConfirmButtonLabel: string;
+    /**
+     * Aria Label for cancel button
+     */
+    surveyCancelButtonAriaLabel: string;
+    /**
+     * Default text for free form text box
+     */
+    surveyTextboxDefaultText: string;
+    /**
+     * Corresponding texts to each call issue
+     */
+    surveyIssues: SurveyIssues;
+    /**
+     * Corresponding texts to each call category
+     */
+    SurveyIssuesHeadingStrings: SurveyIssuesHeadingStrings;
     /**
      * String for the dismiss control on the local and remote PIP on mobile
      */
@@ -2926,6 +3026,12 @@ export declare interface CallWithChatAdapterManagement {
      * @public
      */
     updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
+    /**
+     * Send the end of call survey result
+     *
+     * @beta
+     */
+    submitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
 }
 
 /**
@@ -3231,6 +3337,38 @@ export declare type CallWithChatCompositeOptions = {
          */
         layout?: VideoGalleryLayout;
     };
+    /**
+     * Options for end of call survey
+     */
+    surveyOptions?: {
+        /**
+         * Hide call survey at the end of a call.
+         * @defaultValue false
+         */
+        hideSurvey?: boolean;
+        /**
+         * Optional callback to handle survey data including free form text response
+         * Note that free form text response survey option is only going to be enabled when this callback is provided
+         * User will need to handle all free form text response on their own
+         */
+        onSurveySubmitted?: (callId: string, surveyId: string, 
+        /**
+         * This is the survey results containing star survey data and API tag survey data.
+         * This part of the result will always be send to calling sdk
+         * This callback provides user with the ability to gain access to survey data
+         */
+        submittedSurvey: CallSurvey, 
+        /**
+         * This is the survey results containing free form text
+         * This part of the result will not be handled by composites
+         * User will need to collect and handle this information 100% on their own
+         * Free form text survey is not going to show in the UI if onSurveySubmitted is not populated
+         */
+        improvementSuggestions: {
+            category: 'audio' | 'video' | 'screenshare';
+            suggestion: string;
+        }[]) => Promise<void>;
+    };
     /**
      * Options for setting additional customizations related to personalized branding.
      */
@@ -4695,6 +4833,7 @@ export declare interface CommonCallingHandlers {
     onStopCaptions: () => Promise<void>;
     onSetSpokenLanguage: (language: string) => Promise<void>;
     onSetCaptionLanguage: (language: string) => Promise<void>;
+    onSubmitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
 }
 
 /**
@@ -5808,6 +5947,8 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     ContextMenuCameraIcon: React_2.JSX.Element;
     ContextMenuMicIcon: React_2.JSX.Element;
     ContextMenuSpeakerIcon: React_2.JSX.Element;
+    SurveyStarIcon: React_2.JSX.Element;
+    SurveyStarIconFilled: React_2.JSX.Element;
 };
 
 /**
@@ -5946,6 +6087,8 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     ContextMenuCameraIcon: React_2.JSX.Element;
     ContextMenuMicIcon: React_2.JSX.Element;
     ContextMenuSpeakerIcon: React_2.JSX.Element;
+    SurveyStarIcon: React_2.JSX.Element;
+    SurveyStarIconFilled: React_2.JSX.Element;
 };
 
 /**
@@ -9381,7 +9524,7 @@ export declare interface StatefulDeviceManager extends DeviceManager {
      * any way to {@link @azure/communication-calling#DeviceManager}. It is entirely contained in
      * {@link StatefulDeviceManager}. See also {@link DeviceManagerState.selectedCamera}.
      */
-    selectCamera: (VideoDeviceInfo: any) => void;
+    selectCamera: (device: VideoDeviceInfo) => void;
     /**
      * Gets the list of unparented video streams. This is a list of video streams that have not been added to a
      * {@link @azure/communication-calling#Call}. This is useful for developers who want to interact with rendered
@@ -9423,6 +9566,62 @@ export declare interface StreamMediaProps {
     styles?: BaseCustomStyles;
 }
 
+/**
+ * @beta
+ * Corresponding texts to each call issue
+ */
+export declare interface SurveyIssues {
+    overallRating: {
+        callCannotJoin: string;
+        callCannotInvite: string;
+        hadToRejoin: string;
+        callEndedUnexpectedly: string;
+        otherIssues: string;
+    };
+    audioRating: {
+        noLocalAudio: string;
+        noRemoteAudio: string;
+        echo: string;
+        audioNoise: string;
+        lowVolume: string;
+        audioStoppedUnexpectedly: string;
+        distortedSpeech: string;
+        audioInterruption: string;
+        otherIssues: string;
+    };
+    videoRating: {
+        noVideoReceived: string;
+        noVideoSent: string;
+        lowQuality: string;
+        freezes: string;
+        stoppedUnexpectedly: string;
+        darkVideoReceived: string;
+        audioVideoOutOfSync: string;
+        otherIssues: string;
+    };
+    screenshareRating: {
+        noContentLocal: string;
+        noContentRemote: string;
+        cannotPresent: string;
+        lowQuality: string;
+        freezes: string;
+        stoppedUnexpectedly: string;
+        largeDelay: string;
+        otherIssues: string;
+    };
+}
+
+/**
+ * @beta
+ * Corresponding texts to each call issue category
+ */
+export declare interface SurveyIssuesHeadingStrings {
+    overallRating: string;
+    audioRating: string;
+    videoRating: string;
+    screenshareRating: string;
+}
+
 /**
  * Discriminated union of all system messages.
  *