Share via

ChatCompositeLoaderProps interface

Package:
@azure/communication-react

Props for the ChatComposite that you can use in your application. Contains the options for the ChatComposite ChatCompositeOptions.

Extends

Partial<BaseCompositeProps<ChatCompositeIcons>>

Properties

chatCompositeOptions

Options for the useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>) This is used to configure the chat adapter.
credential

CommunicationTokenCredential for the local user.
displayName

Display name for the local user.
endpoint

Communication service endpoint. This is used for the token and joining the chat thread.
threadId

Communication threadId for the chat thread.
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

chatCompositeOptions

Options for the useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>) This is used to configure the chat adapter.

chatCompositeOptions?: ChatCompositeOptions

Property Value

ChatCompositeOptions

credential

CommunicationTokenCredential for the local user.

credential: CommunicationTokenCredential

Property Value

CommunicationTokenCredential

displayName

Display name for the local user.

displayName?: string

Property Value

string

endpoint

Communication service endpoint. This is used for the token and joining the chat thread.

endpoint: string

Property Value

string

threadId

Communication threadId for the chat thread.

threadId: string

Property Value

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?: ChatCompositeIcons

Property Value

ChatCompositeIcons

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