setCustomIntegrations()

setCustomIntegrations(customIntegrations) Prebuilt Custom Sets the custom integrations displayed in the Daily Prebuilt sidebar. Can be called at any time to update integration configuration.

Parameters

customIntegrations

DailyCustomIntegrations

required

An object mapping integration IDs (arbitrary strings) to DailyCustomIntegration configuration objects.

Hide DailyCustomIntegration fields

allow

string

Usage: allow: HTMLIFrameElement['allow'].
Feature policy for the iframe.

controlledBy

'*' | 'owners' | string[]

default:"'*'"

Who can start and stop this integration. '*' (default) allows all participants; 'owners' restricts to meeting owners; a string[] of session_ids restricts to specific participants.

csp

string

Content Security Policy for the iframe. Check browser support before using — here & here

iconURL

string

A publicly available URL to an icon image shown alongside the integration in the Prebuilt UI.

label

string

required

Display name shown in the Prebuilt UI for this integration.

'lazy' | 'eager'

default:"lazy"

'lazy' (default) or 'eager' — controls when the iframe is loaded.

location

'main' | 'sidebar'

required

Daily supports two different types of custom integrations:

Main call area integrations
Sidebar integrations

name

string

Usage: name: HTMLIFrameElement['name'];A unique name for the iframe.

referrerPolicy

string

Usage: referrerPolicy: HTMLIFrameElement['referrerPolicy'];Indicates which referrer to send when fetching the frame’s resource.

sandbox

string

Usage: sandbox: stringA unique policy for the iframe. Applies extra restrictions to the content in the frame.For more info see here.

shared

'owners' | string[] | boolean

default:"false"

When configured, it shares the integration’s state with other participants in the call:

true will share with all other participants
false won’t share
'owners' will share with owners only
string[] will share with participants with given list of session ids

When the integration is started, it will also be started for other participants with whom it is shared. When it is stopped, it will stop for all participants with whom it is shared.

src

string

Usage: src: HTMLIFrameElement['src'];The iframe’s source URL.For more info see here.

srcdoc

string

Usage: srcdoc: HTMLIFrameElement['srcdoc'];Inline HTML to render in the iframe instead of a URL.For more info see hereTo see if your browser supports this, see here.

Return value

Returns this for chaining.

Examples

Setting an integration

call.setCustomIntegrations({
  miroEmbed: {
    controlledBy: '*',
    iconURL: 'https://files.readme.io/17d4a23-miro-logo-color-square.png',
    label: 'Miro',
    location: 'main',
    name: 'miro',
    shared: false,
    allow: 'fullscreen; clipboard-read; clipboard-write',
    src: 'https://miro.com/app',
  },
});

Restricting control to owners

Setting controlledBy: 'owners' means only participants who joined with an owner token can start or stop the integration. Setting shared: true propagates the integration’s active state to all other participants who have it configured.

call.setCustomIntegrations({
  miroEmbed: {
    controlledBy: 'owners',
    shared: true,
    // ... other fields
  },
});

Types

DailyCallOptions: customIntegrations

Methods

Guides

Custom integrations

setBandwidth()setDailyLang()

​Parameters

​Return value

​Examples

​Setting an integration

​Restricting control to owners

​See also

Types

Methods

Guides

Parameters

Return value

Examples

Setting an integration

Restricting control to owners

See also