Difference between revisions of "TruxtonSubject"
| Line 29: | Line 29: | ||
A [https://en.wikipedia.org/wiki/Base64 base64] encoded 300x300 [https://en.wikipedia.org/wiki/Portable_Network_Graphics PNG] image of the subject. | A [https://en.wikipedia.org/wiki/Base64 base64] encoded 300x300 [https://en.wikipedia.org/wiki/Portable_Network_Graphics PNG] image of the subject. | ||
| − | ==<code>save() -> | + | ==<code>save() -> boolean</code>== |
This will commit the information to the <code>[Suspect]</code> table. | This will commit the information to the <code>[Suspect]</code> table. | ||
It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error. | It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error. | ||
| − | ==<code>tag(tag: str, reason: str, origin: int) -> | + | ==<code>tag(tag: str, reason: str, origin: int) -> boolean</code>== |
This creates a tag associated with this event in Truxton. | This creates a tag associated with this event in Truxton. | ||
The <code>tag</code> parameter is a short, one or two word, bit of text that will be displayed in the UI. | The <code>tag</code> parameter is a short, one or two word, bit of text that will be displayed in the UI. | ||
| Line 53: | Line 53: | ||
s.save() | s.save() | ||
s.tag("AUS", "Australia - Friendly Foreign Government", truxton.TAG_ORIGIN_HUMAN) | s.tag("AUS", "Australia - Friendly Foreign Government", truxton.TAG_ORIGIN_HUMAN) | ||
| − | return | + | return None |
def b64(filename): | def b64(filename): | ||
Revision as of 17:07, 16 September 2022
This class lets you add information about the subject of an investigation.
This will populate the [Suspect] table in the database.
Contents
Attributes and Methods
birthday: int
When the subject was born in FILETIME ticks.
This corresponds to the [DateOfBirth] column of the [Suspect] table.
custom: str
Free form notes about the subject.
These appear as "Remarks" in the desktop user interface.
This corresponds to the [Custom] column of the [Suspect] table.
description: str
A description of the subject, their title, etc.
This corresponds to the [Description] column of the [Suspect] table.
id: str
This is the GUID of the event.
Unlike most of the other identifiers in Truxton, this one can be optionally set.
If you have generated a well known GUID you can store it in id before calling save()
If id is all zeroes, a random value will be generated in the call to save().
name: str
The name of the subject.
This corresponds to the [Name] column of the [Suspect] table.
picture: str
A base64 encoded 300x300 PNG image of the subject.
save() -> boolean
This will commit the information to the [Suspect] table.
It will return True if the record was saved to the database, False if there was an error.
tag(tag: str, reason: str, origin: int) -> boolean
This creates a tag associated with this event in Truxton.
The tag parameter is a short, one or two word, bit of text that will be displayed in the UI.
The reason a sentence explaining why this subject was tagged.
The origin is either TAG_ORIGIN_AUTOMATIC (1) or TAG_ORIGIN_HUMAN (2).
It will return
True if the tag was associated with the file, False on failure.
Sample
def add_subject():
t = truxton.create()
s = t.newsubject()
s.id = "00138955-133D-D2C1-A9E9-ADFF27FA80F4"
s.name = "Alexander Downer"
s.description = "Australian High Commissioner to the United Kingdom."
s.birthday = ticks("1951-09-09T00:00:00-00:00")
s.picture = b64(SUPPORT_DOCUMENTS_FOLDER + "Images/Alexander Downer.png")
s.save()
s.tag("AUS", "Australia - Friendly Foreign Government", truxton.TAG_ORIGIN_HUMAN)
return None
def b64(filename):
with open( filename, "rb" ) as input_file:
data = input_file.read()
return str(base64.b64encode(data))[2:-1]
