| 1 | ------------------------------------------------------------------------------- |
|---|
| 2 | Dojo Storage |
|---|
| 3 | ------------------------------------------------------------------------------- |
|---|
| 4 | Version X.XXX (does not have separate versioning -- versioned by release date) |
|---|
| 5 | Last Release date: January 2010 |
|---|
| 6 | ------------------------------------------------------------------------------- |
|---|
| 7 | Project state: |
|---|
| 8 | experimental |
|---|
| 9 | ------------------------------------------------------------------------------- |
|---|
| 10 | Credits |
|---|
| 11 | Brad Neuberg |
|---|
| 12 | Alex Russell |
|---|
| 13 | |
|---|
| 14 | LocalStorage, BehaviorStorage, CookieStorage: |
|---|
| 15 | Jens Arps |
|---|
| 16 | ------------------------------------------------------------------------------- |
|---|
| 17 | Project description |
|---|
| 18 | |
|---|
| 19 | dojox.storage provides a JavaScript abstraction for persistent storage |
|---|
| 20 | as well as pluggable implementations which typically use native browser |
|---|
| 21 | extensions (e.g. Flash player, Gears) |
|---|
| 22 | |
|---|
| 23 | ------------------------------------------------------------------------------- |
|---|
| 24 | Dependencies: |
|---|
| 25 | |
|---|
| 26 | FlashStorageProvider requires the Flash player |
|---|
| 27 | GearsStorageProvider requires the Gears extension |
|---|
| 28 | LocalStorageProvider does not require any plugins but will run only in certain |
|---|
| 29 | browsers (see below) |
|---|
| 30 | BehaviorStorageProvider does not require any plugins but will run only in IE 5+ |
|---|
| 31 | CookieStorageProvider has no requirements |
|---|
| 32 | The various Air*StorageProviders require Adobe's AIR software |
|---|
| 33 | |
|---|
| 34 | The open source mtasc compiler (www.mtasc.org) is needed to build the |
|---|
| 35 | ActionScript into SWF format. The SWF object is maintained within svn, so |
|---|
| 36 | this step is only necessary if Storage.as is modified. A sample build script |
|---|
| 37 | is provided (buildFlashStorage.sh) |
|---|
| 38 | |
|---|
| 39 | ------------------------------------------------------------------------------- |
|---|
| 40 | Documentation |
|---|
| 41 | |
|---|
| 42 | See http://dojotoolkit.org/reference-guide/dojox/storage.html for Dojo Storage docs. |
|---|
| 43 | |
|---|
| 44 | See dojox/storage/demos/helloworld.html for a simple Hello World example |
|---|
| 45 | you can base your code off of. |
|---|
| 46 | |
|---|
| 47 | ------------------------------------------------------------------------------- |
|---|
| 48 | Installation instructions |
|---|
| 49 | |
|---|
| 50 | If you want to use Dojo Storage in a web browser: |
|---|
| 51 | |
|---|
| 52 | These installation instructions are to use Dojo Storage in a web browser; at |
|---|
| 53 | runtime, Dojo Storage will autodetect and use the best available storage |
|---|
| 54 | option. This includes: |
|---|
| 55 | |
|---|
| 56 | * localStorage: HTML 5 Web Browsers (Firefox 3+, Safari 4+, IE 8+) |
|---|
| 57 | * Google Gears (Plugin) |
|---|
| 58 | * globalStorage (Firefox 2+) |
|---|
| 59 | * userData Behavior (IE 5+) |
|---|
| 60 | * Hidden Flash (Plugin) |
|---|
| 61 | * Cookies |
|---|
| 62 | |
|---|
| 63 | To have access to Dojo Storage, require "dojox.storage": |
|---|
| 64 | |
|---|
| 65 | dojo.require("dojox.storage"); |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | If you want to use Dojo Storage with Adobe AIR: |
|---|
| 69 | |
|---|
| 70 | [TBD! Why don't you write this and contribute!] |
|---|
| 71 | |
|---|
| 72 | ------------------------------------------------------------------------------- |
|---|
| 73 | Additional Notes |
|---|
| 74 | |
|---|
| 75 | |
|---|
| 76 | STORAGE TABLE |
|---|
| 77 | ------------- |
|---|
| 78 | |
|---|
| 79 | |
|---|
| 80 | Browser Used StorageProvider, in order of preference |
|---|
| 81 | |
|---|
| 82 | IE 6 / IE7 GearsStorageProvider |
|---|
| 83 | FlashStorageProvider |
|---|
| 84 | BehaviorStorageProvider |
|---|
| 85 | CookieStorageProvider |
|---|
| 86 | |
|---|
| 87 | IE 8 LocalStorageProvider |
|---|
| 88 | GearsStorageProvider |
|---|
| 89 | FlashStorageProvider |
|---|
| 90 | BehaviorStorageProvider |
|---|
| 91 | CookieStorageProvider |
|---|
| 92 | |
|---|
| 93 | Safari 3 FlashStorageProvider |
|---|
| 94 | CookieStorageProvider |
|---|
| 95 | |
|---|
| 96 | Safari 4 LocalStorageProvider |
|---|
| 97 | FlashStorageProvider |
|---|
| 98 | CookieStorageProvider |
|---|
| 99 | |
|---|
| 100 | Chromium 4 FlashStorageProvider |
|---|
| 101 | (Mac OS) CookieStorageProvider |
|---|
| 102 | |
|---|
| 103 | Firefox 2 WhatWGStorageProvider (= globalStorage) |
|---|
| 104 | GearsStorageProvider |
|---|
| 105 | FlashStorageProvider |
|---|
| 106 | CookieStorageProvider |
|---|
| 107 | |
|---|
| 108 | Firefox 3 LocalStorageProvider |
|---|
| 109 | GearsStorageProvider |
|---|
| 110 | FlashStorageProvider |
|---|
| 111 | CookieStorageProvider |
|---|
| 112 | |
|---|
| 113 | Opera 10 LocalStorageProvider |
|---|
| 114 | FlashStorageProvider |
|---|
| 115 | CookieStorageProvider |
|---|
