• Sending a Message
• Specify Recipients
• Specify a Title
• Specify Body Text

opensocial-0.8 is required for datatype="data" in jQuery.ajax

<ModulePrefs title="opensocial-jquery">
<Require feature="opensocial-0.8" />
</ModulePrefs>

Sending a Message

jQuery.ajax can be used to send a Message from the VIEWER

  $.ajax({
    type: 'post',
    url: '/messages/@viewer/@outbox',
    data: {
      recipients: '@owner',
      title: 'Say hello!',
      body: 'You should be shining!'
    },
    dataType: 'data',
    success: function(data, status) {},
    error: function(xhr, status, e) {
      console.log('error', xhr, status, e);
    }
  });

This can also be done using jQuery.post

  $.post(
    '/messages/@viewer/@outbox', {
      recipients: '@owner',
      title: 'Say hello!',
      body: 'You should be shining!'
    },
    function() {},
    'data'
  });

The same can be done using jQuery.postData

  $.postData (
    '/messages/@viewer/@outbox', {
      recipients: '@owner',
      title: 'Say hello!',
      body: 'You should be shining!'
    },
    function() {}
  });

Specify Recipients

The recipients' parameter can be used to specify recipients. Specify one from @viewer, @owner, @viewer/@friends, @owner/@friends, or your User ID.

  $.ajax({
    type: 'post',
    url: '/messages/@viewer/@outbox',
    data: { recipients: '@viewer/@friends' },
    dataType: 'data',
    success: function(data, status) {},
    error: function(xhr, status, e) {
      console.log('error', xhr, status, e);
    }
  });

Specify a Title

The title parameter can be used to specify a title.

  $.ajax({
    type: 'post',
    url: '/messages/@viewer/@outbox',
    data: { title: 'Say hello!' },
    dataType: 'data',
    success: function(data, status) {},
    error: function(xhr, status, e) {
      console.log('error', xhr, status, e);
    }
  });

Furthermore, titleId can be used to specify a template ID for a title

  $.ajax({
    type: 'post',
    url: '/messages/@viewer/@outbox',
    data: { titleId: 'TEMPLATE_ID' },
    dataType: 'data',
    success: function(data, status) {},
    error: function(xhr, status, e) {
      console.log('error', xhr, status, e);
    }
  });

Specify Body Text

The body parameters can be used to specify the body text.

  $.ajax({
    type: 'post',
    url: '/messages/@viewer/@outbox',
    data: { body: 'Say hello!' },
    dataType: 'data',
    success: function(data, status) {},
    error: function(xhr, status, e) {
      console.log('error', xhr, status, e);
    }
  });

Moreover, bodyId can be used to specify the template ID for the body text.

  $.ajax({
    type: 'post',
    url: '/messages/@viewer/@outbox',
    data: { bodyId: 'TEMPLATE_ID' },
    dataType: 'data',
    success: function(data, status) {},
    error: function(xhr, status, e) {
      console.log('error', xhr, status, e);
    }
  });