Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(256)

Side by Side Diff: chrome/common/extensions/docs/templates/articles/app_codelab6_lifecycle.html

Issue 13248004: Cleaning up apps codelab (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 7 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 <h1 id="lab_6_lifecycle">Lab 6 - Lifecycle</h1> 1 <h1 id="lab_6_lifecycle">Manage App Lifecycle</h1>
2 2
3 <p>Like everything in this world, apps have a lifecycle. They are installed, la unched, restarted, suspended when the system needs to free up resources and unin stalled. This lab will show you the basics of the Chrome app lifecycle and how its heart, the event page (aka background script), is used.</p> 3 <p>Like everything in this world, apps have a lifecycle. They are installed, la unched, restarted, suspended when the system needs to free up resources and unin stalled. This lab will show you the basics of the Chrome app lifecycle and how its heart, the event page (aka background script), is used.</p>
4 4
5 <h2 id="you_should_also_read">You should also read</h2>
6
7 <p><a href="http://developer.chrome.com/apps/app_lifecycle.html">Manage App Life cycle</a> in Chrome app docs</p>
8
9 <h2 id="the_event_page">The event page</h2> 5 <h2 id="the_event_page">The event page</h2>
10 6
11 <p>The event page is one of the most important pieces of a Chrome app. It&#39;s responsible for what gets launched, when, and how. 7 <p>The event page is one of the most important pieces of a Chrome app. It&#39;s responsible for what gets launched, when, and how.
12 For example, if your app is an instant messenger, you might want your event page to only show a UI when there is a new notification.</p> 8 For example, if your app is an instant messenger, you might want your event page to only show a UI when there is a new notification.</p>
13 9
14 <p>For simpler apps, the event page listens to the app lifecycle events and reac ts appropriately. 10 <p>For simpler apps, the event page listens to the app lifecycle events and reac ts appropriately.
15 There are two important lifecycle events, $ref:app.runtime.onLaunched and $ref:a pp.runtime.onRestarted.</p> 11 There are two important lifecycle events, $ref:app.runtime.onLaunched and $ref:a pp.runtime.onRestarted.</p>
16 12
17 <h2 id="the_onlaunched_event_and_the_chrome_app_window_create_method">The onLaun ched event and the chrome.app.window.create method</h2> 13 <h2 id="the_onlaunched">The onLaunched event</h2>
18 14
19 <p>$ref:app.runtime.onLaunched is the most important event. It fires when the us er clicks on your app&#39;s icon with the intent of launching it. For most simpl er apps, the event page will listen for this event and open a window when it fir es. See our <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/mas ter/lab6_lifecycle/angularjs/main.js">main.js</a> for the most common usage.</p> 15 <p>The $ref:app.runtime.onLaunched event is the most important event.
16 It fires when the user clicks on your app&#39;s icon with the intent of launchin g it.
17 For most simpler apps,
18 the event page will listen for this event and open a window when it fires.
19 See
20 <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/master/lab6_lif ecycle/angularjs/main.js">AngularJS main.js</a> or
21 <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/master/lab6_lif ecycle/javascript/main.js">JavaScript main.js</a>
22 for the most common usage.</p>
20 23
21 <h3 id="windows_with_ids">Windows with IDs</h3> 24 <h3 id="windows_with_ids">Windows with IDs</h3>
22 25
23 <p>The $ref:app.window.create method can associate an ID to the window being ope ned. Currently, the most interesting use for this is to restore a window&#39;s w idth, height and location and its associated Developer Tools window, if opened, when the app is launched. </p> 26 <p>The $ref:app.window.create method can associate an ID to the window being ope ned. Currently, the most interesting use for this is to restore a window&#39;s w idth, height and location and its associated Developer Tools window, if opened, when the app is launched. </p>
24 27
25 <p>Execute your app as it is now, move and resize the window, close and restart it. The app will reopen in the original location, right? Now add a property <cod e>id</code> to the <a href="https://github.com/GoogleChrome/chrome-app-codelab/b lob/master/lab6_lifecycle/angularjs/main.js">main.js</a>, reload the app and tes t again:</p> 28 <p>Execute your app as it is now, move and resize the window,
29 close and restart it.
30 The app will reopen in the original location, right?
31 Now add a property <code>id</code> to the event page,
32 <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/master/lab6_lif ecycle/angularjs/main.js">Angular main.js</a> or
33 <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/master/lab6_lif ecycle/javascript/main.js">JavaScript main.js</a>,
34 reload the app and test again:</p>
26 35
27 <pre><code><pre> 36 <pre>
28 chrome.app.runtime.onLaunched.addListener(function() { 37 chrome.app.runtime.onLaunched.addListener(function() {
29 chrome.app.window.create(&#39;index.html&#39;, 38 chrome.app.window.create(&#39;index.html&#39;,
30 {id: &#39;mainwindow&#39;, bounds: {width: 500, height: 309} }); 39 {id: &#39;mainwindow&#39;, bounds: {width: 500, height: 309} });
31 }); 40 });
32 </pre></code></pre> 41 </pre>
33 42
34 <p>If your application requires, you can open more than one window.</p> 43 <p>If your application requires, you can open more than one window.</p>
35 44
36 <h2 id="the_onrestarted_event">The onRestarted event</h2> 45 <h2 id="the_onrestarted_event">The onRestarted event</h2>
37 46
38 <p>The $ref:app.runtime.onRestarted event is not as essential as <code>onLaunche d</code>, but it might be relevant to certain types of apps. 47 <p>The $ref:app.runtime.onRestarted event is not as essential as <code>onLaunche d</code>,
39 This event is executed when the app is restarted, for example, when Chrome quits , restarts, and the app is launched again. 48 but it might be relevant to certain types of apps.
40 You can use this event to restore a transient state. </p> 49 This event is executed when the app is restarted, for example,
50 when Chrome quits, restarts, and the app is launched again.
51 You can use this event to restore a transient state.</p>
41 52
42 <p>For example, if your app has a form with several fields, you won&#39;t always want to save the partial form while the user is typing. 53 <p>For example, if your app has a form with several fields,
54 you won&#39;t always want to save the partial form while the user is typing.
43 If the user quits the app on purpose, she might not be interested keeping the pa rtial data. 55 If the user quits the app on purpose, she might not be interested keeping the pa rtial data.
44 If the Chrome runtime restarted for some reason other than by a user&#39;s inten tion, the user will want that data when the app is restarted.</p> 56 If the Chrome runtime restarted for some reason other than by a user&#39;s inten tion,
57 the user will want that data when the app is restarted.</p>
45 58
46 <p>Let&#39;s change our code to save the Todo input field in $ref:storage as the user types, only restoring it if the <code>onRestarted</code> event is triggere d.</p> 59 <p>Let&#39;s change our code to save the Todo input field in $ref:storage as the user types,
60 only restoring it if the <code>onRestarted</code> event is triggered.</p>
47 61
48 <p class="note"><b>Note:</b> We learned about <code>chrome.storage.sync</code> before, but <a href="http://developer.chrome.com/trunk/apps/storage.html#using-s ync">chrome.storage.local</a> wasn&#39;t mentioned until now. Both have exactly the same syntax, but the semantics of <code>chrome.storage.local</code> is, as t he name says, completely local. 62 <p class="note"><b>Note:</b>
63 We learned about <code>chrome.storage.sync</code> before, but
64 <a href="http://developer.chrome.com/trunk/apps/storage.html#using-sync">chrome. storage.local</a>
65 wasn&#39;t mentioned until now.
66 Both have exactly the same syntax,
67 but the semantics of <code>chrome.storage.local</code> is, as the name says, com pletely local.
49 There&#39;s no attempt to synchronize or to save the data in the cloud.</p> 68 There&#39;s no attempt to synchronize or to save the data in the cloud.</p>
50 69
51 <ul> 70 <h3 id="event-page">Update event page</h3>
52 <li>Event page: <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob /master/lab6_lifecycle/angularjs/main.js">main.js</a> 71
72 <p>Update the event page to include the
73 <code>onLaunched</code> and <code>onRestarted</code> events.
74 Events are handled the same in
75 <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/master/lab6_lif ecycle/angularjs/main.js">AngularJS main.js</a> and
76 <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/master/lab6_lif ecycle/javascript/main.js">JavaScript main.js</a>:
77 </p>
78
53 <pre> 79 <pre>
54 chrome.app.runtime.onLaunched.addListener(function() { 80 chrome.app.runtime.onLaunched.addListener(function() {
55 // normal launch initiated by the user, let&#39;s start clean. 81 // normal launch initiated by the user, let&#39;s start clean.
56 // note that this is not related to the persistent state, which is 82 // note that this is not related to the persistent state, which is
57 // appropriately handled in the window code. 83 // appropriately handled in the window code.
58 runApp(false); 84 runApp(false);
59 }); 85 });
60 86
61 chrome.app.runtime.onRestarted.addListener(function() { 87 chrome.app.runtime.onRestarted.addListener(function() {
62 // if restarted, try to get the transient saved state 88 // if restarted, try to get the transient saved state
63 runApp(true); 89 runApp(true);
64 }); 90 });
65 91
66 function runApp(readInitialState) { 92 function runApp(readInitialState) {
67 chrome.app.window.create(&#39;index.html&#39;, 93 chrome.app.window.create(&#39;index.html&#39;,
68 {id: &#39;mainwindow&#39;, bounds: {width: 500, height: 309} }, 94 {id: &#39;mainwindow&#39;, bounds: {width: 500, height: 309} },
69 // the create callback gets a reference to the AppWindow obj 95 // the create callback gets a reference to the AppWindow obj
70 function(win) { 96 function(win) {
71 // when the callback is executed, the DOM is loaded but no script was 97 // when the callback is executed, the DOM is loaded but no script was
72 // loaded yet. So, let&#39;s attach to the load event. 98 // loaded yet. So, let&#39;s attach to the load event.
73 win.contentWindow.addEventListener(&#39;load&#39;, function() { 99 win.contentWindow.addEventListener(&#39;load&#39;, function() {
74 if (readInitialState) { 100 if (readInitialState) {
75 win.contentWindow.setInitialState(); 101 win.contentWindow.setInitialState();
76 } else { 102 } else {
77 win.contentWindow.clearInitialState(); 103 win.contentWindow.clearInitialState();
78 } 104 }
79 }); 105 });
80 }); 106 });
81 } 107 }
82 </pre></li><li>Controller: add to existing <a href="https://github.com/GoogleChr ome/chrome-app-codelab/blob/master/lab6_lifecycle/angularjs/controller.js">contr oller.js</a> 108 </pre>
83 <pre> 109
110 <h3 id="controller">Update controller</h3>
111
112 <p>Add to existing
113 <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/master/lab6_lif ecycle/angularjs/controller.js">AngularJS controller.js</a> or
114 <a href="https://github.com/GoogleChrome/chrome-app-codelab/blob/master/lab6_lif ecycle/javascript/controller.js">JavaScript controller.js</a>:
115 </p>
116
117 <tabs data-group="source">
118
119 <header tabindex="0" data-value="angular">Angular</header>
120 <header tabindex="0" data-value="js">JavaScript</header>
121
122 <content>
123 <pre>
84 var newTodoInput = null; 124 var newTodoInput = null;
85 125
86 var clearInitialState = function() { 126 var clearInitialState = function() {
87 chrome.storage.local.set({&#39;newtodo&#39;: null}); 127 chrome.storage.local.set({&#39;newtodo&#39;: null});
88 } 128 }
89 129
90 var setInitialState = function() { 130 var setInitialState = function() {
91 chrome.storage.local.get(&#39;newtodo&#39;, function(data) { 131 chrome.storage.local.get(&#39;newtodo&#39;, function(data) {
92 if (newTodoInput &amp;&amp; data &amp;&amp; data.newtodo) { 132 if (newTodoInput &amp;&amp; data &amp;&amp; data.newtodo) {
93 newTodoInput.value = data.newtodo; 133 newTodoInput.value = data.newtodo;
94 newTodoInput.focus(); 134 newTodoInput.focus();
95 } 135 }
96 }); 136 });
97 } 137 }
98 138
99 window.addEventListener(&#39;load&#39;, function() { 139 window.addEventListener(&#39;load&#39;, function() {
100 var saveTransientState = function() { 140 var saveTransientState = function() {
101 chrome.storage.local.set({&#39;newtodo&#39;: newTodoInput.value}); 141 chrome.storage.local.set({&#39;newtodo&#39;: newTodoInput.value});
102 }; 142 };
103 newTodoInput = document.querySelector(&#39;input[type=&quot;text&quot;]&#39;); 143 newTodoInput = document.querySelector(&#39;input[type=&quot;text&quot;]&#39;);
104 newTodoInput.addEventListener(&#39;keypress&#39; , function() { 144 newTodoInput.addEventListener(&#39;keypress&#39; , function() {
105 saveTransientState();<br> 145 saveTransientState();<br>
106 }) 146 })
107 }) 147 })
108 </pre></p></li><li><p>Save the changes by reloading the app: open the app, right -click and select Reload.</p></li> 148 </pre>
149 </content>
150 <content>
151 <pre>
152 var newTodoInput = document.querySelector('input[type="text"]');
153
154 window.clearInitialState = function() {
155 chrome.storage.local.set({'newtodo': null});
156 }
157
158 window.setInitialState = function() {
159 chrome.storage.local.get('newtodo', function(data) {
160 if (newTodoInput && data && data.newtodo) {
161 newTodoInput.value = data.newtodo;
162 newTodoInput.focus();
163 }
164 });
165 };
166
167 var saveTransientState = function() {
168 chrome.storage.local.set({'newtodo': newTodoInput.value});
169 };
170
171 newTodoInput.addEventListener('keypress' , function() {
172 saveTransientState();
173 })
174 </pre>
175
176 </tabs>
177
178 <h3 id="results">Check the results</h3>
179
180 <p>Save the changes by reloading the app:
181 open the app, right-click and select Reload.</p>
182
183 <p>If Chrome and the app shuts down for any reason (other than a user-gesture),
184 the <code>onRestarted</code> event is fired.
185 Any text entered in the input field (but not yet saved as a Todo item)
186 will reappear when Chrome and the app are reopened.</p>
187
188 <p>If you get stuck and want to see the app in action,
189 go to <code>chrome://extensions</code>,
190 load the unpacked
191 <a href="https://github.com/GoogleChrome/chrome-app-codelab/tree/master/lab6_lif ecycle/angularjs">AngularJS app</a> or
192 <a href="https://github.com/GoogleChrome/chrome-app-codelab/tree/master/lab6_lif ecycle/javascript">JavaScript app</a>,
193 and launch the app from a new tab.</p>
194
195 <h2 id="takeaways_">Takeaways</h2>
196
197 <ul>
198 <li>The event page may continue to run even when your windows are closed;
199 you can move logic that is shared amoung windows to the event page.</li>
109 </ul> 200 </ul>
110 201
111 <p>If Chrome and the app shuts down for any reason (other than a user-gesture), the <code>onRestarted</code> event is fired. 202 <h2 id="you_should_also_read">You should also read</h2>
112 Any text entered in the input field (but not yet saved as a Todo item) will reap pear when Chrome and the app are reopened.</p>
113 203
114 <p class="note"><b>Note:</b> If you get stuck and want to see the app in action , go to <code>chrome://extensions</code>, 204 <p><a href="http://developer.chrome.com/apps/app_lifecycle.html">Manage App Life cycle</a> tutorial</p>
115 load the unpacked <a href="https://github.com/GoogleChrome/chrome-app-codelab/tr ee/master/lab6_lifecycle">lab6 app</a>, and launch the app from a new tab.</p>
116 205
117 <h1 id="takeaways_">Takeaways:</h1> 206 <h2 id="what_39_s_next_">What's next?</h2>
118 207
119 <ul> 208 <p>In <a href="app_codelab7_useridentification.html">6 - Access User's Data</a>,
120 <li>The event page may continue to run even when your windows are closed. You ca n move logic that is shared among windows to the event page, as we will see in < a href="app_codelab9_multipleviews.html">lab9</a>.</li>
121 </ul>
122
123 <h1 id="what_39_s_next_">What&#39;s next?</h1>
124
125 <p>In <a href="app_codelab7_useridentification.html">lab7_useridentification</a> ,
126 you will learn how to identify users and use OAuth2.0 to access Google and other third party services.</p> 209 you will learn how to identify users and use OAuth2.0 to access Google and other third party services.</p>
127 210
128 <p class="note"><b>Note:</b> The <a href="http://developer.chrome.com/trunk/app s/app_identity.html">identify API</a> covered in lab 7 is still experimental.</p > 211 <p class="note"><b>Note:</b>
212 The next chapter covers a still experimental API.
213 If you don't want to play with experimental APIs, feel free to skip it - the
214 rest of the codelab is independent from it.
215 </p>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698