Skip to content

Commit

Permalink
Update API files
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Aug 6, 2024
1 parent bdf299f commit e77d1d1
Showing 1 changed file with 10 additions and 80 deletions.
90 changes: 10 additions & 80 deletions packages/communication-react/review/beta/communication-react.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ import { BackgroundBlurConfig } from '@azure/communication-calling';
import { BackgroundBlurEffect } from '@azure/communication-calling';
import { BackgroundReplacementConfig } from '@azure/communication-calling';
import { BackgroundReplacementEffect } from '@azure/communication-calling';
import { BreakoutRoom } from '@azure/communication-calling';
import { BreakoutRoomsSettings } from '@azure/communication-calling';
import { BreakoutRoomsUpdatedListener } from '@azure/communication-calling';
import { Call } from '@azure/communication-calling';
import { CallAgent } from '@azure/communication-calling';
import { CallClient } from '@azure/communication-calling';
Expand Down Expand Up @@ -351,16 +348,6 @@ export interface BlockedMessage extends MessageCommon {
warningText?: string;
}

// @public
export interface BreakoutRoomsState {
// (undocumented)
assignedBreakoutRoom?: BreakoutRoom;
// (undocumented)
breakoutRoomOriginCallId?: string;
// (undocumented)
breakoutRoomSettings?: BreakoutRoomsSettings;
}

// @beta
export interface BrowserPermissionDeniedIOSProps extends BrowserPermissionDeniedProps {
imageSource?: string;
Expand Down Expand Up @@ -454,7 +441,6 @@ export interface CallAdapterCallOperations {
removeParticipant(participant: CommunicationIdentifier): Promise<void>;
// @beta
resumeCall(): Promise<void>;
returnFromBreakoutRoom(): Promise<void>;
sendDtmfTone(dtmfTone: DtmfTone_2): Promise<void>;
setCaptionLanguage(language: string): Promise<void>;
setSpokenLanguage(language: string): Promise<void>;
Expand Down Expand Up @@ -539,7 +525,6 @@ export interface CallAdapterSubscribers {
off(event: 'roleChanged', listener: PropertyChangedEvent): void;
off(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
off(event: 'mutedByOthers', listener: PropertyChangedEvent): void;
off(event: 'breakoutRoomsUpdated', listener: BreakoutRoomsUpdatedListener): void;
on(event: 'participantsJoined', listener: ParticipantsJoinedListener): void;
on(event: 'participantsLeft', listener: ParticipantsLeftListener): void;
on(event: 'isMutedChanged', listener: IsMutedChangedListener): void;
Expand All @@ -561,7 +546,6 @@ export interface CallAdapterSubscribers {
on(event: 'roleChanged', listener: PropertyChangedEvent): void;
on(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
on(event: 'mutedByOthers', listener: PropertyChangedEvent): void;
on(event: 'breakoutRoomsUpdated', listener: BreakoutRoomsUpdatedListener): void;
}

// @public
Expand Down Expand Up @@ -713,15 +697,6 @@ export type CallCompositeIcons = {
StopAllSpotlightMenuButton?: JSX.Element;
};

// @beta
export type CallCompositeLoaderProps = {
userId: string;
token: string;
displayName: string;
locator: CallAdapterLocator;
options?: AzureCommunicationCallAdapterOptions;
};

// @public
export type CallCompositeOptions = {
errorBar?: boolean;
Expand Down Expand Up @@ -1097,7 +1072,6 @@ export interface CallProviderProps {

// @public
export interface CallState {
breakoutRooms?: BreakoutRoomsState;
callEndReason?: CallEndReason;
callerInfo: CallerInfo;
capabilitiesFeature?: CapabilitiesFeatureState;
Expand Down Expand Up @@ -1193,7 +1167,6 @@ export interface CallWithChatAdapterManagement {
removeResourceFromCache(resourceDetails: ResourceDetails): void;
// @beta
resumeCall: () => Promise<void>;
returnFromBreakoutRoom(): Promise<void>;
sendDtmfTone: (dtmfTone: DtmfTone_2) => Promise<void>;
sendMessage(content: string, options?: SendMessageOptions | /* @conditional-compile-remove(file-sharing-acs) */ MessageOptions): Promise<void>;
sendReadReceipt(chatMessageId: string): Promise<void>;
Expand Down Expand Up @@ -1266,8 +1239,6 @@ export interface CallWithChatAdapterSubscriptions {
// (undocumented)
off(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
// (undocumented)
off(event: 'breakoutRoomsUpdated', listener: BreakoutRoomsUpdatedListener): void;
// (undocumented)
off(event: 'messageReceived', listener: MessageReceivedListener): void;
// (undocumented)
off(event: 'messageEdited', listener: MessageEditedListener): void;
Expand Down Expand Up @@ -1320,8 +1291,6 @@ export interface CallWithChatAdapterSubscriptions {
// (undocumented)
on(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
// (undocumented)
on(event: 'breakoutRoomsUpdated', listener: BreakoutRoomsUpdatedListener): void;
// (undocumented)
on(event: 'messageReceived', listener: MessageReceivedListener): void;
// (undocumented)
on(event: 'messageEdited', listener: MessageEditedListener): void;
Expand Down Expand Up @@ -1449,15 +1418,6 @@ export type CallWithChatCompositeIcons = {
StopAllSpotlightMenuButton?: JSX.Element;
};

// @beta
export type CallWithChatCompositeLoaderProps = {
userId: string;
token: string;
displayName: string;
endpoint: string;
locator: CallAndChatLocator;
};

// @public
export type CallWithChatCompositeOptions = {
callControls?: boolean | CallWithChatControlOptions;
Expand Down Expand Up @@ -1558,7 +1518,7 @@ export interface CallWithChatControlOptions extends CommonCallControlOptions {
}

// @public
export type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | 'isCaptionsActiveChanged' | 'captionsReceived' | 'isCaptionLanguageChanged' | 'isSpokenLanguageChanged' | 'capabilitiesChanged' | 'spotlightChanged' | /* @conditional-compile-remove(breakout-rooms) */ 'breakoutRoomsUpdated' | 'messageReceived' | 'messageEdited' | 'messageDeleted' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved' | 'chatInitialized';
export type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | 'isCaptionsActiveChanged' | 'captionsReceived' | 'isCaptionLanguageChanged' | 'isSpokenLanguageChanged' | 'capabilitiesChanged' | 'spotlightChanged' | 'messageReceived' | 'messageEdited' | 'messageDeleted' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved' | 'chatInitialized';

// @beta
export const CameraAndMicrophoneSitePermissions: (props: CameraAndMicrophoneSitePermissionsProps) => JSX.Element;
Expand Down Expand Up @@ -1879,15 +1839,6 @@ export type ChatCompositeIcons = {
SendBoxAttachFile?: JSX.Element;
};

// @beta
export type ChatCompositeLoaderProps = {
userId: string;
token: string;
displayName?: string;
endpoint: string;
threadId: string;
};

// @public
export type ChatCompositeOptions = {
errorBar?: boolean;
Expand Down Expand Up @@ -1948,7 +1899,7 @@ export type ChatHandlers = {
onRemoveParticipant: (userId: string) => Promise<void>;
updateThreadTopicName: (topicName: string) => Promise<void>;
onLoadPreviousChatMessages: (messagesToLoad: number) => Promise<boolean>;
onUpdateMessage: (messageId: string, content: string, options?: MessageOptions) => Promise<void>;
onUpdateMessage: (messageId: string, content: string, /* @conditional-compile-remove(file-sharing-acs) */ options?: MessageOptions) => Promise<void>;
onDeleteMessage: (messageId: string) => Promise<void>;
};

Expand Down Expand Up @@ -2603,10 +2554,10 @@ export interface CustomMessage extends MessageCommon {
export const darkTheme: PartialTheme & CallingTheme;

// @beta
export type DeclarativeCallAgent = CallAgent & IncomingCallManagement;
export type DeclarativeCallAgent = CallAgent & /* @conditional-compile-remove(one-to-n-calling) */ IncomingCallManagement;

// @public
export type DeclarativeTeamsCallAgent = TeamsCallAgent & TeamsIncomingCallManagement;
export type DeclarativeTeamsCallAgent = TeamsCallAgent & /* @conditional-compile-remove(one-to-n-calling) */ TeamsIncomingCallManagement;

// @public
export const DEFAULT_COMPONENT_ICONS: {
Expand Down Expand Up @@ -3379,21 +3330,9 @@ export interface JumpToNewMessageButtonProps {
// @public
export const lightTheme: PartialTheme & CallingTheme;

// @beta
export const loadCallComposite: (adapterArgs: CallCompositeLoaderProps, htmlElement: HTMLElement | null, props?: CallCompositeOptions) => Promise<CallAdapter | undefined>;

// @beta
export const loadCallWithChatComposite: (args: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement | null, props: CallWithChatCompositeOptions) => Promise<CallWithChatAdapter | undefined>;

// @beta
export const loadChatComposite: (args: ChatCompositeLoaderProps, htmlElement: HTMLElement | null, props: ChatCompositeOptions) => Promise<ChatAdapter | undefined>;

// @public
export type LoadingState = 'loading' | 'none';

// @beta
export const loadOutboundCallComposite: (adapterArgs: OutboundCallCompositeLoaderProps, htmlElement: HTMLElement | null, props?: CallCompositeOptions) => Promise<CallAdapter | undefined>;

// @public
export const LocalizationProvider: (props: LocalizationProviderProps) => JSX.Element;

Expand Down Expand Up @@ -3537,7 +3476,7 @@ export type MessageProps = {
onUpdateMessage?: UpdateMessageCallback;
onCancelEditMessage?: CancelEditCallback;
onDeleteMessage?: (messageId: string) => Promise<void>;
onSendMessage?: (content: string, options?: MessageOptions) => Promise<void>;
onSendMessage?: (content: string, /* @conditional-compile-remove(file-sharing-acs) */ options?: MessageOptions) => Promise<void>;
};

// @public
Expand Down Expand Up @@ -3612,7 +3551,7 @@ export type MessageThreadProps = {
onUpdateMessage?: UpdateMessageCallback;
onCancelEditMessage?: CancelEditCallback;
onDeleteMessage?: (messageId: string) => Promise<void>;
onSendMessage?: (content: string, options?: MessageOptions) => Promise<void>;
onSendMessage?: (content: string, /* @conditional-compile-remove(file-sharing-acs) */ options?: MessageOptions) => Promise<void>;
disableEditing?: boolean;
strings?: Partial<MessageThreadStrings>;
attachmentOptions?: AttachmentOptions;
Expand Down Expand Up @@ -3880,15 +3819,6 @@ export interface OptionsDevice {
name: string;
}

// @beta
export type OutboundCallCompositeLoaderProps = {
userId: string;
token: string;
displayName: string;
targetCallees: string[] | StartCallIdentifier[];
options?: AzureCommunicationCallAdapterOptions;
};

// @public
export type OverflowGalleryPosition = 'horizontalBottom' | 'verticalRight' | 'horizontalTop';

Expand Down Expand Up @@ -4264,7 +4194,7 @@ export interface RichTextSendBoxProps {
content: DocumentFragment;
}) => void;
onRemoveInlineImage?: (imageAttributes: Record<string, string>) => void;
onSendMessage: (content: string, options?: MessageOptions) => Promise<void>;
onSendMessage: (content: string, /* @conditional-compile-remove(file-sharing-acs) */ options?: MessageOptions) => Promise<void>;
onTyping?: () => Promise<void>;
strings?: Partial<RichTextSendBoxStrings>;
systemMessage?: string;
Expand Down Expand Up @@ -4364,7 +4294,7 @@ export interface SendBoxProps {
onRenderAttachmentUploads?: () => JSX.Element;
onRenderIcon?: (isHover: boolean) => JSX.Element;
onRenderSystemMessage?: (systemMessage: string | undefined) => React_2.ReactElement;
onSendMessage?: (content: string, options?: MessageOptions) => Promise<void>;
onSendMessage?: (content: string, /* @conditional-compile-remove(file-sharing-acs) */ options?: MessageOptions) => Promise<void>;
onTyping?: () => Promise<void>;
strings?: Partial<SendBoxStrings>;
styles?: SendBoxStylesProps;
Expand Down Expand Up @@ -4852,7 +4782,7 @@ export interface UnsupportedOperatingSystemStrings {
}

// @public
export type UpdateMessageCallback = (messageId: string, content: string, options?: MessageOptions) => Promise<void>;
export type UpdateMessageCallback = (messageId: string, content: string, /* @conditional-compile-remove(file-sharing-acs) */ options?: MessageOptions) => Promise<void>;

// @beta
export type UploadChatImageResult = {
Expand Down Expand Up @@ -4961,7 +4891,7 @@ export interface VideoBackgroundReplacementEffect extends BackgroundReplacementC
export const VideoGallery: (props: VideoGalleryProps) => JSX.Element;

// @public (undocumented)
export type VideoGalleryLayout = 'default' | 'floatingLocalVideo' | 'speaker' | /* @conditional-compile-remove(large-gallery) */ 'largeGallery' | 'focusedContent';
export type VideoGalleryLayout = 'default' | 'floatingLocalVideo' | 'speaker' | 'focusedContent';

// @public
export interface VideoGalleryLocalParticipant extends VideoGalleryParticipant {
Expand Down

0 comments on commit e77d1d1

Please sign in to comment.