@azure/communication-react 1.3.3-alpha-202210060021.0 → 1.3.3-alpha-202210080019.0

package/dist/communication-react.d.ts

@@ -52,6 +52,7 @@ import { IContextualMenuItemStyles } from '@fluentui/react';
 import { IContextualMenuStyles } from '@fluentui/react';
 import { IDropdownOption } from '@fluentui/react';
 import { IDropdownStyles } from '@fluentui/react';
+import { ILinkStyles } from '@fluentui/react';
 import { IMessageBarProps } from '@fluentui/react';
 import { IncomingCall } from '@azure/communication-calling';
 import { IPersonaStyleProps } from '@fluentui/react';
@@ -355,6 +356,136 @@ export declare interface BaseCustomStyles {
     root?: IStyle;
 }
 
+/**
+ * @beta
+ * Props for BrowserPermissionDeniedIOS component.
+ */
+export declare interface BrowserPermissionDeniedIOSProps extends BrowserPermissionDeniedProps {
+    /**
+     * Localization strings for BrowserPermissionDeniedIOS component.
+     */
+    strings: BrowserPermissionDeniedIOSStrings;
+    /**
+     * Link to image source.
+     *
+     * Image is inserted into the top of the component.
+     */
+    imageSource?: string;
+}
+
+/**
+ * @beta
+ * Strings for BrowserPermissionDeniedIOS component
+ */
+export declare interface BrowserPermissionDeniedIOSStrings extends BrowserPermissionDeniedStrings {
+    /**
+     * Image alt text
+     */
+    imageAltText: string;
+    /**
+     * Main text string.
+     */
+    primaryText: string;
+    /**
+     * Subtext string.
+     */
+    secondaryText: string;
+    /**
+     * Step 1 string
+     */
+    step1Text: string;
+    /**
+     * Step 1 digit string
+     */
+    step1DigitText: string;
+    /**
+     * Step 2 string
+     */
+    step2Text: string;
+    /**
+     * Step 2 digit string
+     */
+    step2DigitText: string;
+    /**
+     * Step 3 string
+     */
+    step3Text: string;
+    /**
+     * Step 3 digit string
+     */
+    step3DigitText: string;
+    /**
+     * Step 4 string
+     */
+    step4Text: string;
+    /**
+     * Step 4 digit string
+     */
+    step4DigitText: string;
+}
+
+/**
+ * @beta
+ * Props for BrowserPermissionDenied component.
+ */
+export declare interface BrowserPermissionDeniedProps {
+    /**
+     * Action to be taken by the more help link. Possible to send to external page or show other modal.
+     */
+    onTroubleshootingClick: () => void;
+    /**
+     * Action to be taken by the try again primary button.
+     */
+    onTryAgainClick: () => void;
+    /**
+     * Localization strings for BrowserPermissionDenied component.
+     */
+    strings: BrowserPermissionDeniedStrings;
+    /**
+     * Allows users to pass in an object contains custom CSS styles.
+     * @Example
+     * ```
+     * <BrowserPermissionDenied styles={{ primaryButton: { root: {backgroundColor: 'blue' }}}} />
+     * ```
+     */
+    styles?: BrowserPermissionDeniedStyles;
+}
+
+/**
+ * @beta
+ * Strings for BrowserPermissionDenied component
+ */
+export declare interface BrowserPermissionDeniedStrings {
+    /**
+     * Main button text string.
+     */
+    primaryButtonText: string;
+    /**
+     * Main text string.
+     */
+    primaryText: string;
+    /**
+     * Subtext string.
+     */
+    secondaryText: string;
+    /**
+     * More help link string.
+     */
+    linkText: string;
+}
+
+/**
+ * Fluent styles for {@link BrowserPermissionDenied}.
+ *
+ * @beta
+ */
+export declare interface BrowserPermissionDeniedStyles extends BaseCustomStyles {
+    /** Styles for the primary button. */
+    primaryButton?: IButtonStyles;
+    /** Styles for the help troubleshooting link text. */
+    troubleshootingLink?: ILinkStyles;
+}
+
 /**
  * {@link CallComposite} Adapter interface.
  *
@@ -1011,6 +1142,19 @@ export declare type CallCompositeOptions = {
      * if this is not supplied, the composite will not show a 'network troubleshooting' link.
      */
     onNetworkingTroubleShootingClick?: () => void;
+    /**
+     * Callback you may provide to supply users with a provided page to showcase supported browsers by ACS.
+     *
+     * @example
+     * ```ts
+     * onBrowserTroubleShootingClick?: () =>
+     *  window.open('https://contoso.com/browser-troubleshooting', '_blank');
+     * ```
+     *
+     * @remarks
+     * if this is not supplied, the composite will not show a unsupported browser page.
+     */
+    onEnvironmentInfoTroubleshootingClick?: () => void;
 };
 
 /**
@@ -1018,7 +1162,7 @@ export declare type CallCompositeOptions = {
  *
  * @public
  */
-export declare type CallCompositePage = 'accessDeniedTeamsMeeting' | 'call' | 'configuration' | /* @conditional-compile-remove(PSTN-calls) */ 'hold' | 'joinCallFailedDueToNoNetwork' | 'leftCall' | 'lobby' | /* @conditional-compile-remove(rooms) */ 'deniedPermissionToRoom' | 'removedFromCall' | /* @conditional-compile-remove(rooms) */ 'roomNotFound';
+export declare type CallCompositePage = 'accessDeniedTeamsMeeting' | 'call' | 'configuration' | /* @conditional-compile-remove(PSTN-calls) */ 'hold' | 'joinCallFailedDueToNoNetwork' | 'leftCall' | 'lobby' | /* @conditional-compile-remove(rooms) */ 'deniedPermissionToRoom' | 'removedFromCall' | /* @conditional-compile-remove(rooms) */ 'roomNotFound' | /* @conditional-compile-remove(unsupported-browser) */ 'unsupportedEnvironment';
 
 /**
  * Props for {@link CallComposite}.
@@ -1534,6 +1678,7 @@ export declare type CallingHandlers = {
     onDisposeRemoteStreamView: (userId: string) => Promise<void>;
     onDisposeLocalStreamView: () => Promise<void>;
     onSendDtmfTone: (dtmfTone: DtmfTone_2) => Promise<void>;
+    askDevicePermission: (constrain: PermissionConstraints) => Promise<void>;
 };
 
 /**
@@ -3365,6 +3510,10 @@ export declare interface ComponentStrings {
     DomainPermissions: DomainPermissionsStrings;
     /** Strings for unsupported browser UI */
     UnsupportedBrowser: UnsupportedBrowserStrings;
+    /** Strings for BrowserPemissionDenied */
+    BrowserPermissionDenied: BrowserPermissionDeniedStrings;
+    /** Strings for BrowserPemissionDeniedIOS */
+    BrowserPermissionDeniedIOS: BrowserPermissionDeniedIOSStrings;
 }
 
 /**
@@ -4076,6 +4225,7 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     DomainPermissionCamera: JSX.Element;
     DomainPermissionMic: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
+    BrowserPermissionDeniedError: JSX.Element;
 };
 
 /**
@@ -4168,6 +4318,7 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     DomainPermissionCamera: JSX.Element;
     DomainPermissionMic: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
+    BrowserPermissionDeniedError: JSX.Element;
 };
 
 /**
@@ -4247,9 +4398,18 @@ export declare interface _DevicePermissionDropdownProps {
      */
     options?: IDropdownOption[];
     /**
-     * Function that gets triggered when action button is clicked
+     * Ask for permissions of devices.
+     *
+     * @remarks
+     * Browser permission window will pop up if permissions are not granted yet
+     *
+     * @param constrain - Define constraints for accessing local devices {@link @azure/communication-calling#PermissionConstraints }
+     */
+    askDevicePermission?(constrain: _PermissionConstraints): Promise<void>;
+    /**
+     * Define constraints for accessing local devices  {@link @azure/communication-calling#PermissionConstraints }
      */
-    onClickActionButton?: () => Promise<void>;
+    constrain?: _PermissionConstraints;
     /**
      * Strings for devicepermissiondropdown
      */
@@ -4559,6 +4719,10 @@ export declare interface DomainPermissionsProps {
      * Action to be taken by the more help link. Possible to send to external page or show other modal.
      */
     onTroubleshootingClick: () => void;
+    /**
+     * Action to be taken by the Allow Access button.
+     */
+    onAllowAccessClick?: () => void;
     /**
      * Localization strings for DomainPermissions component.
      */
@@ -4582,6 +4746,10 @@ export declare interface DomainPermissionsStrings {
      * More help link string.
      */
     linkText: string;
+    /**
+     * Primary button text string.
+     */
+    primaryButtonText: string;
 }
 
 /**
@@ -5046,7 +5214,7 @@ export declare const fromFlatCommunicationIdentifier: (id: string) => Communicat
  *
  * @public
  */
-export declare type GetCallingSelector<Component extends (props: any) => JSX.Element | undefined> = AreEqual<Component, typeof VideoGallery> extends true ? VideoGallerySelector : AreEqual<Component, typeof DevicesButton> extends true ? DevicesButtonSelector : AreEqual<Component, typeof MicrophoneButton> extends true ? MicrophoneButtonSelector : AreEqual<Component, typeof CameraButton> extends true ? CameraButtonSelector : AreEqual<Component, typeof ScreenShareButton> extends true ? ScreenShareButtonSelector : AreEqual<Component, typeof ParticipantList> extends true ? ParticipantListSelector : AreEqual<Component, typeof ParticipantsButton> extends true ? ParticipantsButtonSelector : AreEqual<Component, typeof EndCallButton> extends true ? EmptySelector : AreEqual<Component, typeof ErrorBar> extends true ? CallErrorBarSelector : AreEqual<Component, typeof Dialpad> extends true ? EmptySelector : AreEqual<Component, typeof HoldButton> extends true ? HoldButtonSelector : undefined;
+export declare type GetCallingSelector<Component extends (props: any) => JSX.Element | undefined> = AreEqual<Component, typeof VideoGallery> extends true ? VideoGallerySelector : AreEqual<Component, typeof DevicesButton> extends true ? DevicesButtonSelector : AreEqual<Component, typeof MicrophoneButton> extends true ? MicrophoneButtonSelector : AreEqual<Component, typeof CameraButton> extends true ? CameraButtonSelector : AreEqual<Component, typeof ScreenShareButton> extends true ? ScreenShareButtonSelector : AreEqual<Component, typeof ParticipantList> extends true ? ParticipantListSelector : AreEqual<Component, typeof ParticipantsButton> extends true ? ParticipantsButtonSelector : AreEqual<Component, typeof EndCallButton> extends true ? EmptySelector : AreEqual<Component, typeof ErrorBar> extends true ? CallErrorBarSelector : AreEqual<Component, typeof Dialpad> extends true ? EmptySelector : AreEqual<Component, typeof HoldButton> extends true ? HoldButtonSelector : AreEqual<Component, typeof _DevicePermissionDropdown> extends true ? EmptySelector : undefined;
 
 /**
  * Get the selector for a specified component.
@@ -6460,6 +6628,16 @@ export declare type ParticipantsRemovedListener = (event: {
  */
 export declare type ParticipantState = 'Idle' | 'Connecting' | 'Ringing' | 'Connected' | 'Hold' | 'InLobby' | 'EarlyMedia' | 'Disconnected';
 
+/**
+ * Define constraints for accessing local devices  {@link @azure/communication-calling#PermissionConstraints }
+ *
+ * @internal
+ */
+export declare type _PermissionConstraints = {
+    audio: boolean;
+    video: boolean;
+};
+
 /**
  * An array of key value pairs that stores each sender's display name and last read message
  *