Add docstrings to globalmessages data interface
This commit is contained in:
parent
4ca6c37e54
commit
0d239e08c2
3 changed files with 34 additions and 8 deletions
|
@ -23,17 +23,32 @@ class GlobalMessage(
|
|||
|
||||
@add_metaclass(ABCMeta)
|
||||
class GlobalMessageDataInterface(object):
|
||||
"""
|
||||
Data interface for globalmessages API
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def get_all_messages(self):
|
||||
pass
|
||||
"""
|
||||
|
||||
Returns:
|
||||
list(GlobalMessage)
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def create_message(self):
|
||||
pass
|
||||
def create_message(self, severity, media_type_name, content):
|
||||
"""
|
||||
|
||||
Returns:
|
||||
GlobalMessage or None
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def delete_message(self):
|
||||
pass
|
||||
def delete_message(self, uuid):
|
||||
"""
|
||||
|
||||
Returns:
|
||||
void
|
||||
"""
|
||||
|
||||
|
Reference in a new issue