Announcements Protocol

Last Modified: August 10, 2004

An announcement is the same message sent to multiple recipients. In Gush, Announcements are sent to all the people for a given group.

To send an announcement via Jabber to a Gush client, the following is required.

The message stanza type must be "normal".
An 'x' element using the Announcements namespace must be used.

The namespace for Announcements is:

  https://2entwine.com/protocol/gush-announce-1_0

The Announcements 'x' element requires a single 'id' child element. 'id' should be a unique opaque identifier of that Announcement. Gush takes a sha1 digest of the date-time, subject, and text to from the ID.

Example Announcement message:

<message from='/Work' 
         id='7bdc3531' 
         type='normal' 
         to=''>
   <subject>Announcement Subject</subject>
   <body>This is a test announcement.</body>
   <html xmlns='http://jabber.org/protocol/xhtml-im'>
     <body xmlns='http://www.w3.org/1999/xhtml'>
       <span style='font-size:11px;color:#333333;font-family:verdana;text-align:left'>
         This is a <span style='font-weight:bold'>test</span> announcement.</span>
     </body>
   </html>
   <x xmlns='https://2entwine.com/protocol/gush-announce-1_0'>
     <id>31549c15602dfd61bc27bc256eaf1bf3fdf9840b</id>
   </x>
</message>

Gush implementation caveats:

The ID is currently ignored, but we're planning on using the ID to allow users to edit announcements.
Gush currently excepts only the XHTML body for the message text. This is a bug and will be fixed for the next release.