communication-react-19
Version:
React library for building modern communication user experiences utilizing Azure Communication Services (React 19 compatible fork)
56 lines • 2.35 kB
TypeScript
import { CommunicationTokenCredential, CommunicationUserIdentifier } from '@azure/communication-common';
import { CallWithChatAdapter, CallAndChatLocator, CallWithChatCompositeOptions, AzureCommunicationCallAdapterOptions, BaseCompositeProps, CallWithChatCompositeIcons } from "../../react-composites/src/index-public";
/**
* Props for the CallWithChatComposite that you can use in your application.
*
* Contains two options bags:
* - adapterOptions: Options for the {@link AzureCommunicationCallAdapterOptions}
* - callCompositeOptions: Options for the {@link CallWithChatComposite} {@link CallWithChatCompositeOptions}
* @public
*/
export interface CallWithChatCompositeLoaderProps extends Partial<BaseCompositeProps<CallWithChatCompositeIcons>> {
/**
* UserId for the local user.
*/
userId: CommunicationUserIdentifier;
/**
* CommunicationTokenCredential for the local user.
*/
credential: CommunicationTokenCredential;
/**
* Display name for the local user.
*/
displayName: string;
/**
* Azure communication service endpoint. This used for the token and joining the chat thread.
*/
endpoint: string;
/**
* Locator for the call and the chat thread.
* This is used to join the call and the chat thread.
*/
locator: CallAndChatLocator;
/**
* Options for the {@link AzureCommunicationCallAdapterOptions}
* This is used to configure the call adapter.
*/
callAdapterOptions?: AzureCommunicationCallAdapterOptions;
/**
* Options for the {@link CallWithChatComposite} {@link CallWithChatCompositeOptions}
* This is used to configure the call composite.
*/
callWithChatCompositeOptions?: CallWithChatCompositeOptions;
/**
* Device form factor for the composite.
*/
formFactor?: 'mobile' | 'desktop';
}
/**
* Props for the CallWithChatComposite that you can use in your application. This
* function will load the CallWithChatComposite into the provided HTML element.
* The best use case for this is in a Node UI framework that is not React based.
*
* @public
*/
export declare const loadCallWithChatComposite: (loaderArgs: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement) => Promise<CallWithChatAdapter | undefined>;
//# sourceMappingURL=callWithChatCompositeLoader.d.ts.map