PLC/Methods/AddMessage.py

   1 # $Id$
   2 # $URL$
   3 from PLC.Faults import *
   4 from PLC.Method import Method
   5 from PLC.Parameter import Parameter
   6 from PLC.Messages import Message, Messages
   7 from PLC.Auth import Auth
   8
   9 class AddMessage(Method):
  10     """
  11     Adds a new message template. Any values specified in
  12     message_fields are used, otherwise defaults are used.
  13
  14     Returns 1 if successful, faults otherwise.
  15     """
  16
  17     roles = ['admin']
  18
  19     accepts = [
  20         Auth(),
  21         Message.fields,
  22         ]
  23
  24     returns = Parameter(int, '1 if successful')
  25
  26
  27     def call(self, auth, message_fields):
  28         message = Message(self.api, message_fields)
  29         message.sync(insert = True)
  30
  31         return 1