jgd.schemas
Interface GoogleDesktopIndexable

All Known Subinterfaces:
GoogleDesktopCalendar, GoogleDesktopContact, GoogleDesktopEmail, GoogleDesktopFile, GoogleDesktopIM, GoogleDesktopJournal, GoogleDesktopMediaFile, GoogleDesktopNote, GoogleDesktopTask, GoogleDesktopTextFile, GoogleDesktopWebPage
All Known Implementing Classes:
GDCOMCalendar, GDCOMContact, GDCOMEmail, GDCOMFile, GDCOMIM, GDCOMIndexed, GDCOMJournal, GDCOMMediaFile, GDCOMNote, GDCOMTask, GDCOMTextFile, GDCOMWebPage

public interface GoogleDesktopIndexable

This is an abstract schema. You cannot instantiate any event objects of type Google.Desktop.Indexable. Use one of its descendent schemas instead.
Event objects cannot exceed a size that varies depending on machine characteristics. This averages several hundred thousand KB. If you send too large an event object to GD, GD will first truncate the event object's content property's value until the total event object size is equal to the maximum allowed size. If all of the content property's value has been removed and the event object is still too big, GD will reject the event object.

Since:
2.0
Author:
Maso Gato
See Also:
http://desktop.google.com/dev/indexapi.html#eventschemas

Method Summary
 java.lang.String get_content()
          Contains the content to be indexed.
 byte[] get_cookie_raw()
          Binary cookie.
 java.lang.String get_cookie()
          String cookie used to pass additional information identifying the event.
 byte[] get_extra_binary_data()
          Contains optional non-indexable binary metadata for this event
Required: No
 java.lang.String get_extra_data()
          Contains optional non-indexable string metadata for this event
Required: No
 java.lang.Byte get_format()
          Mime type of the indexable content, allowed values are text/plain and text/html.
 java.lang.Long get_native_size()
          Size of the indexable content in bytes.
 java.lang.String get_other_indexed_data()
          Contains optional indexable content and metadata.
 java.lang.String get_thumbnail_format()
          Mime type of the thumbnail image, allowed values are image/gif, image/jpeg, and image/png.
 byte[] get_thumbnail()
          Thumbnail image of the content.
 

Method Detail

get_content

java.lang.String get_content()
Contains the content to be indexed. The content must be in a text format (which can include HTML or similar markup, although GD will only treat HTML markup differently from plain text) not binary data. Note that some items may not have any indexable content, such as media files for which GD only indexes metadata and email messages with no content in their body. For those items, set this property to an empty string.
Required: Yes


get_format

java.lang.Byte get_format()
Mime type of the indexable content, allowed values are text/plain and text/html.
Required: Yes


get_native_size

java.lang.Long get_native_size()
Size of the indexable content in bytes. Note that for file types for which there is no indexable content but still contain content, such as media files, you should set this property to be the size of the content. For example, for a 10 Megabyte audio file, you wouldn't put the 10 MB of content in an event's content property, but you should set its native_size property to 10000000.
Required: No


get_thumbnail

byte[] get_thumbnail()
Thumbnail image of the content. We recommend the image be 109 pixels wide by 75 pixels tall. Image files of more than 20 KB will be rejected with an invalid argument error. If you specify a thumbnail image, you must also set a value for the following thumbnail_format property.
Required: No


get_thumbnail_format

java.lang.String get_thumbnail_format()
Mime type of the thumbnail image, allowed values are image/gif, image/jpeg, and image/png.
Required: No


get_cookie

java.lang.String get_cookie()
String cookie used to pass additional information identifying the event.
Required: No


get_cookie_raw

byte[] get_cookie_raw()
Binary cookie.
Required: No


get_other_indexed_data

java.lang.String get_other_indexed_data()
Contains optional indexable content and metadata. Can be used to index additional data that is separate from the content property
Required: No


get_extra_data

java.lang.String get_extra_data()
Contains optional non-indexable string metadata for this event
Required: No


get_extra_binary_data

byte[] get_extra_binary_data()
Contains optional non-indexable binary metadata for this event
Required: No



Copyright 2007