blob: 5bc68e55872632c78d12f420ebfd8802ed1e091f [file] [log] [blame]
Robert Ly3c4b4f72012-11-30 04:02:04 -08001<!DOCTYPE html>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76<html>
77<head>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -070078
79
80
Robert Ly3c4b4f72012-11-30 04:02:04 -080081<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
82
83<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
84<title>Message.Builder | Android Developers</title>
85
86<!-- STYLESHEETS -->
87<link rel="stylesheet"
Robert Lyf6f5cf42013-02-04 18:24:15 -080088href="//fonts.googleapis.com/css?family=Roboto:regular,medium,thin,italic,mediumitalic,bold" title="roboto">
Robert Ly3c4b4f72012-11-30 04:02:04 -080089<link href="/assets/css/default.css" rel="stylesheet" type="text/css">
90
91
92
93<!-- JAVASCRIPT -->
Dirk Dougherty8a72b6e2013-02-01 15:00:09 -080094<script src="//www.google.com/jsapi" type="text/javascript"></script>
Robert Lyf6f5cf42013-02-04 18:24:15 -080095<script src="/assets/js/android_3p-bundle.js" type="text/javascript"></script>
Robert Ly3c4b4f72012-11-30 04:02:04 -080096<script type="text/javascript">
97 var toRoot = "/";
Robert Lyf6f5cf42013-02-04 18:24:15 -080098 var devsite = false;
Robert Ly3c4b4f72012-11-30 04:02:04 -080099</script>
100<script src="/assets/js/docs.js" type="text/javascript"></script>
101
Robert Lyf6f5cf42013-02-04 18:24:15 -0800102<script type="text/javascript">
103 var _gaq = _gaq || [];
104 _gaq.push(['_setAccount', 'UA-5831155-1']);
105 _gaq.push(['_trackPageview']);
106
107 (function() {
108 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
109 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
110 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
111 })();
112</script>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800113</head>
Robert Ly555c93b2012-12-03 12:24:07 -0800114<body class="gc-documentation google
Robert Ly3c4b4f72012-11-30 04:02:04 -0800115 develop" itemscope itemtype="http://schema.org/Article">
116 <div id="doc-api-level" class="" style="display:none"></div>
117 <a name="top"></a>
118
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700119<a name="top"></a>
120
Robert Ly3c4b4f72012-11-30 04:02:04 -0800121 <!-- Header -->
122 <div id="header">
123 <div class="wrap" id="header-wrap">
124 <div class="col-3 logo">
125 <a href="/index.html">
126 <img src="/assets/images/dac_logo.png" width="123" height="25" alt="Android Developers" />
127 </a>
128 <div class="btn-quicknav" id="btn-quicknav">
129 <a href="#" class="arrow-inactive">Quicknav</a>
130 <a href="#" class="arrow-active">Quicknav</a>
131 </div>
132 </div>
133 <ul class="nav-x col-9">
134 <li class="design">
Robert Ly05c8e632013-02-25 14:43:01 -0800135 <a href="/design/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700136 zh-tw-lang="設計"
137 zh-cn-lang="设计"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800138 ru-lang="Проектирование"
139 ko-lang="디자인"
140 ja-lang="設計"
141 es-lang="Diseñar"
142 >Design</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800143 <li class="develop"><a href="/develop/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700144 zh-tw-lang="開發"
145 zh-cn-lang="开发"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800146 ru-lang="Разработка"
147 ko-lang="개발"
148 ja-lang="開発"
149 es-lang="Desarrollar"
150 >Develop</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800151 <li class="distribute last"><a href="/distribute/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700152 zh-tw-lang="發佈"
153 zh-cn-lang="分发"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800154 ru-lang="Распространение"
155 ko-lang="배포"
156 ja-lang="配布"
157 es-lang="Distribuir"
158 >Distribute</a></li>
159 </ul>
160
161 <!-- New Search -->
162 <div class="menu-container">
163 <div class="moremenu">
164 <div id="more-btn"></div>
165 </div>
166 <div class="morehover" id="moremenu">
167 <div class="top"></div>
168 <div class="mid">
169 <div class="header">Links</div>
170 <ul>
171 <li><a href="https://play.google.com/apps/publish/">Google Play Developer Console</a></li>
172 <li><a href="http://android-developers.blogspot.com/">Android Developers Blog</a></li>
173 <li><a href="/about/index.html">About Android</a></li>
174 </ul>
175 <div class="header">Android Sites</div>
176 <ul>
177 <li><a href="http://www.android.com">Android.com</a></li>
178 <li class="active"><a>Android Developers</a></li>
179 <li><a href="http://source.android.com">Android Open Source Project</a></li>
180 </ul>
Robert Lyf6f5cf42013-02-04 18:24:15 -0800181
Robert Lyf6f5cf42013-02-04 18:24:15 -0800182
183
184 <div class="header">Language</div>
185 <div id="language" class="locales">
186 <select name="language" onChange="changeLangPref(this.value, true)">
187 <option value="en">English</option>
188 <option value="es">Español</option>
189 <option value="ja">日本語</option>
190 <option value="ko">한국어</option>
191 <option value="ru">Русский</option>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700192 <option value="zh-cn">中文 (中国)</option>
193 <option value="zh-tw">中文 (台灣)</option>
Robert Lyf6f5cf42013-02-04 18:24:15 -0800194 </select>
195 </div>
196 <script type="text/javascript">
197 <!--
198 loadLangPref();
199 //-->
200 </script>
201
202
203
204
Robert Ly3c4b4f72012-11-30 04:02:04 -0800205 <br class="clearfix" />
206 </div>
207 <div class="bottom"></div>
208 </div>
209 <div class="search" id="search-container">
210 <div class="search-inner">
211 <div id="search-btn"></div>
212 <div class="left"></div>
213 <form onsubmit="return submit_search()">
214 <input id="search_autocomplete" type="text" value="" autocomplete="off" name="q"
215onfocus="search_focus_changed(this, true)" onblur="search_focus_changed(this, false)"
216onkeydown="return search_changed(event, true, '/')"
217onkeyup="return search_changed(event, false, '/')" />
218 </form>
219 <div class="right"></div>
220 <a class="close hide">close</a>
221 <div class="left"></div>
222 <div class="right"></div>
223 </div>
224 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700225
226 <div class="search_filtered_wrapper reference">
227 <div class="suggest-card reference no-display">
228 <ul class="search_filtered">
229 </ul>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800230 </div>
231 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700232
233 <div class="search_filtered_wrapper docs">
234 <div class="suggest-card dummy no-display">&nbsp;</div>
235 <div class="suggest-card develop no-display">
236 <ul class="search_filtered">
237 </ul>
238 <div class="child-card guides no-display">
239 </div>
240 <div class="child-card training no-display">
241 </div>
242 </div>
243 <div class="suggest-card design no-display">
244 <ul class="search_filtered">
245 </ul>
246 </div>
247 <div class="suggest-card distribute no-display">
248 <ul class="search_filtered">
249 </ul>
250 </div>
251 </div>
252
Robert Ly3c4b4f72012-11-30 04:02:04 -0800253 </div>
254 <!-- /New Search>
255
256
257 <!-- Expanded quicknav -->
258 <div id="quicknav" class="col-9">
259 <ul>
260 <li class="design">
261 <ul>
262 <li><a href="/design/index.html">Get Started</a></li>
263 <li><a href="/design/style/index.html">Style</a></li>
264 <li><a href="/design/patterns/index.html">Patterns</a></li>
265 <li><a href="/design/building-blocks/index.html">Building Blocks</a></li>
266 <li><a href="/design/downloads/index.html">Downloads</a></li>
267 <li><a href="/design/videos/index.html">Videos</a></li>
268 </ul>
269 </li>
270 <li class="develop">
271 <ul>
272 <li><a href="/training/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700273 zh-tw-lang="訓練課程"
274 zh-cn-lang="培训"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800275 ru-lang="Курсы"
276 ko-lang="교육"
277 ja-lang="トレーニング"
278 es-lang="Capacitación"
279 >Training</a></li>
280 <li><a href="/guide/components/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700281 zh-tw-lang="API 指南"
282 zh-cn-lang="API 指南"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800283 ru-lang="Руководства по API"
284 ko-lang="API 가이드"
285 ja-lang="API ガイド"
286 es-lang="Guías de la API"
287 >API Guides</a></li>
288 <li><a href="/reference/packages.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700289 zh-tw-lang="參考資源"
290 zh-cn-lang="参考"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800291 ru-lang="Справочник"
292 ko-lang="참조문서"
293 ja-lang="リファレンス"
294 es-lang="Referencia"
295 >Reference</a></li>
296 <li><a href="/tools/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700297 zh-tw-lang="相關工具"
298 zh-cn-lang="工具"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800299 ru-lang="Инструменты"
300 ko-lang="도구"
301 ja-lang="ツール"
302 es-lang="Herramientas"
303 >Tools</a>
304 <ul><li><a href="/sdk/index.html">Get the SDK</a></li></ul>
305 </li>
306 <li><a href="/google/index.html">Google Services</a>
307 </li>
308 </ul>
309 </li>
310 <li class="distribute last">
311 <ul>
312 <li><a href="/distribute/index.html">Google Play</a></li>
313 <li><a href="/distribute/googleplay/publish/index.html">Publishing</a></li>
314 <li><a href="/distribute/googleplay/promote/index.html">Promoting</a></li>
315 <li><a href="/distribute/googleplay/quality/index.html">App Quality</a></li>
316 <li><a href="/distribute/googleplay/spotlight/index.html">Spotlight</a></li>
317 <li><a href="/distribute/open.html">Open Distribution</a></li>
318 </ul>
319 </li>
320 </ul>
321 </div>
322 <!-- /Expanded quicknav -->
323 </div>
324 </div>
325 <!-- /Header -->
326
327
328 <div id="searchResults" class="wrap" style="display:none;">
329 <h2 id="searchTitle">Results</h2>
330 <div id="leftSearchControl" class="search-control">Loading...</div>
331 </div>
332
333
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700334
Robert Ly3c4b4f72012-11-30 04:02:04 -0800335 <!-- Secondary x-nav -->
336 <div id="nav-x">
337 <div class="wrap">
338 <ul class="nav-x col-9 develop" style="width:100%">
Robert Ly05c8e632013-02-25 14:43:01 -0800339 <li class="training"><a href="/training/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700340 zh-tw-lang="訓練課程"
341 zh-cn-lang="培训"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800342 ru-lang="Курсы"
343 ko-lang="교육"
344 ja-lang="トレーニング"
345 es-lang="Capacitación"
346 >Training</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800347 <li class="guide"><a href="/guide/components/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700348 zh-tw-lang="API 指南"
349 zh-cn-lang="API 指南"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800350 ru-lang="Руководства по API"
351 ko-lang="API 가이드"
352 ja-lang="API ガイド"
353 es-lang="Guías de la API"
354 >API Guides</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800355 <li class="reference"><a href="/reference/packages.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700356 zh-tw-lang="參考資源"
357 zh-cn-lang="参考"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800358 ru-lang="Справочник"
359 ko-lang="참조문서"
360 ja-lang="リファレンス"
361 es-lang="Referencia"
362 >Reference</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800363 <li class="tools"><a href="/tools/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700364 zh-tw-lang="相關工具"
365 zh-cn-lang="工具"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800366 ru-lang="Инструменты"
367 ko-lang="도구"
368 ja-lang="ツール"
369 es-lang="Herramientas"
370 >Tools</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800371 <li class="google"><a href="/google/index.html"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800372 >Google Services</a>
373 </li>
374 </ul>
375 </div>
376
377 </div>
378 <!-- /Sendondary x-nav -->
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700379
380
381
382
Robert Ly3c4b4f72012-11-30 04:02:04 -0800383
384
Robert Ly3c4b4f72012-11-30 04:02:04 -0800385
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700386
387
Robert Ly3c4b4f72012-11-30 04:02:04 -0800388 <div class="wrap clearfix" id="body-content">
389 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
390 <div id="devdoc-nav" class="scroll-pane">
391<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
392
393
394
395<ul id="nav">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700396
Robert Ly3c4b4f72012-11-30 04:02:04 -0800397 <li class="nav-section">
398 <div class="nav-section-header empty"><a href="/google/index.html">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700399 <span class="en">Overview</span>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800400 </a></div>
401 </li>
402
403 <li class="nav-section">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700404 <div class="nav-section-header empty"><a href="/google/play-services/games.html">
405 <span class="en">Games</span>
406 </a></div>
407 </li>
408 <li class="nav-section">
409 <div class="nav-section-header empty"><a href="/google/play-services/location.html">
410 <span class="en">Location</span>
411 </a></div>
412 </li>
413 <li class="nav-section">
414 <div class="nav-section-header empty"><a href="/google/play-services/plus.html">
415 <span class="en">Google+</span>
416 </a></div>
417 </li>
418 <li class="nav-section">
419 <div class="nav-section-header empty"><a href="/google/play-services/maps.html">
420 <span class="en">Google Maps</span>
421 </a></div>
422 </li>
423 <li class="nav-section">
424 <div class="nav-section-header empty"><a href="/google/play-services/auth.html">
425 <span class="en">Authorization</span>
426 </a></div>
427 </li>
428
429
430
431 <li class="nav-section">
Robert Ly3c4b4f72012-11-30 04:02:04 -0800432 <div class="nav-section-header"><a href="/google/play-services/index.html">
Robert Lyd84d5cc2013-01-04 10:13:35 -0800433 <span class="en">Google Play Services</span></a>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800434 </div>
435 <ul>
436 <li><a href="/google/play-services/setup.html">
437 <span class="en">Setup</span></a>
438 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800439 <li id="gms-tree-list" class="nav-section">
440 <div class="nav-section-header">
441 <a href="/reference/gms-packages.html">
442 <span class="en">Reference</span>
443 </a>
444 <div>
445 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800446 </ul>
447 </li>
448
Robert Lyd84d5cc2013-01-04 10:13:35 -0800449
Robert Ly3c4b4f72012-11-30 04:02:04 -0800450 <li class="nav-section">
451 <div class="nav-section-header"><a href="/google/play/billing/index.html">
Robert Ly672b3ad2012-11-30 16:15:46 -0800452 <span class="en">Google Play In-app Billing</span></a>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800453 </div>
454 <ul>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800455 <li><a href="/google/play/billing/billing_overview.html">
456 <span class="en">Overview</span></a>
457 </li>
458 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/api.html">
459 <span class="en">Version 3 API</span></a></div>
460 <ul>
461 <li><a href="/google/play/billing/billing_integrate.html">
462 <span class="en">Implementing the API</span></a></li>
463 <li><a href="/google/play/billing/billing_reference.html">
464 <span class="en">Reference</span></a></li>
465 </ul>
466 </li>
467 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/v2/api.html">
468 <span class="en">Version 2 API</span></a></div>
469 <ul>
470 <li><a href="/google/play/billing/v2/billing_integrate.html">
471 <span class="en">Implementing the API</span></a></li>
472 <li><a href="/google/play/billing/v2/billing_subscriptions.html">
473 <span class="en">Subscriptions</span></a></li>
474 <li><a href="/google/play/billing/v2/billing_reference.html">
475 <span class="en">Reference</span></a></li>
476 </ul>
477 </li>
Robert Ly05c8e632013-02-25 14:43:01 -0800478 <li><a href="/google/play/billing/billing_subscriptions.html">
479 <span class="en">Subscriptions</span></a>
480 </li>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800481 <li><a href="/google/play/billing/billing_best_practices.html">
Robert Ly3c4b4f72012-11-30 04:02:04 -0800482 <span class="en">Security and Design</span></a>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800483 </li>
484 <li><a href="/google/play/billing/billing_testing.html">
Robert Ly4779ffa2012-12-02 17:24:48 -0800485 <span class="en">Testing In-app Billing</span></a>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800486 </li>
487 <li><a href="/google/play/billing/billing_admin.html">
Robert Ly3c4b4f72012-11-30 04:02:04 -0800488 <span class="en">Administering In-app Billing</span></a>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800489 </li>
Dirk Doughertyfe3da792013-06-12 18:06:08 -0700490 <li><a href="/google/play/billing/gp-purchase-status-api.html">
491 <span class="en">Purchase Status API</span></a>
492 </li>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800493 <li><a href="/google/play/billing/versions.html">
494 <span class="en">Version Notes</span></a>
495 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800496 </ul>
497 </li>
498
Dirk Doughertya38ca332013-05-15 02:36:33 -0700499
500
501 <li class="nav-section">
502 <div class="nav-section-header"><a href="/google/gcm/index.html">
503 <span class="en">Google Cloud Messaging</span></a>
504 </div>
505 <ul>
506 <li><a href="/google/gcm/gs.html">
507 <span class="en">Getting Started</span></a>
508 </li>
509 <li><a href="/google/gcm/gcm.html">
510 <span class="en">Architectural Overview</span></a>
511 </li>
Dirk Doughertyfe3da792013-06-12 18:06:08 -0700512 <li><a href="/google/gcm/ccs.html">
513 <span class="en">Cloud Connection Server</span></a>
514 </li>
515 <li><a href="/google/gcm/notifications.html">
516 <span class="en">User Notifications</span></a>
517 </li>
518 <li><a href="/google/gcm/client.html">
519 <span class="en">GCM Client</span></a>
520 </li>
521 <li><a href="/google/gcm/server.html">
522 <span class="en">GCM Server</span></a>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700523 </li>
524 <li><a href="/google/gcm/adv.html">
525 <span class="en">Advanced Topics</span></a>
526 </li>
527 <li><a href="/google/gcm/c2dm.html">
528 <span class="en">Migration</span></a>
529 </li>
530 <li id="gcm-tree-list" class="nav-section">
531 <div class="nav-section-header">
532 <a href="/reference/gcm-packages.html">
533 <span class="en">Reference</span>
534 </a>
535 <div>
536 </li>
537 </ul>
538 </li>
539
Robert Ly3c4b4f72012-11-30 04:02:04 -0800540 <li class="nav-section">
541 <div class="nav-section-header"><a href="/google/play/dist.html">
Robert Ly672b3ad2012-11-30 16:15:46 -0800542 <span class="en">Google Play Distribution</span></a>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800543 </div>
544 <ul>
545 <li><a href="/google/play/filters.html">
546 <span class="en">Filters on Google Play</span></a>
547 </li>
548
549 <li><a href="/google/play/publishing/multiple-apks.html">
550 <span class="en">Multiple APK Support</span></a>
551 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800552 <li><a href="/google/play/expansion-files.html">
553 <span class="en">APK Expansion Files</span></a>
554 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800555 <li class="nav-section">
556 <div class="nav-section-header"><a href="/google/play/licensing/index.html">
557 <span class="en">Application Licensing</span></a>
558 </div>
559 <ul>
560 <li><a href="/google/play/licensing/overview.html">
561 <span class="en">Licensing Overview</span></a>
562 </li>
563 <li><a href="/google/play/licensing/setting-up.html">
564 <span class="en">Setting Up for Licensing</span></a>
565 </li>
566 <li><a href="/google/play/licensing/adding-licensing.html">
567 <span class="en">Adding Licensing to Your App</span></a>
568 </li>
569 <li><a href="/google/play/licensing/licensing-reference.html">
570 <span class="en">Licensing Reference</span></a>
571 </li>
572 </ul>
573 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800574
Robert Lyd84d5cc2013-01-04 10:13:35 -0800575 <li class="nav-section">
576 <div class="nav-section-header"><a href="/google/backup/index.html">
577 Android Backup Service</a>
578 </div>
579 <ul>
580 <li><a href="/google/backup/signup.html">
581 Register</a>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800582 </li>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800583 </ul>
584 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800585
Dirk Doughertya38ca332013-05-15 02:36:33 -0700586 </ul>
587
588</li>
589
590
591
Robert Ly3c4b4f72012-11-30 04:02:04 -0800592</ul>
593
594<script type="text/javascript">
595<!--
596 buildToggleLists();
597 changeNavLang(getLangPref());
598//-->
599</script>
600
601
602
603
604 </div>
605 <script type="text/javascript">
606 showGoogleRefTree();
607
608 </script>
609 </div> <!-- end side-nav -->
610 <script>
611 $(document).ready(function() {
612 scrollIntoView("devdoc-nav");
613 });
614 </script>
615
616
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700617
618
Robert Ly3c4b4f72012-11-30 04:02:04 -0800619
620
621<div class="col-12" id="doc-col">
622
623<div id="api-info-block">
624
625
626
627
628
629
630
631
632
633
634
635<div class="sum-details-links">
636
637Summary:
638
639
640
641
642
643
644
645
646
647 <a href="#pubctors">Ctors</a>
648
649
650
651
652 &#124; <a href="#pubmethods">Methods</a>
653
654
655
656
657 &#124; <a href="#inhmethods">Inherited Methods</a>
658
659&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>
660
661</div><!-- end sum-details-links -->
662<div class="api-level">
663
664
665
666
667</div>
668</div><!-- end api-info-block -->
669
670
671<!-- ======== START OF CLASS DATA ======== -->
672
673<div id="jd-header">
674 public
675 static
676 final
677
678 class
679<h1 itemprop="name">Message.Builder</h1>
680
681
682
683
Robert Ly672b3ad2012-11-30 16:15:46 -0800684 extends Object<br/>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800685
686
687
688
689
690
691
692
693
694</div><!-- end header -->
695
696<div id="naMessage"></div>
697
698<div id="jd-content" class="api apilevel-">
699<table class="jd-inheritance-table">
700
701
702 <tr>
703
Robert Ly672b3ad2012-11-30 16:15:46 -0800704 <td colspan="2" class="jd-inheritance-class-cell">java.lang.Object</td>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800705 </tr>
706
707
708 <tr>
709
710 <td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;&#x21b3;</td>
711
712 <td colspan="1" class="jd-inheritance-class-cell">com.google.android.gcm.server.Message.Builder</td>
713 </tr>
714
715
716</table>
717
718
719
720
721
722
723
724<div class="jd-descr">
725
726
727
728
729
730
731</div><!-- jd-descr -->
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748<div class="jd-descr">
749
750
751<h2>Summary</h2>
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775<!-- ======== CONSTRUCTOR SUMMARY ======== -->
776<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
777
778
779
780
781 <tr class="alt-color api apilevel-" >
782 <td class="jd-typecol"><nobr>
783
784
785
786
787
788 </nobr>
789 </td>
790 <td class="jd-linkcol" width="100%"><nobr>
791 <span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.Builder.html#Message.Builder()">Message.Builder</a></span>()</nobr>
792
793 </td></tr>
794
795
796
797</table>
798
799
800
801
802
803
804<!-- ========== METHOD SUMMARY =========== -->
805<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
806
807
808
809
810 <tr class="alt-color api apilevel-" >
811 <td class="jd-typecol"><nobr>
812
813
814
815
816
817 <a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a></nobr>
818 </td>
819 <td class="jd-linkcol" width="100%"><nobr>
Robert Ly672b3ad2012-11-30 16:15:46 -0800820 <span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.Builder.html#addData(java.lang.String, java.lang.String)">addData</a></span>(String key, String value)</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800821
822 <div class="jd-descrdiv">Adds a key/value pair to the payload data.</div>
823
824 </td></tr>
825
826
827
828 <tr class=" api apilevel-" >
829 <td class="jd-typecol"><nobr>
830
831
832
833
834
835 <a href="/reference/com/google/android/gcm/server/Message.html">Message</a></nobr>
836 </td>
837 <td class="jd-linkcol" width="100%"><nobr>
838 <span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.Builder.html#build()">build</a></span>()</nobr>
839
840 </td></tr>
841
842
843
844 <tr class="alt-color api apilevel-" >
845 <td class="jd-typecol"><nobr>
846
847
848
849
850
851 <a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a></nobr>
852 </td>
853 <td class="jd-linkcol" width="100%"><nobr>
Robert Ly672b3ad2012-11-30 16:15:46 -0800854 <span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.Builder.html#collapseKey(java.lang.String)">collapseKey</a></span>(String value)</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800855
856 <div class="jd-descrdiv">Sets the collapseKey property.</div>
857
858 </td></tr>
859
860
861
862 <tr class=" api apilevel-" >
863 <td class="jd-typecol"><nobr>
864
865
866
867
868
869 <a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a></nobr>
870 </td>
871 <td class="jd-linkcol" width="100%"><nobr>
872 <span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.Builder.html#delayWhileIdle(boolean)">delayWhileIdle</a></span>(boolean value)</nobr>
873
874 <div class="jd-descrdiv">Sets the delayWhileIdle property (default value is false).</div>
875
876 </td></tr>
877
878
879
880 <tr class="alt-color api apilevel-" >
881 <td class="jd-typecol"><nobr>
882
883
884
885
886
887 <a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a></nobr>
888 </td>
889 <td class="jd-linkcol" width="100%"><nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800890 <span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.Builder.html#timeToLive(int)">timeToLive</a></span>(int value)</nobr>
891
892 <div class="jd-descrdiv">Sets the time to live, in seconds.</div>
893
894 </td></tr>
895
896
897
898</table>
899
900
901
902
903
904
905
906<!-- ========== METHOD SUMMARY =========== -->
907<table id="inhmethods" class="jd-sumtable"><tr><th>
908 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
909 <div style="clear:left;">Inherited Methods</div></th></tr>
910
911
912<tr class="api apilevel-" >
913<td colspan="12">
914 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
915 ><img id="inherited-methods-java.lang.Object-trigger"
916 src="/assets/images/triangle-closed.png"
917 class="jd-expando-trigger-img" /></a>
918From class
919
Robert Ly672b3ad2012-11-30 16:15:46 -0800920 java.lang.Object
Robert Ly3c4b4f72012-11-30 04:02:04 -0800921
922<div id="inherited-methods-java.lang.Object">
923 <div id="inherited-methods-java.lang.Object-list"
924 class="jd-inheritedlinks">
925 </div>
926 <div id="inherited-methods-java.lang.Object-summary" style="display: none;">
927 <table class="jd-sumtable-expando">
928
929
930
931
932 <tr class="alt-color api apilevel-" >
933 <td class="jd-typecol"><nobr>
934
935
936
937
938
Robert Ly672b3ad2012-11-30 16:15:46 -0800939 Object</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800940 </td>
941 <td class="jd-linkcol" width="100%"><nobr>
942 <span class="sympad">clone</span>()</nobr>
943
944 </td></tr>
945
946
947
948 <tr class=" api apilevel-" >
949 <td class="jd-typecol"><nobr>
950
951
952
953
954
955 boolean</nobr>
956 </td>
957 <td class="jd-linkcol" width="100%"><nobr>
Robert Ly672b3ad2012-11-30 16:15:46 -0800958 <span class="sympad">equals</span>(Object arg0)</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800959
960 </td></tr>
961
962
963
964 <tr class="alt-color api apilevel-" >
965 <td class="jd-typecol"><nobr>
966
967
968
969
970
971 void</nobr>
972 </td>
973 <td class="jd-linkcol" width="100%"><nobr>
974 <span class="sympad">finalize</span>()</nobr>
975
976 </td></tr>
977
978
979
980 <tr class=" api apilevel-" >
981 <td class="jd-typecol"><nobr>
982
983
984 final
985
986
Robert Ly672b3ad2012-11-30 16:15:46 -0800987 Class&lt;?&gt;</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800988 </td>
989 <td class="jd-linkcol" width="100%"><nobr>
990 <span class="sympad">getClass</span>()</nobr>
991
992 </td></tr>
993
994
995
996 <tr class="alt-color api apilevel-" >
997 <td class="jd-typecol"><nobr>
998
999
1000
1001
1002
1003 int</nobr>
1004 </td>
1005 <td class="jd-linkcol" width="100%"><nobr>
1006 <span class="sympad">hashCode</span>()</nobr>
1007
1008 </td></tr>
1009
1010
1011
1012 <tr class=" api apilevel-" >
1013 <td class="jd-typecol"><nobr>
1014
1015
1016 final
1017
1018
1019 void</nobr>
1020 </td>
1021 <td class="jd-linkcol" width="100%"><nobr>
1022 <span class="sympad">notify</span>()</nobr>
1023
1024 </td></tr>
1025
1026
1027
1028 <tr class="alt-color api apilevel-" >
1029 <td class="jd-typecol"><nobr>
1030
1031
1032 final
1033
1034
1035 void</nobr>
1036 </td>
1037 <td class="jd-linkcol" width="100%"><nobr>
1038 <span class="sympad">notifyAll</span>()</nobr>
1039
1040 </td></tr>
1041
1042
1043
1044 <tr class=" api apilevel-" >
1045 <td class="jd-typecol"><nobr>
1046
1047
1048
1049
1050
Robert Ly672b3ad2012-11-30 16:15:46 -08001051 String</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001052 </td>
1053 <td class="jd-linkcol" width="100%"><nobr>
1054 <span class="sympad">toString</span>()</nobr>
1055
1056 </td></tr>
1057
1058
1059
1060 <tr class="alt-color api apilevel-" >
1061 <td class="jd-typecol"><nobr>
1062
1063
1064 final
1065
1066
1067 void</nobr>
1068 </td>
1069 <td class="jd-linkcol" width="100%"><nobr>
1070 <span class="sympad">wait</span>()</nobr>
1071
1072 </td></tr>
1073
1074
1075
1076 <tr class=" api apilevel-" >
1077 <td class="jd-typecol"><nobr>
1078
1079
1080 final
1081
1082
1083 void</nobr>
1084 </td>
1085 <td class="jd-linkcol" width="100%"><nobr>
1086 <span class="sympad">wait</span>(long arg0, int arg1)</nobr>
1087
1088 </td></tr>
1089
1090
1091
1092 <tr class="alt-color api apilevel-" >
1093 <td class="jd-typecol"><nobr>
1094
1095
1096 final
1097
1098
1099 void</nobr>
1100 </td>
1101 <td class="jd-linkcol" width="100%"><nobr>
1102 <span class="sympad">wait</span>(long arg0)</nobr>
1103
1104 </td></tr>
1105
1106
1107</table>
1108 </div>
1109</div>
1110</td></tr>
1111
1112
1113</table>
1114
1115
1116</div><!-- jd-descr (summary) -->
1117
1118<!-- Details -->
1119
1120
1121
1122
1123
1124
1125
1126
1127<!-- XML Attributes -->
1128
1129
1130<!-- Enum Values -->
1131
1132
1133<!-- Constants -->
1134
1135
1136<!-- Fields -->
1137
1138
1139<!-- Public ctors -->
1140
1141
1142<!-- ========= CONSTRUCTOR DETAIL ======== -->
1143<h2>Public Constructors</h2>
1144
1145
1146
1147<A NAME="Message.Builder()"></A>
1148
1149<div class="jd-details api apilevel-">
1150 <h4 class="jd-details-title">
1151 <span class="normal">
1152 public
1153
1154
1155
1156
1157
1158 </span>
1159 <span class="sympad">Message.Builder</span>
1160 <span class="normal">()</span>
1161 </h4>
1162 <div class="api-level">
1163 <div></div>
1164
1165
1166
1167 </div>
1168 <div class="jd-details-descr">
1169
1170 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1171
1172 </div>
1173</div>
1174
1175
1176
1177
1178
1179<!-- ========= CONSTRUCTOR DETAIL ======== -->
1180<!-- Protected ctors -->
1181
1182
1183
1184<!-- ========= METHOD DETAIL ======== -->
1185<!-- Public methdos -->
1186
1187<h2>Public Methods</h2>
1188
1189
1190
1191<A NAME="addData(java.lang.String, java.lang.String)"></A>
1192
1193<div class="jd-details api apilevel-">
1194 <h4 class="jd-details-title">
1195 <span class="normal">
1196 public
1197
1198
1199
1200
1201 <a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a>
1202 </span>
1203 <span class="sympad">addData</span>
Robert Ly672b3ad2012-11-30 16:15:46 -08001204 <span class="normal">(String key, String value)</span>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001205 </h4>
1206 <div class="api-level">
1207 <div></div>
1208
1209
1210
1211 </div>
1212 <div class="jd-details-descr">
1213
1214 <div class="jd-tagdata jd-tagdescr"><p>Adds a key/value pair to the payload data.
1215</p></div>
1216
1217 </div>
1218</div>
1219
1220
1221<A NAME="build()"></A>
1222
1223<div class="jd-details api apilevel-">
1224 <h4 class="jd-details-title">
1225 <span class="normal">
1226 public
1227
1228
1229
1230
1231 <a href="/reference/com/google/android/gcm/server/Message.html">Message</a>
1232 </span>
1233 <span class="sympad">build</span>
1234 <span class="normal">()</span>
1235 </h4>
1236 <div class="api-level">
1237 <div></div>
1238
1239
1240
1241 </div>
1242 <div class="jd-details-descr">
1243
1244 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1245
1246 </div>
1247</div>
1248
1249
1250<A NAME="collapseKey(java.lang.String)"></A>
1251
1252<div class="jd-details api apilevel-">
1253 <h4 class="jd-details-title">
1254 <span class="normal">
1255 public
1256
1257
1258
1259
1260 <a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a>
1261 </span>
1262 <span class="sympad">collapseKey</span>
Robert Ly672b3ad2012-11-30 16:15:46 -08001263 <span class="normal">(String value)</span>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001264 </h4>
1265 <div class="api-level">
1266 <div></div>
1267
1268
1269
1270 </div>
1271 <div class="jd-details-descr">
1272
1273 <div class="jd-tagdata jd-tagdescr"><p>Sets the collapseKey property.
1274</p></div>
1275
1276 </div>
1277</div>
1278
1279
1280<A NAME="delayWhileIdle(boolean)"></A>
1281
1282<div class="jd-details api apilevel-">
1283 <h4 class="jd-details-title">
1284 <span class="normal">
1285 public
1286
1287
1288
1289
1290 <a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a>
1291 </span>
1292 <span class="sympad">delayWhileIdle</span>
1293 <span class="normal">(boolean value)</span>
1294 </h4>
1295 <div class="api-level">
1296 <div></div>
1297
1298
1299
1300 </div>
1301 <div class="jd-details-descr">
1302
1303 <div class="jd-tagdata jd-tagdescr"><p>Sets the delayWhileIdle property (default value is false).
1304</p></div>
1305
1306 </div>
1307</div>
1308
1309
Robert Ly3c4b4f72012-11-30 04:02:04 -08001310<A NAME="timeToLive(int)"></A>
1311
1312<div class="jd-details api apilevel-">
1313 <h4 class="jd-details-title">
1314 <span class="normal">
1315 public
1316
1317
1318
1319
1320 <a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a>
1321 </span>
1322 <span class="sympad">timeToLive</span>
1323 <span class="normal">(int value)</span>
1324 </h4>
1325 <div class="api-level">
1326 <div></div>
1327
1328
1329
1330 </div>
1331 <div class="jd-details-descr">
1332
1333 <div class="jd-tagdata jd-tagdescr"><p>Sets the time to live, in seconds.
1334</p></div>
1335
1336 </div>
1337</div>
1338
1339
1340
1341
1342
1343<!-- ========= METHOD DETAIL ======== -->
1344
1345
1346
1347<!-- ========= END OF CLASS DATA ========= -->
1348<A NAME="navbar_top"></A>
1349
1350<div id="footer" class="wrap" >
1351
1352
1353 <div id="copyright">
1354
1355 Except as noted, this content is licensed under <a
1356 href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>.
1357 For details and restrictions, see the <a href="/license.html">
1358 Content License</a>.
1359 </div>
Robert Lyf6f5cf42013-02-04 18:24:15 -08001360 <div id="build_info">
1361
1362<script src="/timestamp.js" type="text/javascript"></script>
1363<script>document.write(BUILD_TIMESTAMP)</script>
1364
1365 </div>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001366
1367
1368 <div id="footerlinks">
1369
1370 <p>
1371 <a href="/about/index.html">About Android</a>&nbsp;&nbsp;|&nbsp;
1372 <a href="/legal.html">Legal</a>&nbsp;&nbsp;|&nbsp;
1373 <a href="/support.html">Support</a>
1374 </p>
1375 </div>
1376
1377</div> <!-- end footer -->
1378</div> <!-- jd-content -->
1379
1380</div><!-- end doc-content -->
1381
1382</div> <!-- end body-content -->
1383
1384
1385
1386
Robert Ly3c4b4f72012-11-30 04:02:04 -08001387
1388
1389</body>
1390</html>