Macro Definition

Last updated
Save as PDF

MacroDefinition is implemented as the MacroDefinition class. A MacroDefinition object provides basic information of a macro template for messaging. The attributes of MacroDefintion are:

Attribute	Description
assocRtnMac	An integer value stating the macro number of the associated return macro. (Only applies to forward macros.)
definitionStatus	A string of maximum length 4 containing the status of the macro definition. Status values are as follows: 0000 - Success PEND - Pending definition DLTD - Delete requested 1521 - Illegal macro definition 1522 - Macro definition is not permitted from this customer account 1523 - Macro definition failed due to mobile unit storage overflow 1524 - Macro definition failed because this macro cannot be altered 1525 - Macro definition failed due to illegal macro direction 1526 - Macro definition failed - unknown reason 1527 - Macro definition failed - unknown reason 1528 - Macro definition failed - unknown reason 1529 - Macro definition failed - unknown reason
description	A string of maximum length 30 containing the description of the macro.
direction	A string consisting of a single character that signifies the direction of the macro. "F" - Forward Macro "R" - Return Macro
macroItemList	An array of TMMWebServices Macro Item objects containing the label and dictionary field information for the macro template.
msgSupr	A boolean value indicating the message supression preference.
name	A string of maximum length 14 containing the name used to identify the macro.
number	An integer value stating the number of the macro.
routeCoverage	A boolean value indicating the route to a vehicle's coverage preference. (Only applies to return macros.)
rtnMacCoverage	A string of maximum length 10 indicating the user or address list coverage for a return macro. (Only applies to return macros.)
usage	An integer value indicating the usage count for a macro.
version	An integer value indicating the version number of the macro.