Name
queued warning, queuedwarning, kPMQueuedWarning — Host wide warning.
Synopsis
queued warning structure { date, action ID, action, event, message, context };
date : date |
action ID : string, default, length 1..255 |
action : action structure, optional
|
event : event structure
|
message : string, optional |
context : dictionary, optional |
Description
Host wide warning.
queued warning describes an imminent action that will affect the host and all active users.
queued warning is generated by an action warning within an event's actions.
Fields
date. date the action will perform.
date will be a few seconds away. Interested clients should respond quickly the new queued warning instances.
date is a date.
action ID. Unique ID for this warning.
action ID is a string. If action ID is omitted, a default is created. action ID must be between 1 and 255 characters long, inclusive.
action. Action that will be performed.
Warning clients should use action as the basis of any user facing message. message and context are provided by the event's creator and may not be accurate.
If action is missing, the action warning that generated this instance is the final action in the event's actions.
action is a action structure. action is optional.
event. event containing this action warning.
event is a event structure.
message. Warning message.
message is a string. message is optional.
context. Additional context for warning clients.
context is a dictionary. context is optional.