PLC/Methods/DeleteMessage.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.Messages import Message, Messages
   5 from PLC.Auth import Auth
   6
   7 class DeleteMessage(Method):
   8     """
   9     Deletes a message template.
  10
  11     Returns 1 if successful, faults otherwise.
  12     """
  13
  14     roles = ['admin']
  15
  16     accepts = [
  17         Auth(),
  18         Message.fields['message_id'],
  19         ]
  20
  21     returns = Parameter(int, '1 if successful')
  22
  23
  24     def call(self, auth, message_id):
  25         # Get message information
  26         messages = Messages(self.api, [message_id])
  27         if not messages:
  28             raise PLCInvalidArgument, "No such message"
  29         message = messages[0]
  30
  31         message.delete()
  32         self.object_ids = [message['message_id']]
  33
  34         return 1