User Tools

Site Tools


updateset_perspectium_api_message

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
updateset_perspectium_api_message [2016/05/13 13:54]
garrett
updateset_perspectium_api_message [2016/10/31 21:11] (current)
paul
Line 20: Line 20:
 |    //extra// (optional)|a value for the extra field of the message| |    //extra// (optional)|a value for the extra field of the message|
 |    //​attributes//​ (optional)|a value for the attributes field of the message| |    //​attributes//​ (optional)|a value for the attributes field of the message|
-|    //shareGR// (optional)|share configuration to associate with this message. This is useful if you want this message to show up in a dynamic or bulk share'​s related list of logs|  +|    //shareGR// (optional)|share configuration to associate with this message. This is useful if you want this message to show up in a dynamic or bulk share'​s related list of logs|  
-|    //​set_id// ​ (optional)|[[snc_message_set_activity|Message Set Activity]] set_id to send with this message in the attributes field|+|    //​set_id// ​ (optional)|[[snc_message_set_activity|Message Set Activity]] set_id to send with this message in the attributes field
 +|    //​state// ​ (optional)|a value for the state field of the message. If no value is passed, message will be created with a state of "​Ready"​ so it can be processed and sent to the Perspectium MBS server|
  
 Once initialized,​ you can reference the PerspectiumMessage functions (unless specified, functions are available in v3.6.0+): Once initialized,​ you can reference the PerspectiumMessage functions (unless specified, functions are available in v3.6.0+):
Line 37: Line 38:
 |setSetId(set_id)|sets the value of the message'​s set_id field with the set_id argument| |setSetId(set_id)|sets the value of the message'​s set_id field with the set_id argument|
 |setShareGr(shareGR)|sets the message'​s share configuration with the share configuration GlideRecord argument| |setShareGr(shareGR)|sets the message'​s share configuration with the share configuration GlideRecord argument|
 +|setState(state)|sets the value of the message'​s state field with the state argument|
 |appendAttribute(attrKey,​ attrVal)|appends an attribute to the message'​s attributes field in the format of attrKey=attrVal. For example, appendAttribute("​action",​ "​pause"​) will append "​action=pause"​ to the message'​s attributes| |appendAttribute(attrKey,​ attrVal)|appends an attribute to the message'​s attributes field in the format of attrKey=attrVal. For example, appendAttribute("​action",​ "​pause"​) will append "​action=pause"​ to the message'​s attributes|
  
updateset_perspectium_api_message.txt · Last modified: 2016/10/31 21:11 by paul