SyncMessage Class
=================

.. php:class:: SyncMessage

    Represents a synchronous message

    Implements :php:interface:`ItemInterface`

    .. php:method:: __construct(string $message, Participant $recipient, ?Participant $sender = null)

        Create a new SyncMessage

        :param string $message: The message
        :param Participant $recipient: The recipient
        :param ?Participant $sender: The sender (default: External sender)
        :returns: A new ``SyncMessage`` instance
        :rtype: SyncMessage

    .. php:method:: addParameter(string ...$parameter)

        Add message parameter(s)

        :param string ...$parameter: Message parameter(s)
        :returns: A new SyncMessage instance with the added parameter(s)
        :rtype: SyncMessage

    .. php:method:: withComment(string $comment)

        Set a comment for the SyncMessage

        :param string $comment: The comment
        :returns: A new instance of ``SyncMessage`` with the comment
        :rtype: SyncMessage

    .. php:method:: withParameter(string ...$parameter)

        Set message parameter(s)

        :param string ...$parameter: Message parameter(s)
        :returns: A new SyncMessage instance with the parameter(s)
        :rtype: SyncMessage

    .. php:method:: withReturn(string $value, ?string $type = null)

        Set message return value

        :param string $value: The return value
        :param ?string $type: The return type (default: return type not defined)
        :returns: A new SyncMessage instance with a return message
        :rtype: SyncMessage