This method represents the BACnet services ConfirmedTextMessage and UnconfirmedTextMessage.

The UnconfirmedTextMessage service is used by a client BACnet-user to send a text message to one or more BACnet devices. This service may be broadcast, multicast, or addressed to a single recipient. This service may be used in cases where confirmation that the text message was received is not required. Messages may be prioritized into normal or urgent categories. In addition, a given text message may optionally be classified by a numeric class code or class identification string. This classification may be used by receiving BACnet devices to determine how to handle the text message. For example, the message class might indicate a particular output device on which to print text or a set of actions to take when the text message is received. In any case, the interpretation of the class is a local matter.

The ConfirmedTextMessage service is used by a client BACnet-user to send a text message to another BACnet device. This service is not a broadcast or multicast service. This service may be used in cases when confirmation that the text message was received is required. The confirmation does not guarantee that a human operator has seen the message. Messages may be prioritized into normal or urgent categories. In addition, a given text message may be optionally classified by a numeric class code or class identification string. This classification may be used by the receiving BACnet device to determine how to handle the text message. For example, the message class might indicate a particular output device on which to print text or a set of actions to take when the text is received. In any case, the interpretation of the class is a local matter.

Signature

TextMessage (

[in]0:Boolean SendUnconfirmed

[in]BACnetObjectIdentifier TextMessageSourceDevice

[in]BACnetMessageClass MessageClass

[in]BACnetMessagePriority MessagePriority

[in]0:String Message

);

Argument	Description
SendUnconfirmed	Flag indicating if the BACnet service UnconfirmedTextMessage (TRUE) or ConfirmedTextMessage (FALSE) is used.
TextMessageSourceDevice	This parameter, of type BACnetObjectIdentifier, shall convey the value of the Object_Identifier property of the Device object of the device that initiated this text message.
MessageClass	This parameter, if present, shall indicate the classification of the received message. The datatype of this parameter shall be a choice of Unsigned or CharacterString. The interpretation of the meaning of any particular value for this parameter shall be a local matter.
MessagePriority	This parameter, of type ENUMERATED, shall indicate the priority for message handling: {NORMAL, URGENT}
Message	This parameter, of type CharacterString, shall be used to convey the text message.

Method Result Codes

ResultCode	Description
BadUserAccessDenied	This status is returned for the BACnet error code PASSWORD_FAILURE
BadNotSupported	This status is returned for the BACnet error code O_FUNCTIONALITY_NOT_SUPPORTED