Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 2.54 KB

README.md

File metadata and controls

77 lines (58 loc) · 2.54 KB
Raw

Webex Component Adapter Interfaces

Library of Interfaces for Adapters in the Webex Component System

CircleCI npm latest version semantic-release 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!

Issues

Please open an issue and we will get to it in an orderly manner. Please leave as much as information as possible for a better understanding.

License

MIT License

Support

For more developer resources, tutorials and support, visit the Webex developer portal, https://developer.webex.com.