PLC/Methods/AddMessage.py

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