Previous topic

stalker.core.models.Link

Next topic

stalker.core.models.Note

This Page

stalker.core.models.Message

Inheritance diagram of stalker.core.models.Message

class stalker.core.models.Message(**kwargs)[source]

Bases: stalker.core.models.Entity, stalker.core.models.StatusMixin

The base of the messaging system in Stalker

Messages are one of the ways to collaborate in Stalker. The model of the messages is taken from the e-mail system. So it is pretty similiar to an e-mail message.

Parameters:
  • from – the User object sending the message
  • to – the list of Users to receive this message
  • subject – the subject of the message
  • body – the body of the message
  • in_reply_to – the Message object which this message is a reply to.
  • replies – the list of Message objects which are the direct replies of this message
  • attachments – a list of SimpleEntity objects attached to this message (so anything can be attached to a message)
__init__(**kwargs)[source]

Methods

__init__(**kwargs)

Attributes

code The code name of this object.
created_by The User who has created this object.
created_by_id
date_created A datetime.datetime instance showing the creation date and time of this object.
date_updated A datetime.datetime instance showing the update date and time of this object.
description Description of this object.
entity_id
entity_type
id
message_id
name Name of this object
nice_name Nice name of this object.
notes All the Notess attached to this entity.
reviews All the Reviews about this Entity.
status
status_list
status_list_id
tags A list of tags attached to this object.
type The type of the object.
type_id
updated_by The User who has updated this object.
updated_by_id
code

The code name of this object.

It accepts string or unicode values and any other kind of objects will be converted to string. In any update to the name attribute the code also will be updated. If the code is not initialized or given as None, it will be set to the uppercase version of the nice_name attribute. Setting the code attribute to None will reset it to the default value. The default value is the upper case form of the nice_name.

created_by

The User who has created this object.

date_created

A datetime.datetime instance showing the creation date and time of this object.

date_updated

A datetime.datetime instance showing the update date and time of this object.

description

Description of this object.

name

Name of this object

nice_name

Nice name of this object.

It has the same value with the name (contextually) but with a different format like, all the white spaces replaced by underscores (“_”), all the CamelCase form will be expanded by underscore (_) characters and it is always lower case.

There is also the code attribute which is simply the upper case form of nice_name if it is not defined differently (i.e set to another value).

notes

All the Notess attached to this entity.

It is a list of Note instances or an empty list, setting it None will raise a TypeError.

reviews

All the Reviews about this Entity.

It is a list of Review instances or an empty list, setting it None will raise a TypeError.

tags

A list of tags attached to this object.

It is a list of Tag instances which shows the tags of this object

type

The type of the object.

It is an instance of Type with a proper target_entity_type.

updated_by

The User who has updated this object.