TruxtonSubject - Revision history

Sam at 22:53, 2 May 2023

2023-05-02T22:53:16Z

Sam at 11:47, 1 October 2022

2022-10-01T11:47:16Z

Sam at 21:07, 16 September 2022

2022-09-16T21:07:28Z

Sam: /* picture */

2022-07-29T15:47:20Z

picture

Sam at 15:46, 29 July 2022

2022-07-29T15:46:21Z

Sam: /* tag(tag, reason, origin) */

2021-05-29T21:05:43Z

tag(tag, reason, origin)

Sam: /* save() */

2021-03-05T14:52:55Z

save()

Sam at 11:23, 8 December 2020

2020-12-08T11:23:52Z

Sam at 21:13, 30 November 2020

2020-11-30T21:13:05Z

Sam: /* Sample */

2020-07-08T18:40:35Z

Sample

@@ Line 10: / Line 10: @@
 The note is stored in the <code>[InvestigatorNote]</code> table in the database.
-==<code>birthday: int</code>==
+==<code>birthday: [https://docs.python.org/3/library/datetime.html datetime]</code>==
-When the subject was born in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
+When the subject was born.
 This corresponds to the <code>[DateOfBirth]</code> column of the <code>[Suspect]</code> table.

@@ Line 3: / Line 3: @@
 =Attributes and Methods=
 ==<code>birthday: int</code>==
 When the subject was born in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
@@ Line 16: / Line 23: @@
 This corresponds to the <code>[Description]</code> column of the <code>[Suspect]</code> table.
-==<code>id: str</code>==
+==<code>id: object</code>==
-This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the event.
+This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the subject.
 Unlike most of the other identifiers in Truxton, this one can be optionally set.
 If you have generated a well known [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] you can store it in <code>id</code> before calling <code>save()</code>

@@ 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.
-==<code>save() -> bool</code>==
+==<code>save() -> boolean</code>==
 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.
-==<code>tag(tag: str, reason: str, origin: int) -> bool</code>==
+==<code>tag(tag: str, reason: str, origin: int) -> boolean</code>==
 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.
@@ Line 53: / Line 53: @@
    s.save()
    s.tag("AUS", "Australia - Friendly Foreign Government", truxton.TAG_ORIGIN_HUMAN)
-   return
+   return None
 def b64(filename):

@@ Line 26: / Line 26: @@
 This corresponds to the <code>[Name]</code> column of the <code>[Suspect]</code> table.
-==<code>picture</code>==
+==<code>picture: str</code>==
 A [https://en.wikipedia.org/wiki/Base64 base64] encoded 300x300 [https://en.wikipedia.org/wiki/Portable_Network_Graphics PNG] image of the subject.

@@ Line 3: / Line 3: @@
 =Attributes and Methods=
-==<code>birthday</code>==
+==<code>birthday: int</code>==
 When the subject was born in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
 This corresponds to the <code>[DateOfBirth]</code> column of the <code>[Suspect]</code> table.
-==<code>custom</code>==
+==<code>custom: str</code>==
 Free form notes about the subject.
 These appear as "Remarks" in the desktop user interface.
 This corresponds to the <code>[Custom]</code> column of the <code>[Suspect]</code> table.
-==<code>description</code>==
+==<code>description: str</code>==
 A description of the subject, their title, etc.
 This corresponds to the <code>[Description]</code> column of the <code>[Suspect]</code> table.
-==<code>id</code>==
+==<code>id: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the event.
 Unlike most of the other identifiers in Truxton, this one can be optionally set.
@@ Line 22: / Line 22: @@
 If <code>id</code> is all zeroes, a random value will be generated in the call to <code>save()</code>.
-==<code>name</code>==
+==<code>name: str</code>==
 The name of the subject.
 This corresponds to the <code>[Name]</code> column of the <code>[Suspect]</code> table.
@@ 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.
-==<code>save()</code>==
+==<code>save() -> bool</code>==
 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.
-==<code>tag(tag, reason, origin)</code>==
+==<code>tag(tag: str, reason: str, origin: int) -> bool</code>==
 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.

@@ Line 36: / Line 36: @@
 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>reason</code> a sentence explaining why this event was tagged.
+The <code>reason</code> a sentence explaining why this subject was tagged.
 The <code>origin</code> is either <code>TAG_ORIGIN_AUTOMATIC</code> (1) or <code>TAG_ORIGIN_HUMAN</code> (2).
 It will return

@@ Line 1: / Line 1: @@
 This class lets you add information about the subject of an investigation.
-This will populate the <code>Suspect</code> table in the database.
+This will populate the <code>[Suspect]</code> table in the database.
 =Attributes and Methods=

@@ Line 42: / Line 42: @@
 =Sample=
-<syntaxhighlight lang="Python" highlight="3-9">
+<syntaxhighlight lang="Python" highlight="3-10">
 def add_subject():
    t = truxton.create()