Core data structure in the Zeitgeist framework. It is an optimized and convenient representation of an event.
This class is designed so that you can pass it directly over DBus using the Python DBus bindings. It will automagically be marshalled with the signature a(asaasay). See also the section on the event serialization format.
This class does integer based lookups everywhere and can wrap any conformant data structure without the need for marshalling back and forth between DBus wire format. These two properties makes it highly efficient and is recommended for use everywhere.
Read/write property defining the application or entity responsible for emitting the event. For applications, the format of this field is the base filename of the corresponding .desktop file with an application:// URI scheme. For example, /usr/share/applications/firefox.desktop is encoded as application://firefox.desktop
Append a new empty Subject and return a reference to it
Read only property containing the the event id if the event has one
Read/write property defining the interpretation type of the event
Read/write property defining the manifestation type of the event
Interpret self as the template an match event against it. This method is the dual method of matches_template().
Return True if this event matches event_template. The matching is done where unset fields in the template is interpreted as wild cards. Interpretations and manifestations are also matched if they are children of the types specified in event_template. If the template has more than one subject, this event matches if at least one of the subjects on this event matches any single one of the subjects on the template.
Basically this method mimics the matching behaviour found in the FindEventIds() method on the Zeitgeist engine.
Create a new Event setting event_data as the backing array behind the event metadata. The contents of the array must contain the event metadata at the positions defined by the Event.Fields enumeration.
Returns a new Event instance or None if struct is a NULL_EVENT
Create a new Event instance from a collection of keyword arguments.
| Parameters: |
|
|---|
Instead of setting the subjects argument one may use a more convenient approach for events that have exactly one Subject. Namely by using the subject_* keys - mapping directly to their counterparts in Subject.new_for_values():
| Parameters: |
|
|---|
Read/write property defining the origin where the event was emitted.
Free form attachment for the event. Transfered over DBus as an array of bytes
Read/write property with the event timestamp defined as milliseconds since the Epoch. By default it is set to the moment of instance creation
Represents a subject of an Event. This class is both used to represent actual subjects, but also create subject templates to match other subjects against.
Applications should normally use the method new_for_values() to create new subjects.
Read/write property with the current URI of the subject encoded as a string
Read/write property defining the interpretation type of the subject
Read/write property defining the manifestation type of the subject
Return True if this Subject matches subject_template. Empty fields in the template are treated as wildcards. Interpretations and manifestations are also matched if they are children of the types specified in subject_template.
See also Event.matches_template()
Read/write property containing the mimetype of the subject (encoded as a string) if applicable
Create a new Subject instance and set its properties according to the keyword arguments passed to this method.
| Parameters: |
|
|---|
Read/write property with the URI of the location where the subject can be found. For files this is the parent directory, or for downloaded files it would be the URL of the page where you clicked the download link
Read/write property with a string id of the storage medium where the subject is stored. Fx. the UUID of the disk partition or just the string ‘net’ for items requiring network interface to be available
Read/write property with a free form textual annotation of the subject
Read/write property with the URI of the subject encoded as a string
A collection of Symbol objects which represents the interpretations defined by the zeitgeist ontology. For more information see Interpretations.
A collection of Symbol objects which represents the manifestations defined by the zeitgeist ontology. For more information see Manifestations.
A class that represents a time range with a beginning and an end. The timestamps used are integers representing milliseconds since the Epoch.
By design this class will be automatically transformed to the DBus type (xx).
The begining timestamp of this time range
The end timestamp of this time range
Return a TimeRange ranging from “sec” seconds before the instant of invocation to the same.
Return a TimeRange ranging from the given timestamp until the end of time.
The given timestamp is expected to be expressed in miliseconds.
Return a new TimeRange that is the intersection of the two time range intervals. If the intersection is empty this method returns None.
Returns True if this time range goes from timestamp 0 (January 1, 1970) -or lower- to the most distant future.
An enumeration class used to define how query results should be returned from the Zeitgeist engine.
All events with the most recent events first. (Integer value: 0)
All events with the oldest ones first. (Integer value: 1)
One event for each subject only, ordered with the most recent events first. (Integer value: 2)
One event for each subject only, ordered with oldest events first. (Integer value: 3)
One event for each subject only, ordered by the popularity of the subject. (Integer value: 4)
One event for each subject only, ordered ascendingly by popularity of the subject. (Integer value: 5)
The last event of each different actor,ordered by the popularity of the actor. (Integer value: 6)
The last event of each different actor,ordered ascendingly by the popularity of the actor. (Integer value: 7)
The Actor that has been used to most recently. (Integer value: 8)
The Actor that has been used to least recently. (Integer value: 9)
The last event of each different subject origin. (Integer value: 10)
The last event of each different subject origin. (Integer value: 10)
The last event of each different subject origin, ordered by least recently used first. (Integer value: 11)
The last event of each different subject origin, ordered by least recently used first. (Integer value: 11)
The last event of each different subject origin, ordered by the popularity of the origins. (Integer value: 12)
The last event of each different subject origin, ordered by the popularity of the origins. (Integer value: 12)
The last event of each different subject origin, ordered ascendingly by the popularity of the origin. (Integer value: 13)
The last event of each different subject origin, ordered ascendingly by the popularity of the origin. (Integer value: 13)
The first event of each different actor. (Integer value: 14)
One event for each subject interpretation only, ordered with the most recent events first. (Integer value: 15)
One event for each subject interpretation only, ordered with the least recent events first. (Integer value: 16)
One event for each subject interpretation only, ordered by the popularity of the subject interpretation. (Integer value: 17)
One event for each subject interpretation only, ordered ascendingly by popularity of the subject interpretation. (Integer value: 18)
One event for each mimetype only, ordered with the most recent events first. (Integer value: 19)
One event for each mimetype only, ordered with the least recent events first. (Integer value: 20)
One event for each mimetype only, ordered by the popularity of the mimetype. (Integer value: 21)
One event for each mimetype only, ordered ascendingly by popularity of the mimetype. (Integer value: 22)
One event for each subject only (by current_uri instead of uri), ordered with the most recent events first. (Integer value: 23)
One event for each subject only (by current_uri instead of uri), ordered with oldest events first. (Integer value: 24)
One event for each subject only (by current_uri instead of uri), ordered by the popularity of the subject. (Integer value: 25)
One event for each subject only (by current_uri instead of uri), ordered ascendingly by popularity of the subject. (Integer value: 26)
The last event of each different origin. (Integer value: 27)
The last event of each different origin, ordered by least recently used first. (Integer value: 28)
The last event of each different origin, ordered by the popularity of the origins. (Integer value: 29)
The last event of each different origin, ordered ascendingly by the popularity of the origin. (Integer value: 30)
Enumeration class defining the possible values for the storage state of an event subject.
The StorageState enumeration can be used to control whether or not matched events must have their subjects available to the user. Fx. not including deleted files, files on unplugged USB drives, files available only when a network is available etc.
The storage medium of the events subjects must not be available to the user. (Integer value: 0)
The storage medium of all event subjects must be immediately available to the user. (Integer value: 1)
The event subjects may or may not be available. (Integer value: 2)
Optimized and convenient data structure representing a datasource.
This class is designed so that you can pass it directly over DBus using the Python DBus bindings. It will automagically be marshalled with the signature a(asaasay). See also the section on the event serialization format.
This class does integer based lookups everywhere and can wrap any conformant data structure without the need for marshalling back and forth between DBus wire format. These two properties makes it highly efficient and is recommended for use everywhere.
This is part of the org.gnome.zeitgeist.DataSourceRegistry extension.