https://github.com/webex/component-adapter-interfaces

Interfaces for Adapters in the Webex Component System | https://github.com/webex/components
https://github.com/webex/component-adapter-interfaces

webex webex-component webex-teams

Last synced: 4 days ago
JSON representation

Interfaces for Adapters in the Webex Component System | https://github.com/webex/components

• Host: GitHub
• URL: https://github.com/webex/component-adapter-interfaces
• Owner: webex
• License: mit
• Created: 2019-10-21T21:54:23.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-16T07:12:43.000Z (6 days ago)
• Last Synced: 2024-12-16T08:22:03.557Z (6 days ago)
• Topics: webex, webex-component, webex-teams
• Language: JavaScript
• Homepage:
• Size: 10.9 MB
• Stars: 5
• Watchers: 21
• Forks: 31
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


  
Webex Component Adapter Interfaces

  
Library of Interfaces for Adapters in the Webex Component System


  

    

  

  

    

  

  

    

  

  

    

  



**Webex Component Adapter Interfaces** is a set of interfaces that the

[Webex Component System](https://github.com/webex/components#adapters)

uses as a contract for the _Webex Components_ on how to obtain data.

## Table of Contents

- [Table of Contents](#table-of-contents)

- [Install](#install)

- [Usage](#usage)

- [License](#license)

- [Support](#support)

## Install

```bash

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](https://github.com/webex/components#webex-components) but for

which an adapter does not exist for their source of data. For instance, the

[SDK Component Adapter](https://github.com/webex/sdk-component-adapter#webex-sdk-component-adapter)

exists to communicate with the

[Javascript SDK](https://github.com/webex/webex-js-sdk#webex-js-sdk)

to ultimately obtain data from Webex services.

An example of extending the `RoomsAdapter` for your datasource would look like:

```js

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](https://github.com/webex/component-adapter-interfaces/issues)

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](https://opensource.org/licenses/MIT)

## Support

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