widget-space

Spark Space Widget (@ciscospark/widget-space)

The Spark Space widget allows developers to easily incorporate Cisco Spark Space messaging into an application.

Table of Contents

• Background
• Install
  • CDN
  • Build from Source
• Usage
  • Quick Start
  • Configuration
  • HTML
    • Browser
    • Browser Globals
    • Data API
  • JSX
  • Events
• Browser Support

Background

This widget handles coordination between your application and the Spark APIs, and provides components of the Spark space experience without having to build all of the front end UI yourself.

Our widget is built using React https://github.com/facebook/react, Redux https://github.com/reactjs/redux, and the Spark Javascript SDK https://github.com/webex/spark-js-sdk.

This widget supports:

• 1 on 1 and group space messaging
• 1 on 1 and group space video calling
• Space Roster list and @mentions
• Dialing by email address or SIP address
• Inline Markdown
• Sharing of files and documents
• Previewing and downloading of files and documents
• Flagging messages for follow up

Install

Depending on how comfortable you are with these frameworks, there are are a number of ways you can "install" our code.

Spark for Developers

If you haven't already, go to the Spark for Developers Portal (https://developer.ciscospark.com) and sign up for an account. Once you've created an account you can get your developer access token by clicking on your avatar at the top right of the screen.

When you want to eventually create an integration and have your own users take advantage of the widget, you'll need to create an integration with the spark:all scope.

Head over to the Spark for Developers Documentation for more information about how to setup OAuth for your app: https://developer.ciscospark.com/authentication.html

CDN

Using our CDN requires the least amount of work to get started. Add the following into your HTML file:

<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://code.s4d.io/widget-space/production/main.css">

<!-- Latest compiled and minified JavaScript -->
<script src="https://code.s4d.io/widget-space/production/bundle.js"></script>

For the latest builds that are pulled from the head of the master branch:

<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://code.s4d.io/widget-space/latest/main.css">

<!-- Latest compiled and minified JavaScript -->
<script src="https://code.s4d.io/widget-space/latest/bundle.js"></script>

Build from Source

1. Follow these instructions to checkout and build the react-ciscospark repo https://github.com/webex/react-ciscospark/blob/master/README.md

2. To build the Space Widget, run the following from the root directory:

npm run build:package widget-space

Usage

Quick Start

If you would just like to get running immediately, follow these instructions to get a webpack-dev-server running with the widget.

1. Create a .env file in the root of the React project with the following lines, replacing the Xs with the appropriate value:

   CISCOSPARK_ACCESS_TOKEN=AN_ACCESS_TOKEN
   SPACE_ID=XXXXXXXXXXXXXXX
   TO_PERSON_EMAIL=XXXXX@XXXXXXXXX

2. From the root directory run: npm run start:package widget-space

Configuration

When loading the widgets there are some configuration options you can provide:

Authentication methods:

Name	Data API	Description
accessToken	data-access-token	Access token for the user account initiating the messaging session. For testing purposes you can use a developer access token from https://developer.ciscospark.com.
guestToken	data-guest-token	Guest Access token for the user account initiating the messaging session. A guest issuer application is required to generate a guest token. https://developer.ciscospark.com/guest-issuer.html. Currently in restricted access

Include only one of the following attributes:

Name	Data API	Description
spaceId	data-space-id	ID of the space you want to open.
toPersonEmail	data-to-person-email	Email of the message recipient
toPersonId	data-to-person-id	User Id of the message recipient

Optional configurations:

Name	Data API	Description
initialActivity	data-initial-activity	(default: message) Activity view to open with the widget. Available options: message: Message view meet: Meet view
startCall	data-start-call	(default: false) When present, widget will start in Meet view and initiate a call with the toPerson immediately.
logLevel	data-log-level	(default: silent) When present, widget will log debug information to console. This can be set to: error, warn, debug, info, trace, or silent

HTML

The easiest way to get the Spark Space Widget into your web site is to add the built resources and attach data attributes to your a container.

If you're using our CDN, skip to the next section.

• Copy the resources in the dist directory to own project.
• Add a <script /> tag to your page to include the bundle.js
• Add a <link /> tag to include main.css

Browser

Create an Express web application to serve the Space Widget. This is the preferred method to enable CORS.

If you're loading an HTML file directly in the browser, use Firefox or start Chrome with the --allow-file-access-from-files flag. This is not preferred because it introduces a security risk.

open -a "Google Chrome" --args --allow-file-access-from-files

Browser Globals

If you need additional behaviors or need to do additional work before the widget loads, it may be useful for to programmatically instatiate the widget after the intial page loads.

<div id="my-ciscospark-widget" />
<script>
  var widgetEl = document.getElementById('my-ciscospark-widget');
  // Init a new widget
  ciscospark.widget(widgetEl).spaceWidget({
    accessToken: 'AN_ACCESS_TOKEN',
    spaceId: 'XXXXXXXXXXXXXXX'
  });
</script>

my-ciscospark-widget is an arbitrary id to illustrate one way to select the DOM element. But please ensure that the widgetEl that you pass to ciscospark.widget() is a DOM element.

You can also attach to an existing widget. Currently this gives you access to events. Other functionality will be added in future releases.

var widgetEl = document.getElementById('ciscospark-widget-id');
var widgetObject = ciscospark.widget(widgetEl);

Widget Teardown

When a widget needs to be removed from the page you will want to call the .remove() method. This will close any network connections active and remove the widget from the DOM. You can also pass a callback as a parameter to the .remove() method. The method also returns a Promise that is thenable.

The returned value, removed, is true if a matching widget has been removed, and is false no widget was found.

// Basic remove
ciscospark.widget(widgetEl).remove();

// With callback
ciscospark.widget(widgetEl).remove(function(removed) {
  if (removed) {
    console.log('removed!');
  }
});

// With Promise
ciscospark.widget(widgetEl).remove().then(function(removed) {
  if (removed) {
    console.log('removed!');
  }
});

NOTE: If you are also using the Spark JS SDK on the same page, please be sure to load that before you load the widget scripts.

Data API

If you would like to embed with the widget without any additional behaviors into your page, use this data api. The div containing our data-toggle attribute must exist on the page before our javascript bundle loads.

Create a container where you would like to embed the widget and use the configuration options to load the widget. Be sure to include data-toggle="ciscospark-space".

<div
  class="ciscospark-widget"
  data-toggle="ciscospark-space"
  data-access-token="AN_ACCESS_TOKEN"
  data-space-id="XXXXXXXXXXXXXXX"
  />

JSX

Because our widgets are built using React, you'll be able to directly import the modules and components into your React app.

import SpaceWidget from '@ciscospark/widget-space';

ReactDOM.render(
  <SpaceWidget
    accessToken="AN_ACCESS_TOKEN"
    spaceId="XXXXXXXXXXX"
  />,
  document.getElementById('ELEMENT')
);

Events

The Space widget exposes a few events for hooking into widget functionality. You can directly add DOM event listener like this:

<div
  class="ciscospark-widget"
  data-toggle="ciscospark-space"
  data-access-token="AN_ACCESS_TOKEN"
  data-space-id="XXXXXXXXXXXXXXX"
  />
<script>
  document.getElementById('ciscospark-widget').addEventListener('EVENT_NAME', function(event) {
    // Handle the event here
    console.log(event.detail);
  });
</script>

If you are using browser globals, you can provide a callback parameter that will fire whenever any event occurs. You can filter the actions using the name provided like this:

var widgetEl = document.getElementById('my-ciscospark-widget');
// Init a new widget
ciscospark.widget(widgetEl).spaceWidget({
  accessToken: 'AN_ACCESS_TOKEN',
  spaceId: 'XXXXXXXXXXXXXXX',
  onEvent: callback
});

function callback(name, detail) {
  if (name === 'messages:created') {
    // Perform an action if a new message has been created
  }
}

Or you can use the ampersand-events API to listen to events like this:

var widgetEl = document.getElementById('ciscospark-widget');
ciscospark.widget(widgetEl).on('messages:created', function(e) {
  console.log(e.detail);
});

All available events are outlined in our events guide.

Browser Support

This widget has been tested on the following browsers for messaging and meeting:

• Current release of Chrome
• Current release of Firefox

More Examples

Cisco Spark Widgets Samples

Contribute

Please see CONTRIBUTING.md for more details.

License

© 2016 Cisco and/or its affiliates. All Rights Reserved.