Notify Helper

Vous trouverez une fonction-helper notify basée sur le service de websockets, qui vous permettra d'envoyer facilement des notifications à des utilisateurs ou à des équipes.

Exemple

User = require '../models/user'
notify = require '../websockets/notify'

User.findById(1).then (user) ->
    return unless user
    notify user, 'An energy source has been checked', checkedBy: 'another_user'

API

Un require '../websockets/notify' vous renvoie une fonction, que vous n'avez plus qu'à appeler à volonté. Nous l'appelons ici notify.

notify(receiver, message, options={})

• receiver : un modèle Sequelize instancié, de type user ou team.
• message : le message texte de la notification
• options : des données additionnelles sous forme d'objet qui seront aussi envoyées au client

À noter donc que le comportement change en fonction du receiver :

• Quand receiver est une team, la méthode du service WebSockets utilisée est sendToTeam.

• Quand receiver est un user, la méthode du service WebSockets utilisée est sendToUser.

• Quand receiver est un user et que options comprend une clé teamify positionnée à true, alors tous les membres de l'équipe de receiver recevront la notification. La méthode du service WebSockets utilisée est sendToUser.

  Exemple :

  User.findById(1).then (user) ->
      return unless user
      notify user, 'A message that the team can see', teamify: yes, additionalData: 'other_data'
      # "yes" and "on" are CoffeeScript aliases for "true"