extensions

Extensions

This folder contains features which are not considered to be the core of the SDK.

We provide them as extensions so you can install them on demand.

Usage

Here we provide general usage guidance for extensions. You need to read each extension's README page in case there are special instructions.

Let's say an extension's name is AbcExtension:

import RingCentral from '@rc-ex/core';
import AbcExtension from '@rc-ex/abc';

const rc = new RingCentral(...);
const abcExtension = new AbcExtension(...);
await rc.installExtension(abcExtension);

Enable & Disable

By default, an extension is enabled after installation. You can disable it by abcExtension.disable();.

You can re-enabled it by abcExtension.enable();.

Debug Extension

Debug extension prints details about API traffic so you can inspect the request and response data.

Retry Extension

Retry Extension auto retries API calls based on specified condition and interval.

Rate Limit Extension

Rate limit extension handles rate limit automatically by delaying and retrying API calls.

Events Extension

Events Extension emits API call related events.

RingCentral SDK Extension

RingCentral Extension makes @ringcentral/sdk the HTTP engine.

WebSocket Extension

WebSocket Extension adds support for WebSocket protocol.

Authorize URI Extension

Authorize URI Extension provides utility methods to easily build URIs for OAuth.

Auto Refresh Extension

Auto Refresh Extension automatically refreshes token every 30 minutes (configurable).