Meteor Community Logo

Meteor Community

Packosphere

undefined's Avatar

socialize:messaging

v1.2.1•Published 4 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.

This is a Meteor package with part of it's code published as a companion NPM package made to work with React Native. This allows your Meteor and React Native projects that use this package to share code between them to give you a competitive advantage when bringing your mobile and web application to market.

Supporting The Project

Finding the time to maintain FOSS projects can be quite difficult. I am myself responsible for over 30 personal projects across 2 platforms, as well as Multiple others maintained by the Meteor Community Packages organization. Therfore, if you appreciate my work, I ask that you either sponsor my work through GitHub, or donate via Paypal or Patreon. Every dollar helps give cause for spending my free time fielding issues, feature requests, pull requests and releasing updates. Info can be found in the "Sponsor this project" section of the GitHub Repo

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.

Meteor 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

React Native Installation

When using this package with React Native, the dependency tree ensures that simpl-schema is loaded so there's no need to install it as when using within Meteor.

npm install --save @socialize/messaging

Note

When using with React Native, you'll need to connect to a server which hosts the server side Meteor code for your app using Meteor.connect as per the @socialize/react-native-meteor documentation.

Basic Usage

Depending on the environment your code will be running in, you'll need to import the classes from the packages specific to that environment, either Meteor or React Native.

1// Meteor Imports
2import { Meteor } from 'meteor/meteor';
3import { Conversation } from 'meteor/socialize:messaging';
1// React Native Imports
2import Meteor from '@socialize/react-native-meteor';
3import { Conversation } from '@socialize/messaging';

Once we have the appropriate packages imported, the rest of the code will run in either environment.

1let convo = new Conversation.save();
2
3let otherUser = Meteor.users.findOne();
4
5convo.addParticipant(otherUser);
6
7convo.sendMessage("Hey, What's up?")

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

Scalability - Redis Oplog

This implements 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.