TruxtonArtifact - Revision history

Sam: /* Sample */

2024-01-27T19:06:30Z

Sample

Sam: /* addnote(text: str) -> boolean */

2022-10-01T11:12:11Z

addnote(text: str) -> boolean

Sam at 08:52, 30 September 2022

2022-09-30T08:52:32Z

Sam: /* Sample */

2022-09-17T11:47:32Z

Sample

Sam at 09:00, 14 September 2022

2022-09-14T09:00:13Z

Sam at 09:48, 29 July 2022

2022-07-29T09:48:38Z

Sam: /* Sample */

2021-02-09T14:47:13Z

Sample

Sam at 21:50, 24 November 2020

2020-11-24T21:50:29Z

Sam: /* Sample */

2020-06-02T13:34:02Z

Sample

Sam: /* Sample */

2020-06-02T13:33:37Z

Sample

@@ Line 140: / Line 140: @@
 if __name__ == "__main__":
-   main()
+   sys.exit(main())
 </source>

@@ Line 54: / Line 54: @@
 The <code>text</code> parameter is the contents of the note.
 It will return
-[https://docs.python.org/3.8/library/constants.html?highlight=false#True True] if the tag was associated with the artifact, [https://docs.python.org/3.8/library/constants.html?highlight=false#False False] on failure.
+[https://docs.python.org/3.10/library/constants.html?highlight=false#True True] if the tag was associated with the artifact, [https://docs.python.org/3.10/library/constants.html?highlight=false#False False] on failure.
 ==<code>tag(tag: str, reason: str, origin: int) -> boolean</code>==

@@ Line 50: / Line 50: @@
 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) -> boolean</code>==
+==<code>addnote(text: str) -> boolean</code>==
 This creates a tag associated with this artifact 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 60: / Line 66: @@
 =Sample=
 Sample Code
-<source lang="Python" highlight="50-55">
+<source lang="Python" highlight="50-55,57">
 import sys
 sys.path.append('C:/Program Files/Truxton/SDK')
@@ Line 116: / Line 122: @@
    artifact.length = 9
    artifact.save()
    return None

@@ Line 60: / Line 60: @@
 =Sample=
 Sample Code
-<source lang="Python" highlight="49-54">
+<source lang="Python" highlight="50-55">
 import sys
 sys.path.append('C:/Program Files/Truxton/SDK')
@@ Line 81: / Line 81: @@
    event_type.name = name
    event_type.save()
 def add_file(parent_truxton_file, filename):
@@ Line 115: / Line 116: @@
    artifact.length = 9
    artifact.save()
 def main():
@@ Line 125: / Line 128: @@
    add_ec(root_file)
 if __name__ == "__main__":
    main()
 </source>

@@ Line 46: / Line 46: @@
 This corresponds to the <code>[Value]</code> column of the <code>[EntityString]</code> table.
-==<code>save() -> bool</code>==
+==<code>save() -> boolean</code>==
 This will commit the information to the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></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) -> bool</code>==
+==<code>tag(tag, reason, origin) -> boolean</code>==
 This creates a tag associated with this artifact 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 2: / Line 2: @@
 =Attributes and Methods=
-==<code>datatype</code>==
+==<code>datatype: int</code>==
-The raw [[DATA_TYPE | data type]] of the representation of the entity.
+The raw [[DATA_TYPE|data type]] of the representation of the entity.
 This corresponds to the <code>[DataTypeID]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
-==<code>fileid</code>==
+==<code>fileid: str</code>==
 The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this artifact came from.
 This corresponds to the <code>[FileID]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
-==<code>id</code>==
+==<code>id: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the record.
 It becomes non-zero after <code>save()</code> has been called.
 This corresponds to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
-==<code>length</code>==
+==<code>length: int</code>==
 The number of bytes in the raw representation of the artifact.
 This corresponds to the <code>[Length]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
-==<code>mediaid</code>==
+==<code>mediaid: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the media this artifact came from.
 This corresponds to the <code>[MediaID]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
-==<code>objectid</code>==
+==<code>objectid: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the object this artifact came from.
 This combined with <code>objecttype</code> allows Truxton to track derivative entities such as a search term coming from a URL found in a browser cache.
 In this example, <code>fileid</code> would point to the browser cache <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> record and <code>objectid</code> would point to the record in the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table.
-==<code>objecttype</code>==
+==<code>objecttype: int</code>==
 The type of the object.
 This corresponds to the <code>[ObjectTypeID]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
 It should contain one of the [[Object Types|predefined constants]].
-==<code>offset</code>==
+==<code>offset: int</code>==
 The offset from the beginning of the file where this artifact begins.
-==<code>type</code>==
+==<code>type: int</code>==
 The type of the artifact is.
 This corresponds to the <code>[EntityTypeID]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
@@ Line 42: / Line 42: @@
 You can also use a [[Entity Types|predefined constant.]]
-==<code>value</code>==
+==<code>value: str</code>==
 The string representation of the artifact.
 This corresponds to the <code>[Value]</code> column of the <code>[EntityString]</code> table.
-==<code>save()</code>==
+==<code>save() -> bool</code>==
 This will commit the information to the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></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, reason, origin) -> bool</code>==
 This creates a tag associated with this artifact 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 58: / Line 58: @@
 =Sample=
 Sample Code
 <syntaxhighlight lang="Python" highlight="47-52">
 import truxton
@@ Line 128: / Line 126: @@
    main()
 </syntaxhighlight>