Firefox/Projects/PlacesQueryAPIRedesign: Difference between revisions

Jump to navigation Jump to search

Firefox/Projects/PlacesQueryAPIRedesign (view source)

Revision as of 20:50, 11 May 2010

1,135 bytes added ,  11 May 2010
no edit summary
No edit summary
No edit summary
Line 88: Line 88:
   // if more complex management is needed.
   // if more complex management is needed.
   if (results.length == 0)
   if (results.length == 0)
    dump("En empty results array indicates last results push\n");
      dump("En empty results array indicates last results push\n");
   else
   else
    dump("Collected " + results.length + " results this turn\n");
      dump("Collected " + results.length + " results this turn\n");
}
}


Line 127: Line 127:


   bookmarked: object {
   bookmarked: object {
    tags: array of strings.
      tags: array of strings.
          Show only pages tagged with these tags.
            Show only pages tagged with these tags.
    folders: array of numbers.
      folders: array of numbers.
            Show contents of these folders. (non-recursive)
              Show contents of these folders. (non-recursive)
    items: array of numbers.
      items: array of numbers.
          Show only these items.
            Show only these items.
    when: array of 2 Date objects.
      when: array of 2 Date objects.
          Show only bookmarks created between these times.
            Show only bookmarks created between these times.
          Can use null beginning or end time to match till epoch
            Can use null beginning or end time to match till epoch
          or now.
            or now.
    modified: array of 2 Date objects.
      modified: array of 2 Date objects.
              Show only bookmarks modified between these times.
                Show only bookmarks modified between these times.
              Can use null beginning or end time to match till
                Can use null beginning or end time to match till
              epoch or now.
                epoch or now.
    excludeNonContainers: boolean.
      excludeNonContainers: boolean.
                          Removes any non-container from results.
                            Removes any non-container from results.
                          Default is false.
                            Default is false.
    excludeReadOnlyContainers: boolean.
      excludeReadOnlyContainers: boolean.
                              Removes read only containers from
                                Removes read only containers from
                              results.  Default is false.
                                results.  Default is false.
   }
   }


   visited: object {
   visited: object {
        howMany: array of numbers.
      howMany: array of numbers.
                  Show only pages with these so many visits.
              Show only pages with these so many visits.
                  Can use null minimum or maximum to match anything.
              Can use null minimum or maximum to match anything.
        transitions: array fo transition types.
      transitions: array fo transition types.
                      Show only pages with at least one visit with these
                  Show only pages with at least one visit with these
                      transitions.
                  transitions.
        when: array of 2 Date objects.
      when: array of 2 Date objects.
              Show only pages with visits between these times.
            Show only pages with visits between these times.
              Can use null beginning or end time to match till epoch
            Can use null beginning or end time to match till epoch
              or now.
            or now.
        excludeRedirectsSources: boolean.
      excludeRedirectsSources: boolean.
                                  Removes redirects sources from results.
                              Removes redirects sources from results.
                                  Default is false.
                              Default is false.
        excludeRedirectsTargets: boolean.
      excludeRedirectsTargets: boolean.
                                  Removes redirects targets from results.
                              Removes redirects targets from results.
                                  Default is false.
                              Default is false.
        includeHiddenPages: boolean.
      includeHiddenPages: boolean.
                            Returns also pages marked as hidden.
                          Returns also pages marked as hidden.
                            Default is false.
                          Default is false.
        includeVisits: boolean.
      includeVisits: boolean.
                        Returns all visits.
                    Returns all visits.
                        Default is false, that means visits are grouped
                    Default is false, that means visits are grouped
                        by uri, and no duplicates are returned.
                    by uri, and no duplicates are returned.
   }
   }


   sort: object {
   sort: object {
    by: string.
      by: string.
        Either "none", "title", "time", "uri", "accessCount" or
          Either "none", "title", "time", "uri", "accessCount" or
        "lastModified", "frecency".  Defaults to "none".
          "lastModified", "frecency".  Defaults to "none".
    dir: string.
      dir: string.
        Either "asc" or "desc".  Defaults to "asc".
          Either "asc" or "desc".  Defaults to "asc".
   }
   }


Line 195: Line 195:
}
}


// The query returns an array of these simple ResultItem objects
ResultItem {
  pageId: the place_id of the page, useful for external linking of resources
  uri:
  title:
  host:
  accessCount: visit count for pages, aggregated or null for containers
  time: visit date, aggregated or null for containers
  icon: url of the icon
  sessionId: visit session or null if not available
  itemId: bookmark id or null if not bookmarked (see isBookmarked)
  dateAdded: bookmark creation Date() or null if not bookmarked
  lastModified bookmark modification Date() or null if not bookmarked
  parentId: bookmark folder id or null if not bookmarked
  tags: string of tags
  tagsArray: array of tags
  bookmarkIndex: position of the bookmark in his container or null
  frecency:
  visitId: id of the visit or null
  referringVisitId: id of the originating visit or null
  transitionType: transition of this visit or null
  type: old container implementation type
  readableType: "bookmark", "container", "separator", "visit", "page"
  isBookmarked: whether this is bookmarked or not
  query: if this is a container will return a new PlacesQuery for contents
}
</pre>
</pre>
Mak77
Confirmed users
595

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/222237"

Navigation menu