OutboundCallCompositeLoaderProps interface

Package:

@azure/communication-react

Props for the OutboundCallComposite that you can use in your application.

Contains two options bags:

• adapterOptions: Options for the useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)
• callCompositeOptions: Options for the CallComposite CallCompositeOptions

Extends

Partial<BaseCompositeProps<CallCompositeIcons>>

Properties

callAdapterOptions	Options for the useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) This is used to configure the call adapter.
callCompositeOptions	Options for the CallComposite CallCompositeOptions This is used to configure the call composite.
credential	CommunicationTokenCredential for the local user.
displayName	Display name for the local user.
formFactor	Device form factor for the composite. This is used to configure the call composite.
targetCallees	Participants that will be called. This can be a list of either <xref:CommunicationUserIdentifier> or string identifiers.
userId	UserId for the local user.

Inherited Properties

fluentTheme	Fluent theme for the composite.
icons	Custom Icon override for the composite. A JSX element can be provided to override the default icon.
locale	Locale for the composite.
onFetchAvatarPersonaData	A callback function that can be used to provide custom data to Avatars rendered in Composite. This will not affect the displayName shown in the composite. The displayName throughout the composite will be what is provided to the adapter when the adapter is created. will be what is provided to the adapter when the adapter is created.
onFetchParticipantMenuItems	A callback function that can be used to provide custom menu items for a participant in participant list.
rtl	Whether composite is displayed right-to-left.

Property Details

callAdapterOptions

Options for the useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) This is used to configure the call adapter.

callAdapterOptions?: CommonCallAdapterOptions

Property Value

CommonCallAdapterOptions

callCompositeOptions

Options for the CallComposite CallCompositeOptions This is used to configure the call composite.

callCompositeOptions?: CallCompositeOptions

Property Value

CallCompositeOptions

credential

CommunicationTokenCredential for the local user.

credential: CommunicationTokenCredential

Property Value

CommunicationTokenCredential

displayName

Display name for the local user.

displayName: string

Property Value

string

formFactor

Device form factor for the composite. This is used to configure the call composite.

formFactor?: "mobile" | "desktop"

Property Value

"mobile" | "desktop"

targetCallees

Participants that will be called. This can be a list of either <xref:CommunicationUserIdentifier> or string identifiers.

targetCallees: CommunicationIdentifier[] | string[]

Property Value

CommunicationIdentifier[] | string[]

userId

UserId for the local user.

userId: CommunicationUserIdentifier

Property Value

CommunicationUserIdentifier

Inherited Property Details

fluentTheme

Fluent theme for the composite.

fluentTheme?: PartialTheme | Theme

Property Value

PartialTheme | Theme

Inherited From Partial.fluentTheme

icons

Custom Icon override for the composite. A JSX element can be provided to override the default icon.

icons?: CallCompositeIcons

Property Value

CallCompositeIcons

Inherited From Partial.icons

locale

Locale for the composite.

locale?: CompositeLocale

Property Value

CompositeLocale

Inherited From Partial.locale

onFetchAvatarPersonaData

A callback function that can be used to provide custom data to Avatars rendered in Composite.

This will not affect the displayName shown in the composite. The displayName throughout the composite will be what is provided to the adapter when the adapter is created. will be what is provided to the adapter when the adapter is created.

onFetchAvatarPersonaData?: AvatarPersonaDataCallback

Property Value

AvatarPersonaDataCallback

Inherited From Partial.onFetchAvatarPersonaData

onFetchParticipantMenuItems

A callback function that can be used to provide custom menu items for a participant in participant list.

onFetchParticipantMenuItems?: ParticipantMenuItemsCallback

Property Value

ParticipantMenuItemsCallback

Inherited From Partial.onFetchParticipantMenuItems

rtl

Whether composite is displayed right-to-left.

rtl?: boolean

Property Value

boolean

Inherited From Partial.rtl