summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/templates/articles/api_index.html
blob: 3b1f7b930e26e49f69468d7c2c02dd8746e8d337 (plain)
1
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
<h1 class="page_title">chrome.* APIs</h1>
{{?is_apps}}
<p class="doc-family apps">
Chrome provides many special-purpose APIs like
<code>chrome.runtime</code> and <code>chrome.alarms</code>
to packaged apps.
</p>
{{:is_apps}}
<p class="doc-family extensions">
Chrome provides APIs such as
<code>chrome.bookmarks</code> and <code>chrome.tab</code>
so that extensions can interact with the browser.
</p>
{{/is_apps}}

<h2 id="supported">Supported APIs</h2>

<p>
Here are the supported chrome.* APIs:
</p>

<ul>
  {{?is_apps}}
  {{#api_list.apps.chrome}}
  <li><a href="{{name}}.html">{{name}}</a></li>
  {{/}}
  {{:is_apps}}
  {{#api_list.extensions.chrome}}
  <li><a href="{{name}}.html">{{name}}</a></li>
  {{/}}
  {{/is_apps}}
</ul>

<h2 id="experimental">Experimental APIs</h2>

<p>
Chrome also has
<a href="experimental.html">experimental APIs</a>,
some of which will become supported APIs
in future releases of Chrome.
</p>

<h2 id="conventions">API conventions</h2>

<p>
Unless the doc says otherwise,
methods in the chrome.* APIs are <b>asynchronous</b>:
they return immediately,
without waiting for the operation to finish.
If you need to know the outcome of an operation,
then you pass a callback function into the method.
For more information, watch this video:
</p>

{{^is_apps}}
<p class="doc-family extensions">
<iframe title="YouTube video player" width="640" height="390" src="http://www.youtube.com/embed/bmxr75CV36A?rel=0" frameborder="0" allowfullscreen></iframe>
</p>
{{/is_apps}}