CallWithChatCompositeProps interface

  • Reference
Package:
@azure/communication-react

Props required for the CallWithChatComposite

Extends

BaseCompositeProps<CallWithChatCompositeIcons>

Properties

adapter
fluentTheme

Fluent theme for the composite.

Defaults to a light theme if undefined.
formFactor

Optimizes the composite form factor for either desktop or mobile.
joinInvitationURL

URL that can be used to copy a call-with-chat invite to the Users clipboard.
options

Flags to enable/disable or customize UI elements of the CallWithChatComposite

Inherited Properties

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

adapter 

adapter: CallWithChatAdapter

Property Value

CallWithChatAdapter

fluentTheme

Fluent theme for the composite.

Defaults to a light theme if undefined.

fluentTheme?: PartialTheme | Theme

Property Value

PartialTheme | Theme

formFactor

Optimizes the composite form factor for either desktop or mobile.

formFactor?: "desktop" | "mobile"

Property Value

"desktop" | "mobile"

Remarks

mobile is currently only optimized for Portrait mode on mobile devices and does not support landscape.

joinInvitationURL

URL that can be used to copy a call-with-chat invite to the Users clipboard.

joinInvitationURL?: string

Property Value

string

options

Flags to enable/disable or customize UI elements of the CallWithChatComposite

options?: CallWithChatCompositeOptions

Property Value

CallWithChatCompositeOptions

Inherited Property Details

icons

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

icons?: CallWithChatCompositeIcons

Property Value

CallWithChatCompositeIcons

Inherited From BaseCompositeProps.icons

locale

Locale for the composite.

locale?: CompositeLocale

Property Value

CompositeLocale

Inherited From BaseCompositeProps.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 BaseCompositeProps.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 BaseCompositeProps.onFetchParticipantMenuItems

rtl

Whether composite is displayed right-to-left.

rtl?: boolean

Property Value

boolean

Inherited From BaseCompositeProps.rtl