# iris-react-sdk

> React version of 555 RTC JS SDK

Latest version **2.0.2** (published 2020-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install iris-react-sdk
pnpm add iris-react-sdk
yarn add iris-react-sdk
bun add iris-react-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2020-08-06 |
| First published | 2017-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Comcast |
| Maintainers | nija, sanbc |
| Keywords | iris, react |

## Links

- npm: https://www.npmjs.com/package/iris-react-sdk
- Repository: https://github.com/555platform/react-js-sdk
- Homepage: https://github.com/555platform/react-js-sdk#readme
- Issues: https://github.com/555platform/react-js-sdk/issues
- npm.io page: https://npm.io/package/iris-react-sdk

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^16.6.1
- [react-dom](https://npm.io/package/react-dom.md) ^16.6.1
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.10
- [@555platform/555-js-sdk](https://npm.io/package/@555platform/555-js-sdk.md) ^4.4.4

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.2 (latest) — 2020-08-06
- 2.0.1 — 2020-07-07
- 2.0.0 — 2020-04-14
- 1.1.27 — 2020-01-28
- 1.1.26 — 2020-01-15
- 1.1.25 — 2020-01-06
- 1.1.24 — 2019-09-06
- 1.1.23 — 2019-07-26
- 1.1.22 — 2019-07-22
- 1.1.21 — 2019-07-11
- 1.1.20 — 2019-07-10
- 1.1.19 — 2019-06-28
- 1.1.18 — 2019-06-18
- 1.1.17 — 2019-06-18
- 1.1.16 — 2019-03-05
- … 39 more at https://npm.io/package/iris-react-sdk/versions

## README

# react-js-sdk

[![npm version][npm-image]][npm-url]

This document covers the 555 JavaScript SDK's React Component.

## Getting started

`$ npm install iris-react-sdk --save`

## Usage - Examples

```javascript
import {RoomContainer, RtcSdk} from 'iris-react-sdk';
```

1. Make connection using `iristoken` and `routingId`
  	```javascript

    // Call connection method
    RtcSdk.connect(iristoken, routingId, config.urls.eventManager);

    //Listen to onConnected event
    RtcSdk.onConnected = () => {
      console.log("App :: onConnected :: Iris connection successful");
    }

    //Listen to notification event
    RtcSdk.onNotification = (payload) => {
      console.log("App:: onNotification :: Payload : ", JSON.stringify(payload));
    }

    //Listen to iris diconnected event
    RtcSdk.onDisconnected = () => {
      console.log("App:: onDisconnected");
    }


    //Listen to connection errors
    RtcSdk.onError = (error) => {
      console.log("App:: onError :: error : ", error);
    }

    ```

2. Using `RoomContainer` to initiate/accept call

```js

return (
  <RoomContainer
  ref="room"
  Type={this.state.Type}
  RoomId={this.state.RoomId}
  Config={this.state.Config}
  NotificationPayload={this.state.NotificationPayload}
  onLocalStream={this.onLocalStream}
  onRemoteStream={this.onRemoteStream}
  onSessionCreated={this.onSessionCreated}
  onSessionJoined={this.onSessionJoined}
  onSessionConnected={this.onSessionConnected}
  onSessionParticipantJoined={this.onSessionParticipantJoined}
  onSessionParticipantAudioMuted={this.onSessionParticipantAudioMuted}  
  onSessionParticipantLeft={this.onSessionParticipantLeft}
  onSessionEnd={this.onSessionEnd}
  onUserProfileChange={this.onUserProfileChange}
  onSessionSIPStatus={this.onSessionSIPStatus}
  onError={this.onError}
  onEvent={this.onEvent}
  />
)

...

let roomId = response.room_id;
let Config = {
  irisToken: "",
  routingId: "",
  toTN: "",
  fromTN: "",
  toRoutingId: "",
  traceId: "",
  userData: "",
  SessionType: 'outgoing',
  notificationPayload: ''
};
this.setState({
  RoomId:roomId,
  Config:Config,
});

```

# APIs

## **Connection APIs - Make a connection using `connect`**
* **Example**

```js
import RtcSdk from 'iris-react-sdk';
RtcSdk.connect(irisToken, routingId, serverUrl);
```
* **Params**

  * `serverUrl` **{String}**: The url to event manager
  * `irisToken` **{String}**: A valid IRIS token
  * `routingId` **{String}**: Routing id of the user who is trying to login


## **Connection APIs - Disconnect using `disconnect`**
* **Example**

```js
import RtcSdk from 'iris-react-sdk';
RtcSdk.disconnect();
```
* **Params**

  * None



## **Media devices - Get a list of meida devices with `getMediaDevices`**

Returns a promise with list of available audio and video devies

* **Example**

```js
import RtcSdk from 'iris-react-sdk';
RtcSdk.getMediaDevices();
```

## **Request Media Device Permission - `requestMediaPermission`**

Returns a promise with boolean whether permission is acquired or not

* **Example**

```js
import RtcSdk from 'iris-react-sdk';
let deviceType = 'microphone'
RtcSdk.requestMediaPermission(deviceType).then((permissionAcquired){
  if(permissionAcquired){
    // Success
  }else{
    // Failed
  }
});
```


## **PSTN APIs - Hold a PSTN call using `pstnHold`**

* **Example**

```js
this.refs.room.pstnHold(roomId, participantJid);
```
* **Params**

  * `roomId` **{String}** : Room Id
  * `participantJid` **{String}**: Remote participant routingId/resourceId



## **PSTN APIs - UnHold a PSTN call using `pstnUnHold`**

* **Example**

```js
this.refs.room.pstnUnHold(roomId, participantJid);
```
* **Params**

  * `roomId` **{String}** : Room Id
  * `participantJid` **{String}**: Remote participant routingId/resourceId



## **PSTN APIs - Merge two PSTN calls using `pstnMerge`**

* **Example**

```js
this.refs.room.pstnMerge(roomId, firstParticipantJid, secondParticipantJid);
```
* **Params**

  * `roomId` **{String}** : Room Id
  * `firstParticipantJid` **{String}**: First remote participant's routingId/resourceId
  * `secondSession` **{object}**: IrisRtcSession object of the session to be merged
  * `secondParticipantJid` **{String}**: Second remote participant's routingId/resourceId



## **PSTN APIs - End PSTN call using `pstnHangup`**

* **Example**

```js
this.refs.room.pstnHangup(roomId, participantJid);
```
* **Params**

  * `roomId` **{String}** : Room Id
  * `participantJid` **{String}**: Remote participant's routingId/resourceId



<br/><br/>
# Callbacks

## **Connection - For connection successful listen to  `onConnected`**

* **Example**

```js
RtcSdk.onConnected = () => {
  console.log("App :: onConnected :: Iris connection successful");
}
```

* **Params**

  * None


## **Connection - For Notification listen to  `onNotification`**

* **Example**

```js
RtcSdk.onNotification = (notificationPayload) => {
  console.log("App :: notificationPayload :: Iris notification received");
}
```

* **Params**

  * `notificationPayload` **{json}** : Notification payload with the information to join session


## **Session - For PSTN SIP Status listen to  `onSessionSIPStatus`**

* **Example**

```js
  onSessionSIPStatus = (roomId, participantJid, status) => {
  console.log("App :: onSessionSIPStatus :: PSTN SIP Status : "+ status);
}
```

* **Params**

  * `roomId` **{String}** : RoomId of the session
  * `participantJid` **{String}** : Jid of the participant
  * `status` **{String}** : PSTN Status ex. initializing, connecting, ringing, connected.


## **RoomContainer - For local media stream `onLocalStream`**

* **Example**

```js
onLocalStream = (stream) => {
  console.log("App :: onLocalStream :: Local media stream received");
}
```

* **Params**

  * `stream` **{object}** : Local media stream



[npm-image]: https://flat.badgen.net/npm/v/iris-react-sdk
[npm-url]: https://www.npmjs.com/package/iris-react-sdk

---
_Source: https://npm.io/package/iris-react-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._