Share via

CallCompositeProps interface

  • Reference
Package:
@azure/communication-react

Props for CallComposite.

Extends

BaseCompositeProps<CallCompositeIcons>

Properties

adapter

An adapter provides logic and data to the composite. Composite can also be controlled using the adapter.
callInvitationUrl

URL to invite new participants to the current call. If this is supplied, a button appears in the Participants Button flyout menu.
formFactor

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

Flags to enable/disable or customize UI elements of the CallComposite.

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

adapter

An adapter provides logic and data to the composite. Composite can also be controlled using the adapter.

adapter: CommonCallAdapter

Property Value

CommonCallAdapter

callInvitationUrl

URL to invite new participants to the current call. If this is supplied, a button appears in the Participants Button flyout menu.

callInvitationUrl?: string

Property Value

string

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.

options

Flags to enable/disable or customize UI elements of the CallComposite.

options?: CallCompositeOptions

Property Value

CallCompositeOptions

Inherited Property Details

fluentTheme

Fluent theme for the composite.

fluentTheme?: PartialTheme | Theme

Property Value

PartialTheme | Theme

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