2006-11-13 16:57:51 +00:00
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
2006-12-08 17:21:40 +00:00
|
|
|
<!-- $Revision: 1.3 $ -->
|
2006-11-13 16:57:51 +00:00
|
|
|
<refentry id='function.SAM-Message-constructor'>
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>SAMMessage::SAMMessage()</refname>
|
|
|
|
|
<refpurpose>
|
|
|
|
|
Creates a new Message object
|
|
|
|
|
</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
<refsect1 role="description">
|
|
|
|
|
&reftitle.description;
|
|
|
|
|
<classsynopsis>
|
|
|
|
|
<ooclass><classname>SAMMessage</classname></ooclass>
|
|
|
|
|
<constructorsynopsis>
|
|
|
|
|
<methodname>SAMMessage</methodname>
|
|
|
|
|
<methodparam choice='opt'><type>any</type><parameter>body</parameter></methodparam>
|
|
|
|
|
</constructorsynopsis>
|
|
|
|
|
</classsynopsis>
|
|
|
|
|
<para>
|
|
|
|
|
Creates a new <classname>SAMMessage</classname> object optionally specifying a message body.
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1 role="parameters">
|
|
|
|
|
&reftitle.parameters;
|
|
|
|
|
<para>
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><parameter>body</parameter></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
The optional body for the message.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
</variablelist>
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1 role="examples">
|
|
|
|
|
&reftitle.examples;
|
|
|
|
|
<para>
|
|
|
|
|
<example>
|
|
|
|
|
<title>Creating a message</title>
|
|
|
|
|
<programlisting role="php">
|
|
|
|
|
<![CDATA[
|
|
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
$msg = new SAMMessage();
|
|
|
|
|
|
|
|
|
|
?>
|
|
|
|
|
]]>
|
|
|
|
|
</programlisting>
|
|
|
|
|
</example>
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
<example>
|
|
|
|
|
<title>Creating a message with a simple text payload</title>
|
|
|
|
|
<programlisting role="php">
|
|
|
|
|
<![CDATA[
|
|
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
$msg = new SAMMessage('This is a simple text message');
|
|
|
|
|
|
|
|
|
|
?>
|
|
|
|
|
]]>
|
|
|
|
|
</programlisting>
|
|
|
|
|
</example>
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
</refentry>
|
|
|
|
|
|
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
|
|
|
Local variables:
|
|
|
|
|
mode: sgml
|
|
|
|
|
sgml-omittag:t
|
|
|
|
|
sgml-shorttag:t
|
|
|
|
|
sgml-minimize-attributes:nil
|
|
|
|
|
sgml-always-quote-attributes:t
|
|
|
|
|
sgml-indent-step:1
|
|
|
|
|
sgml-indent-data:t
|
|
|
|
|
indent-tabs-mode:nil
|
|
|
|
|
sgml-parent-document:nil
|
|
|
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
|
|
|
sgml-exposed-tags:nil
|
|
|
|
|
sgml-local-catalogs:nil
|
|
|
|
|
sgml-local-ecat-files:nil
|
|
|
|
|
End:
|
|
|
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
|
|
|
vim: et tw=78 syn=sgml
|
|
|
|
|
vi: ts=1 sw=1
|
|
|
|
|
-->
|
