socialize:messaging

v1.1.0Published 6 years ago

This package has not had recent updates. Please investigate it's current state before committing to using it in your project.

Messaging

Provides social network style messaging between users.

Supporting the Project

In the spirit of keeping this and all of the packages in the Socialize set alive, I ask that if you find this package useful, please donate to it's development.

Litecoin: LXLBD9sC5dV79eQkwj7tFusUHvJA5nhuD3 / Patreon / Paypal

Features

  • Multi User Conversations
  • Read Status - has the participating user viewed the conversation since the last message was sent.
  • Typing Status - Is the participating user typing.
  • Observing Status - Is the participating user viewing the conversation.
  • Flight Status - Has the message reached the server and been saved to the database yet.

Installation

This package relies on the npm package simpl-schema so you will need to make sure it is installed as well.

$ meteor npm install --save simpl-schema
$ meteor add socialize:messaging

Basic Usage

1import { Conversation } from 'meteor/socialize:messaging';
2
3let convo = new Conversation.save();
4
5let otherUser = Meteor.users.findOne();
6
7convo.addParticipant(otherUser);
8
9convo.sendMessage("Hey, What's up?")

For a more in depth explanation of how to use this package see API.md

Scalability - Redis Oplog

This package contains a preliminary implementation of cultofcoders:redis-oplog's namespaces to provide reactive scalability as an alternative to Meteor's livedata. Use of redis-oplog is not required and will not engage until you install the cultofcoders:redis-oplog package and configure it.

Due to the preliminary nature of this implementation, you may run into minor issues. Please report any issues you find to GitHub so that they can be fixed.