Webex Component Adapter Interfaces
Library of Interfaces for Adapters in the Webex Component System
<img alt='CircleCI' src='https://circleci.com/gh/webex/component-adapter-interfaces.svg?style=shield'>
<img alt='npm latest version' src='https://img.shields.io/npm/v/@webex/component-adapter-interfaces?label=npm%40latest'>
<img alt='semantic-release' src='https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg'>
<img src='https://img.shields.io/npm/l/webex.svg' alt='license'>
Webex Component Adapter Interfaces is a set of interfaces that the Webex Component System uses as a contract for the Webex Components on how to obtain data.
Table of Contents
Install
npm install --save @webex/component-adapter-interfaces
Usage
The adapter interfaces are meant to be used by developers that want to use the Webex Components but for which an adapter does not exist for their source of data. For instance, the SDK Component Adapter exists to communicate with the Javascript SDK to ultimately obtain data from Webex services.An example of extending the
RoomsAdapter
for your datasource would look like:import {RoomsAdapter} from '@webex/components-adapter-interfaces';
export default class MyRoomsAdapter extends RoomsAdapter {
getRoom(ID) {
// ... my implementation
}
}
The key of the interfaces is that they define what methods the Webex Components expect.
Happy Coding!