PLC/Methods/DeleteMessage.py

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