Message Class
=============

.. php:class:: Message

    Represents a message

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

        Create a new Message instance

        :param Participant $sender: Message sender
        :param string $message: The message
        :param Arrow $arrow: The message arrow
        :param ?Participant $recipient: Message recipient (default: Recipient to be set using withRecipient())
        :param ?Activation $activation: Whether to activate the recipient or deactivate the sender (default: no action)
        :returns: A new ``Message`` instance
        :rtype: Message

    .. php:method:: destroy(Destroy $destroy)

        Destroy the sender or recipient of the message

        :param Destroy $destroy: Whether to destroy the recipient or the sender
        :returns: A new ``Message`` instance that will destroy the recipient or the sender
        :rtype: Message

    .. php:method:: withRecipient(Participant $recipient)

        Create the message recipient

        .. note::

            The message *must* have a recipient set either in the constructor or this method

        :param Participant $recipient: The recipient to create
        :returns: A new ``Message`` instance that will create the recipient
        :rtype: Message