listProviders( )
Retrieves a list of the external calendar providers for which the site supports integration.
Description
The list of external calendar providers includes:
- External calendar providers that are supported by default, such as Google, Apple, and Microsoft.
- External calenders for which the site owner has enabled integration by installing an app.
For each external calendar provider, the list contains information about supported connection methods and features.
For each provider, check features.connectMethods
to find out whether to use connectByCredentials()
or connectByOAuth()
to establish a connection.
This function requires elevated permissions to run. This function is not universal and runs only on the backend.
Syntax
function listProviders(): Promise<ListProvidersResponse>
listProviders Parameters
This function does not take any parameters.
Returns
Return Type:
NAME
TYPE
DESCRIPTION
Retrieves a list of the external calendar providers for which the site supports integration.
The list of external calendar providers includes:
- External calendar providers that are supported by default, such as Google, Apple, and Microsoft.
- External calenders for which the site owner has enabled integration by installing an app.
For each external calendar provider, the list contains information about supported connection methods and features.
For each provider, check features.connectMethods
to find out whether to use connectByCredentials()
or connectByOAuth()
to establish a connection.
Was this helpful?
List the supported external calendar providers
1import {externalCalendars} from 'wix-bookings.v2';23async function listProviders() {4 const {providers} = await externalCalendars.listProviders()5 return providers6}