Data Model

Event

class zeitgeist.datamodel.Event(struct=None)

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.

actor
Read/write property defining the application or entity responsible for emitting the event. For applications the format of this field is base filename of the corresponding .desktop file with an app:// URI scheme. For example /usr/share/applications/firefox.desktop is encoded as app://firefox.desktop
append_subject(subject=None)
Append a new empty Subject and return a reference to it
id
Read only property containing the the event id if the event has one
in_time_range(time_range)
Check if the event timestamp lies within a TimeRange
interpretation
Read/write property defining the interpretation type of the event
manifestation
Read/write property defining the manifestation type of the event
matches_event(event)
Interpret self as the template an match event against it. This method is the dual method of matches_template().
matches_template(event_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.

classmethod new_for_data(event_data)
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.
classmethod new_for_struct(struct)
Returns a new Event instance or None if struct is a NULL_EVENT
classmethod new_for_values(**values)

Create a new Event instance from a collection of keyword arguments.

Parameters:
  • timestamp – Event timestamp in milliseconds since the Unix Epoch
  • interpretaion – The Interpretation type of the event
  • manifestation – Manifestation type of the event
  • actor – The actor (application) that triggered the event
  • subjects – A list of Subject instances

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:
  • subject_uri
  • subject_interpretation
  • subject_manifestation
  • subject_origin
  • subject_mimetype
  • subject_text
  • subject_storage
payload
Free form attachment for the event. Transfered over DBus as an array of bytes
subjects
Read/write property with a list of Subjects
timestamp
Read/write property with the event timestamp defined as milliseconds since the Epoch. By default it is set to the moment of instance creation

Subject

class zeitgeist.datamodel.Subject(data=None)

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.

interpretation
Read/write property defining the interpretation type of the subject
manifestation
Read/write property defining the manifestation type of the subject
matches_template(subject_template)

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()

mimetype
Read/write property containing the mimetype of the subject (encoded as a string) if applicable
static new_for_values(**values)

Create a new Subject instance and set its properties according to the keyword arguments passed to this method.

Parameters:
  • uri – The URI of the subject. Eg. file:///tmp/ratpie.txt
  • interpretation – The interpretation type of the subject, given either as a string URI or as a Interpretation instance
  • manifestation – The manifestation type of the subject, given either as a string URI or as a Manifestation instance
  • origin – The URI of the location where subject resides or can be said to originate from
  • mimetype – The mimetype of the subject encoded as a string, if applicable. Eg. text/plain.
  • text – Free form textual annotation of the subject.
  • storage – String identifier for the storage medium of the subject. This should be the UUID of the volume or the string “net” for resources requiring a network interface, and the string “deleted” for subjects that are deleted.
origin
Read/write property with the URI of the location where the subject resides or where it can be said to originate from
storage
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
text
Read/write property with a free form textual annotation of the subject
uri
Read/write property with the URI of the subject encoded as a string

Interpretation

zeitgeist.datamodel.Interpretation

Interpretation

In general terms the interpretation of an event or subject is an abstract

description of “what happened” or “what is this”.

Each interpretation type is uniquely identified by a URI. This class provides a list of hard coded URI constants for programming convenience. In addition; each interpretation instance in this class has a display_name property, which is an internationalized string meant for end user display.

The interpretation types listed here are all subclasses of str and may be used anywhere a string would be used.

Interpretations form a hierarchical type tree. So that fx. Audio, Video, and Image all are sub types of Media. These types again have their own sub types, like fx. Image has children Icon, Photo, and VectorImage (among others).

Templates match on all sub types, so that a query on subjects with interpretation Media also match subjects with interpretations Audio, Photo, and all other sub types of Media. . (Display name: '')

Interpretation.ALARM

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#Alarm

Provide a grouping of component properties that define an alarm. (Display name: 'Alarm')

Interpretation.BOOKMARK

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Bookmark

A bookmark of a webbrowser. Use nie:title for the name/label, nie:contentCreated to represent the date when the user added the bookmark, and nie:contentLastModified for modifications. nfo:bookmarks to store the link. (Display name: 'Bookmark')

Interpretation.BOOKMARK_FOLDER

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#BookmarkFolder

A folder with bookmarks of a webbrowser. Use nfo:containsBookmark to relate Bookmarks. Folders can contain subfolders, use containsBookmarkFolder to relate them. (Display name: 'Bookmark Folder')

Interpretation.CALENDAR

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#Calendar

A calendar. Inspirations for this class can be traced to the VCALENDAR component defined in RFC 2445 sec. 4.4, but it may just as well be used to represent any kind of Calendar. (Display name: 'Calendar')

Interpretation.DATA_CONTAINER

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#DataContainer

A superclass for all entities, whose primary purpose is to serve as containers for other data object. They usually don’t have any “meaning” by themselves. Examples include folders, archives and optical disc images. (Display name: 'DataContainer')

DATA_CONTAINER.ARCHIVE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Archive

A compressed file. May contain other files or folder inside. (Display name: 'Archive')

DATA_CONTAINER.FILESYSTEM

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Filesystem

A filesystem. Examples of filesystems include hard disk partitions, removable media, but also images thereof stored in files. (Display name: 'Filesystem')

DATA_CONTAINER.FILESYSTEM.FILESYSTEM_IMAGE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#FilesystemImage

An image of a filesystem. Instances of this class may include CD images, DVD images or hard disk partition images created by various pieces of software (e.g. Norton Ghost). (Display name: 'FilesystemImage')

DATA_CONTAINER.FOLDER

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Folder

A folder/directory. Examples of folders include folders on a filesystem and message folders in a mailbox. (Display name: 'Folder')

DATA_CONTAINER.TRASH

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Trash

Represents a container for deleted files, a feature common in modern operating systems. (Display name: 'Trash')

Interpretation.DOCUMENT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Document

A generic document. A common superclass for all documents on the desktop. (Display name: 'Document')

DOCUMENT.MIND_MAP

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#MindMap

A MindMap, created by a mind-mapping utility. Examples might include FreeMind or mind mapper. (Display name: 'MindMap')

DOCUMENT.PRESENTATION

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Presentation

A Presentation made by some presentation software (Corel Presentations, OpenOffice Impress, MS Powerpoint etc.). (Display name: 'Presentation')

DOCUMENT.SPREADSHEET

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Spreadsheet

A spreadsheet, created by a spreadsheet application. Examples might include Gnumeric, OpenOffice Calc or MS Excel. (Display name: 'Spreadsheet')

DOCUMENT.TEXT_DOCUMENT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#TextDocument

A text document. (Display name: 'TextDocument')

DOCUMENT.TEXT_DOCUMENT.PAGINATED_TEXT_DOCUMENT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#PaginatedTextDocument

A file containing a text document, that is unambiguously divided into pages. Examples might include PDF, DOC, PS, DVI etc. (Display name: 'PaginatedTextDocument')

DOCUMENT.TEXT_DOCUMENT.PLAIN_TEXT_DOCUMENT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#PlainTextDocument

A file containing plain text (ASCII, Unicode or other encodings). Examples may include TXT, HTML, XML, program source code etc. (Display name: 'PlainTextDocument')

DOCUMENT.TEXT_DOCUMENT.PLAIN_TEXT_DOCUMENT.HTML_DOCUMENT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#HtmlDocument

A HTML document, may contain links to other files. (Display name: 'HtmlDocument')

DOCUMENT.TEXT_DOCUMENT.PLAIN_TEXT_DOCUMENT.SOURCE_CODE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#SourceCode

Code in a compilable or interpreted programming language. (Display name: 'SourceCode')

Interpretation.EVENT

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#Event

Provide a grouping of component properties that describe an event. (Display name: 'Event')

Interpretation.EVENT_INTERPRETATION

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#EventInterpretation

Base class for event interpretations. Please do no instantiate directly, but use one of the sub classes. The interpretation of an event describes ‘what happened’ - fx. ‘something was created’ or ‘something was accessed’. (Display name: 'EVENT_INTERPRETATION')

EVENT_INTERPRETATION.ACCESS_EVENT

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#AccessEvent

Event triggered by opening, accessing, or starting a resource. Most zg:AccessEvents will have an accompanying zg:LeaveEvent, but this need not always be the case. (Display name: 'ACCESS_EVENT')

EVENT_INTERPRETATION.CREATE_EVENT

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#CreateEvent

Event type triggered when an item is created. (Display name: 'Created')

EVENT_INTERPRETATION.DELETE_EVENT

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#DeleteEvent

Event triggered because a resource has been deleted or otherwise made permanently unavailable. Fx. when deleting a file. FIXME: How about when moving to trash?. (Display name: 'DELETE_EVENT')

EVENT_INTERPRETATION.LEAVE_EVENT

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#LeaveEvent

Event triggered by closing, leaving, or stopping a resource. Most zg:LeaveEvents will be following a zg:Access event, but this need not always be the case. (Display name: 'LEAVE_EVENT')

EVENT_INTERPRETATION.MODIFY_EVENT

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#ModifyEvent

Event triggered by modifying an existing resources. Fx. when editing and saving a file on disk or correcting a typo in the name of a contact. (Display name: 'MODIFY_EVENT')

EVENT_INTERPRETATION.RECEIVE_EVENT

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#ReceiveEvent

Event triggered when something is received from an external party. The event manifestation must be set according to the world view of the receiving party. Most often the item that is being received will be some sort of message - an email, instant message, or broadcasted media such as micro blogging. (Display name: 'RECEIVE_EVENT')

EVENT_INTERPRETATION.SEND_EVENT

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#SendEvent

Event triggered when something is send to an external party. The event manifestation must be set according to the world view of the sending party. Most often the item that is being send will be some sort of message - an email, instant message, or broadcasted media such as micro blogging. (Display name: 'SEND_EVENT')

Interpretation.EXECUTABLE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Executable

An executable file. (Display name: 'Executable')

Interpretation.FONT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Font

A font. (Display name: 'Font')

Interpretation.FREEBUSY

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#Freebusy

Provide a grouping of component properties that describe either a request for free/busy time, describe a response to a request for free/busy time or describe a published set of busy time. (Display name: 'Freebusy')

Interpretation.JOURNAL

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#Journal

Provide a grouping of component properties that describe a journal entry. (Display name: 'Journal')

Interpretation.MAILBOX

http://www.semanticdesktop.org/ontologies/2007/03/22/nmo#Mailbox

A mailbox - container for MailboxDataObjects. (Display name: 'Mailbox')

Interpretation.MEDIA

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Media

A piece of media content. This class may be used to express complex media containers with many streams of various media content (both aural and visual). (Display name: 'Media')

MEDIA.AUDIO

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Audio

A file containing audio content. (Display name: 'Audio')

MEDIA.MUSIC_PIECE

http://www.semanticdesktop.org/ontologies/2009/02/19/nmm#MusicPiece

Used to assign music-specific properties such a BPM to video and audio. (Display name: 'music')

MEDIA.VISUAL

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Visual

File containing visual content. (Display name: 'Visual')

MEDIA.VISUAL.IMAGE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Image

A file containing an image. (Display name: 'Image')

MEDIA.VISUAL.IMAGE.ICON

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Icon

An Icon (regardless of whether it’s a raster or a vector icon. A resource representing an icon could have two types (Icon and Raster, or Icon and Vector) if required. (Display name: 'Icon')

MEDIA.VISUAL.IMAGE.RASTER_IMAGE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#RasterImage

A raster image. (Display name: 'RasterImage')

MEDIA.VISUAL.IMAGE.RASTER_IMAGE.CURSOR

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Cursor

A Cursor. (Display name: 'Cursor')

MEDIA.VISUAL.IMAGE.VECTOR_IMAGE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#VectorImage

. (Display name: 'VectorImage')

MEDIA.VISUAL.VIDEO

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Video

A video file. (Display name: 'Video')

MEDIA.VISUAL.VIDEO.MOVIE

http://www.semanticdesktop.org/ontologies/2009/02/19/nmm#Movie

A Movie. (Display name: 'movie')

MEDIA.VISUAL.VIDEO.TVSHOW

http://www.semanticdesktop.org/ontologies/2009/02/19/nmm#TVShow

A TV Show. (Display name: 'tv show')

Interpretation.MEDIA_LIST

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#MediaList

A file containing a list of media files.e.g. a playlist. (Display name: 'MediaList')

MEDIA_LIST.MUSIC_ALBUM

http://www.semanticdesktop.org/ontologies/2009/02/19/nmm#MusicAlbum

The music album as provided by the publisher. Not to be confused with media lists or collections. (Display name: 'music album')

Interpretation.MESSAGE

http://www.semanticdesktop.org/ontologies/2007/03/22/nmo#Message

A message. Could be an email, instant messanging message, SMS message etc. (Display name: 'Message')

MESSAGE.EMAIL

http://www.semanticdesktop.org/ontologies/2007/03/22/nmo#Email

An email. (Display name: 'Email')

MESSAGE.IMMESSAGE

http://www.semanticdesktop.org/ontologies/2007/03/22/nmo#IMMessage

A message sent with Instant Messaging software. (Display name: 'IMMessage')

Interpretation.MIME_ENTITY

http://www.semanticdesktop.org/ontologies/2007/03/22/nmo#MimeEntity

A MIME entity, as defined in RFC2045, Section 2.4. (Display name: 'MimeEntity')

Interpretation.SOFTWARE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Software

A piece of software. Examples may include applications and the operating system. This interpretation most commonly applies to SoftwareItems. (Display name: 'Software')

SOFTWARE.APPLICATION

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Application

An application. (Display name: 'Application')

SOFTWARE.OPERATING_SYSTEM

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#OperatingSystem

An OperatingSystem. (Display name: 'OperatingSystem')

Interpretation.TIMEZONE

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#Timezone

Provide a grouping of component properties that defines a time zone. (Display name: 'Timezone')

Interpretation.TODO

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#Todo

Provide a grouping of calendar properties that describe a to-do. (Display name: 'Todo')

Interpretation.TVSERIES

http://www.semanticdesktop.org/ontologies/2009/02/19/nmm#TVSeries

A TV Series has multiple seasons and episodes. (Display name: 'tv series')

Interpretation.WEBSITE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Website

A website, usually a container for remote resources, that may be interpreted as HTMLDocuments, images or other types of content. (Display name: 'Website')

Manifestation

zeitgeist.datamodel.Manifestation

Manifestation

The manifestation type of an event or subject is an abstract classification

of “how did this happen” or “how does this item exist”.

Each manifestation type is uniquely identified by a URI. This class provides a list of hard coded URI constants for programming convenience. In addition; each interpretation instance in this class has a display_name property, which is an internationalized string meant for end user display.

The manifestation types listed here are all subclasses of str and may be used anywhere a string would be used.

Manifestations form a hierarchical type tree. So that fx. ArchiveItem, Attachment, and RemoteDataObject all are sub types of FileDataObject. These types can again have their own sub types.

Templates match on all sub types, so that a query on subjects with manifestation FileDataObject also match subjects of types Attachment or ArchiveItem and all other sub types of FileDataObject . (Display name: '')

Manifestation.CALENDAR_DATA_OBJECT

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#CalendarDataObject

A DataObject found in a calendar. It is usually interpreted as one of the calendar entity types (e.g. Event, Journal, Todo etc.). (Display name: 'CalendarDataObject')

Manifestation.EVENT_MANIFESTATION

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#EventManifestation

Base class for event manifestation types. Please do no instantiate directly, but use one of the sub classes. The manifestation of an event describes ‘how it happened’. Fx. ‘the user did this’ or ‘the system notified the user’. (Display name: 'EVENT_MANIFESTATION')

EVENT_MANIFESTATION.HEURISTIC_ACTIVITY

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#HeuristicActivity

An event that is caused indirectly from user activity or deducted via analysis of other events. Fx. if an algorithm divides a user workflow into disjoint ‘projects’ based on temporal analysis it could insert heuristic events when the user changed project. (Display name: 'HEURISTIC_ACTIVITY')

EVENT_MANIFESTATION.SCHEDULED_ACTIVITY

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#ScheduledActivity

An event that was directly triggered by some user initiated sequence of actions. For example a music player automatically changing to the next song in a playlist. (Display name: 'SCHEDULED_ACTIVITY')

EVENT_MANIFESTATION.SYSTEM_NOTIFICATION

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#SystemNotification

An event send to the user by the operating system. Examples could include when the user inserts a USB stick or when the system warns that the hard disk is full. (Display name: 'SYSTEM_NOTIFICATION')

EVENT_MANIFESTATION.USER_ACTIVITY

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#UserActivity

An event that was actively performed by the user. For example saving or opening a file by clicking on it in the file manager. (Display name: 'USER_ACTIVITY')

EVENT_MANIFESTATION.WORLD_ACTIVITY

http://www.zeitgeist-project.com/ontologies/2010/01/27/zg#WorldActivity

An event that was performed by an entity, usually human or organization, other than the user. An example could be logging the activities of other people in a team. (Display name: 'WORLD_ACTIVITY')

Manifestation.FILE_DATA_OBJECT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#FileDataObject

A resource containing a finite sequence of bytes with arbitrary information, that is available to a computer program and is usually based on some kind of durable storage. A file is durable in the sense that it remains available for programs to use after the current program has finished. (Display name: 'File')

FILE_DATA_OBJECT.DELETED_RESOURCE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#DeletedResource

A file entity that has been deleted from the original source. Usually such entities are stored within various kinds of ‘Trash’ or ‘Recycle Bin’ folders. (Display name: 'DeletedResource')

FILE_DATA_OBJECT.EMBEDDED_FILE_DATA_OBJECT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#EmbeddedFileDataObject

A file embedded in another data object. There are many ways in which a file may be embedded in another one. Use this class directly only in cases if none of the subclasses gives a better description of your case. (Display name: 'EmbeddedFileDataObject')

FILE_DATA_OBJECT.EMBEDDED_FILE_DATA_OBJECT.ARCHIVE_ITEM

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#ArchiveItem

A file entity inside an archive. (Display name: 'ArchiveItem')

FILE_DATA_OBJECT.EMBEDDED_FILE_DATA_OBJECT.ATTACHMENT

http://www.semanticdesktop.org/ontologies/2007/04/02/ncal#Attachment

An object attached to a calendar entity. This class has been introduced to serve as a structured value of the ncal:attach property. See the documentation of ncal:attach for details. (Display name: 'Attachment')

FILE_DATA_OBJECT.REMOTE_DATA_OBJECT

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#RemoteDataObject

A file data object stored at a remote location. Don’t confuse this class with a RemotePortAddress. This one applies to a particular resource, RemotePortAddress applies to an address, that can have various interpretations. (Display name: 'RemoteDataObject')

Manifestation.HARD_DISK_PARTITION

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#HardDiskPartition

A partition on a hard disk. (Display name: 'HardDiskPartition')

Manifestation.MAILBOX_DATA_OBJECT

http://www.semanticdesktop.org/ontologies/2007/03/22/nmo#MailboxDataObject

An entity encountered in a mailbox. Most common interpretations for such an entity include Message or Folder. (Display name: 'MailboxDataObject')

Manifestation.MEDIA_STREAM

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#MediaStream

A stream of multimedia content, usually contained within a media container such as a movie (containing both audio and video) or a DVD (possibly containing many streams of audio and video). Most common interpretations for such a DataObject include Audio and Video. (Display name: 'MediaStream')

Manifestation.REMOTE_PORT_ADDRESS

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#RemotePortAddress

An address specifying a remote host and port. Such an address can be interpreted in many ways (examples of such interpretations include mailboxes, websites, remote calendars or filesystems), depending on an interpretation, various kinds of data may be extracted from such an address. (Display name: 'RemotePortAddress')

Manifestation.SOFTWARE_ITEM

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#SoftwareItem

A DataObject representing a piece of software. Examples of interpretations of a SoftwareItem include an Application and an OperatingSystem. (Display name: 'SoftwareItem')

Manifestation.SOFTWARE_SERVICE

http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#SoftwareService

A service published by a piece of software, either by an operating system or an application. Examples of such services may include calendar, addresbook and mailbox managed by a PIM application. This category is introduced to distinguish between data available directly from the applications (Via some Interprocess Communication Mechanisms) and data available from files on a disk. In either case both DataObjects would receive a similar interpretation (e.g. a Mailbox) and wouldn’t differ on the content level. (Display name: 'SoftwareService')

TimeRange

class zeitgeist.datamodel.TimeRange(begin, end)

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).

classmethod always()
Return a TimeRange from the furtest past to the most distant future
begin
The begining timestamp of this time range
end
The end timestamp of this time range
classmethod from_now()
Return a TimeRange from the instant of invocation to the end of time
classmethod from_seconds_ago(sec)
Return a TimeRange ranging from “sec” seconds before the instant of invocation to the same.
intersect(time_range)
Return a new TimeRange that is the intersection of the two time range intervals. If the intersection is empty this method returns None.
is_always()
Returns True if this time range represents the furtest past to the most distant future
classmethod until_now()
Return a TimeRange from 0 to the instant of invocation

ResultType

zeitgeist.datamodel.ResultType

An enumeration class used to define how query results should be returned from the Zeitgeist engine.

ResultType.MostRecentEvents
All events with the most recent events first. (Integer value: 0)
ResultType.LeastRecentEvents
All events with the oldest ones first. (Integer value: 1)
ResultType.MostRecentSubjects
One event for each subject only, ordered with the most recent events first. (Integer value: 2)
ResultType.LeastRecentSubjects
One event for each subject only, ordered with oldest events first. (Integer value: 3)
ResultType.MostPopularSubjects
One event for each subject only, ordered by the popularity of the subject. (Integer value: 4)
ResultType.LeastPopularSubjects
One event for each subject only, ordered ascendently by popularity. (Integer value: 5)
ResultType.MostPopularActor
The last event of each different actor,ordered by the popularity of the actor. (Integer value: 6)
ResultType.LeastPopularActor
The last event of each different actor,ordered ascendently by the popularity of the actor. (Integer value: 7)
ResultType.MostRecentActor
The last event of each different actor. (Integer value: 8)
ResultType.LeastRecentActor
The first event of each different actor. (Integer value: 9)

StorageState

zeitgeist.datamodel.StorageState

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.

StorageState.NotAvailable
The storage medium of the events subjects must not be available to the user. (Integer value: 0)
StorageState.Available
The storage medium of all event subjects must be immediately available to the user. (Integer value: 1)
StorageState.Any
The event subjects may or may not be available. (Integer value: 2)

DataSource

zeitgeist.datamodel.DataSource

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.

NULL_EVENT

zeitgeist.datamodel.NULL_EVENT
Minimal Event representation, a tuple containing three empty lists. This NULL_EVENT is used by the API to indicate a queried but not available (not found or blocked) Event.

Table Of Contents

Previous topic

DBus API

Next topic

Zeitgeist Engine

This Page