Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.54 KB

README.md

File metadata and controls

43 lines (32 loc) · 1.54 KB
Raw

LayerMessaging

This is a Javascript library to interface with Layer.com's client API from the browser. As of right now there's no official way to use Layer.com's messaging in webapps, this offers the beginning of a way to do that. Currently supports the following:

  • Listing conversations
  • Creating a conversation
  • Retrieving a conversation
  • Retrieving a list of messages
  • Adding a message to an existing conversation

Requirements

You need to have setup an identity service provider as specified in this guide. It's not as difficult as it looks, Layer provides sample implementations for most back-end languages.

Setup

Just include it on your site with <script src="/path/to/layer-messaging.js"></script>

Usage

Here's quick example usage, will add more soon. Check out the code if you want to see how to use the functions mentioned above. First, setup:

LayerMessaging.init(YOUR_LAYER_APP_KEY, YOUR_IDENTITY_PROVIDER_URL);

Then, create a conversation:

LayerMessaging.createConversation(profile_id, message, function(conversation_data) {
  if (!conversation_data.id) {
    console.log('Couldn\'t send message');
    return;
  }

  console.log('Layer UUID for created conversation is ' + conversation_data.id);

  // Here you would follow up with adding message to conversation,
  // updating view, resetting input field, viewIf message wasn't successfully
});

TODO

  • Add support for WebSocket API
  • Add RequireJS define
  • Add to bower registry