@maccesar/titools 5.3.0 → 5.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/CONTRIBUTING.md +1 -1
  2. package/README.md +31 -60
  3. package/agents/ti-pro.md +3 -1
  4. package/commands/ti-audit.md +6 -4
  5. package/docs/examples.md +9 -0
  6. package/docs/knowledge-index.md +2 -1
  7. package/lib/config.js +1 -0
  8. package/package.json +1 -1
  9. package/skills/alloy-guides/SKILL.md +18 -179
  10. package/skills/alloy-guides/references/CLI_TASKS.md +17 -216
  11. package/skills/alloy-guides/references/CONCEPTS.md +27 -162
  12. package/skills/alloy-guides/references/CONTROLLERS.md +38 -236
  13. package/skills/alloy-guides/references/MODELS.md +47 -723
  14. package/skills/alloy-guides/references/MODELS_ADVANCED.md +21 -482
  15. package/skills/alloy-guides/references/VIEWS_DYNAMIC.md +12 -222
  16. package/skills/alloy-guides/references/VIEWS_STYLES.md +39 -358
  17. package/skills/alloy-guides/references/VIEWS_XML.md +36 -552
  18. package/skills/alloy-guides/references/WIDGETS.md +49 -127
  19. package/skills/alloy-howtos/SKILL.md +14 -169
  20. package/skills/alloy-howtos/references/best_practices.md +9 -113
  21. package/skills/alloy-howtos/references/cli_reference.md +18 -223
  22. package/skills/alloy-howtos/references/config_files.md +50 -133
  23. package/skills/alloy-howtos/references/debugging_troubleshooting.md +19 -63
  24. package/skills/alloy-howtos/references/samples.md +21 -138
  25. package/skills/ti-api/SKILL.md +10 -2
  26. package/skills/ti-api/references/api-android.md +36 -2
  27. package/skills/ti-api/references/api-app-platform.md +39 -3
  28. package/skills/ti-api/references/api-core.md +50 -18
  29. package/skills/ti-api/references/api-data-network.md +49 -35
  30. package/skills/ti-api/references/api-media.md +45 -27
  31. package/skills/ti-api/references/api-services.md +39 -9
  32. package/skills/ti-api/references/api-ui-android.md +33 -13
  33. package/skills/ti-api/references/api-ui-extras.md +41 -15
  34. package/skills/ti-api/references/api-ui-ios-animator.md +42 -26
  35. package/skills/ti-api/references/api-ui-ios.md +74 -2
  36. package/skills/ti-api/references/api-ui-lists.md +32 -16
  37. package/skills/ti-api/references/api-ui-text-input.md +34 -17
  38. package/skills/ti-api/references/api-ui-views.md +27 -1
  39. package/skills/ti-api/references/api-ui-windows-navigation.md +32 -18
  40. package/skills/ti-api/references/api-xml-global.md +66 -16
  41. package/skills/ti-create-release/SKILL.md +98 -0
  42. package/skills/ti-create-release/references/module-discovery.md +69 -0
  43. package/skills/ti-expert/references/adaptive-layouts.md +1 -1
  44. package/skills/ti-guides/SKILL.md +37 -76
  45. package/skills/ti-guides/references/advanced-data-and-images.md +122 -126
  46. package/skills/ti-guides/references/android-manifest.md +24 -83
  47. package/skills/ti-guides/references/app-distribution.md +31 -377
  48. package/skills/ti-guides/references/application-frameworks.md +127 -335
  49. package/skills/ti-guides/references/cli-reference.md +184 -633
  50. package/skills/ti-guides/references/commonjs-advanced.md +81 -231
  51. package/skills/ti-guides/references/compatibility-matrix.md +36 -75
  52. package/skills/ti-guides/references/hello-world.md +95 -70
  53. package/skills/ti-guides/references/hyperloop-native-access.md +52 -448
  54. package/skills/ti-guides/references/resources.md +174 -142
  55. package/skills/ti-guides/references/sdk-release-notes.md +28 -71
  56. package/skills/ti-guides/references/tiapp-config.md +222 -598
  57. package/skills/ti-howtos/SKILL.md +23 -123
  58. package/skills/ti-howtos/references/cross-platform-development.md +119 -324
  59. package/skills/ti-howtos/references/debugging-profiling.md +77 -445
  60. package/skills/ti-howtos/references/extending-titanium.md +199 -673
  61. package/skills/ti-howtos/references/local-data-sources.md +87 -300
  62. package/skills/ti-howtos/references/location-and-maps.md +86 -213
  63. package/skills/ti-howtos/references/media-apis.md +103 -223
  64. package/skills/ti-howtos/references/notification-services.md +86 -506
  65. package/skills/ti-howtos/references/remote-data-sources.md +97 -316
  66. package/skills/ti-howtos/references/using-modules.md +77 -133
  67. package/skills/ti-ui/SKILL.md +28 -143
  68. package/skills/ti-ui/references/icons-and-splash-screens.md +74 -403
  69. package/skills/ti-ui/references/layouts-and-positioning.md +175 -402
  70. package/skills/ti-ui/references/listviews-and-performance.md +100 -703
  71. package/skills/ti-ui/references/platform-conventions.md +180 -0
  72. package/skills/ti-ui/references/user-interface.md +43 -0
  73. package/skills/alloy-guides/references/VIEWS_WITHOUT_CONTROLLERS.md +0 -102
  74. package/skills/alloy-howtos/references/custom_tags.md +0 -148
  75. package/skills/ti-guides/references/coding-best-practices.md +0 -149
  76. package/skills/ti-guides/references/javascript-primer.md +0 -414
  77. package/skills/ti-guides/references/reserved-words.md +0 -36
  78. package/skills/ti-guides/references/style-and-conventions.md +0 -103
  79. package/skills/ti-howtos/references/android-platform-deep-dives.md +0 -624
  80. package/skills/ti-howtos/references/automation-fastlane-appium.md +0 -96
  81. package/skills/ti-howtos/references/buffer-codec-streams.md +0 -162
  82. package/skills/ti-howtos/references/google-maps-v2.md +0 -172
  83. package/skills/ti-howtos/references/ios-map-kit.md +0 -149
  84. package/skills/ti-howtos/references/ios-platform-deep-dives.md +0 -611
  85. package/skills/ti-howtos/references/tutorials.md +0 -565
  86. package/skills/ti-howtos/references/web-content-integration.md +0 -287
  87. package/skills/ti-howtos/references/webpack-build-pipeline.md +0 -124
  88. package/skills/ti-ui/references/accessibility-deep-dive.md +0 -288
  89. package/skills/ti-ui/references/animation-and-matrices.md +0 -569
  90. package/skills/ti-ui/references/application-structures.md +0 -626
  91. package/skills/ti-ui/references/custom-fonts-styling.md +0 -549
  92. package/skills/ti-ui/references/event-handling.md +0 -401
  93. package/skills/ti-ui/references/gestures.md +0 -448
  94. package/skills/ti-ui/references/orientation.md +0 -374
  95. package/skills/ti-ui/references/platform-ui-android.md +0 -727
  96. package/skills/ti-ui/references/platform-ui-ios.md +0 -576
  97. package/skills/ti-ui/references/scrolling-views.md +0 -288
  98. package/skills/ti-ui/references/tableviews.md +0 -542
@@ -1,156 +1,39 @@
1
- # Alloy samples
1
+ # Current Alloy examples
2
2
 
3
- ## Kitchen sink
3
+ For a full maintained app, use [KitchenSink-v2](https://github.com/tidev/kitchensink-v2).
4
4
 
5
- See the [KitchenSink-v2 application on GitHub](https://github.com/tidev/kitchensink-v2) for Alloy samples in a full app.
5
+ ## A working screen
6
6
 
7
- ## Controller sample
8
-
9
- **index.js**
10
- ```javascript
11
- // These "builtin" requires are detected by alloy compile process
12
- // Automatically included as Resources/alloy/animation.js and Resources/alloy/string.js
13
- const animation = require('alloy/animation');
14
- const string = require('alloy/string');
15
-
16
- function shake(e) {
17
- animation.shake($.mover, 0, () => {
18
- alert("Shake ended.");
19
- });
20
- }
21
-
22
- function flash(e) {
23
- animation.flash($.mover);
24
- }
25
-
26
- function trim(e) {
27
- $.label.text = string.trim($.label.text);
28
- }
29
-
30
- if (OS_IOS) {
31
- function flip(e) {
32
- let front, back;
33
- e.bubbleParent = false;
34
- if (e.source === $.back) {
35
- front = $.back;
36
- back = $.front;
37
- } else {
38
- front = $.front;
39
- back = $.back;
40
- }
41
- animation.flipHorizontal(front, back, 500, (e) => {
42
- Ti.API.info('flipped');
43
- });
44
- }
45
- }
46
-
47
- $.index.open();
48
-
49
- // Runtime unit tests
50
- if (!ENV_PROD) {
51
- require('specs/index')($);
52
- }
53
- ```
54
-
55
- ## Conditional statements in views
56
-
57
- Alloy separates business logic (controllers) from UI definition (XML/TSS). A common challenge is showing or hiding content based on app state (for example, login status).
58
-
59
- > **💡 TSS defaults**
60
- > The samples below assume some additional TSS: views and windows use a vertical layout, and the `View` tag has a default height and width of `Ti.UI.SIZE`.
61
-
62
- ### Problems with traditional approaches
63
-
64
- **Approach 1: show/hide (in controller)**
65
- ```javascript
66
- if (Alloy.Globals.isLoggedIn()) {
67
- $.loggedIn.show();
68
- $.notLoggedIn.hide();
69
- } else {
70
- $.loggedIn.hide();
71
- $.notLoggedIn.show();
72
- }
73
- ```
74
- **Problem:** Both views render when the window opens. If the user isn't logged in, there is empty space where the logged-in view was.
75
-
76
- **Approach 2: setHeight (in controller)**
77
- ```javascript
78
- if (Alloy.Globals.isLoggedIn()) {
79
- $.loggedIn.setHeight(Ti.UI.SIZE);
80
- $.notLoggedIn.setHeight(0);
81
- } else {
82
- $.loggedIn.setHeight(0);
83
- $.notLoggedIn.setHeight(Ti.UI.SIZE);
84
- }
85
- ```
86
- **Problem:** This works, but it forces you to manage height values (`Ti.UI.SIZE`) in JavaScript instead of TSS.
87
-
88
- ### Solution: IF attributes in XML
89
-
90
- Use `if` attributes directly in the XML view. These conditions are evaluated before rendering.
91
-
92
- **index.xml**
93
7
  ```xml
8
+ <!-- app/views/index.xml -->
94
9
  <Alloy>
95
10
  <Window>
96
- <View>
97
- <!-- Only one of these will ever be rendered -->
98
- <View if="Alloy.Globals.isLoggedIn()" id="notLoggedIn" class="vertical">
99
- <Label text="Not logged in" />
100
- </View>
101
- <View if="!Alloy.Globals.isLoggedIn()" id="loggedIn" class="vertical">
102
- <Label text="Logged in" />
103
- </View>
104
- </View>
11
+ <Label id="label" top="80">Tap the button</Label>
12
+ <Button id="button" top="140" onClick="sayHello">Say hello</Button>
105
13
  </Window>
106
14
  </Alloy>
107
15
  ```
108
16
 
109
- Benefits:
110
- - Only the view that matches the condition is rendered.
111
- - The UI is correct from the first frame.
112
- - No visibility logic in controllers.
113
-
114
- ### Conditional queries in TSS
115
-
116
- Use `if` attributes in TSS definitions:
117
-
118
17
  ```tss
119
- "#info[if=Alloy.Globals.isIos7Plus]": {
120
- font: {
121
- textStyle: Ti.UI.TEXT_STYLE_FOOTNOTE
122
- }
18
+ // app/styles/index.tss
19
+ "Window": {
20
+ backgroundColor: "backgroundColor"
123
21
  },
124
- "#title[if=Alloy.Globals.isIos7Plus]": {
125
- top: "25dp",
126
- font: {
127
- textStyle: Ti.UI.TEXT_STYLE_HEADLINE
128
- }
129
- },
130
- "#content[if=Alloy.Globals.isIos7Plus]": {
131
- font: {
132
- textStyle: Ti.UI.TEXT_STYLE_CAPTION1
133
- }
134
- },
135
- "ScrollView[if=Alloy.Globals.iPhoneTall]": {
136
- height: "500dp"
22
+ "#label": {
23
+ color: "textColor"
137
24
  }
138
25
  ```
139
26
 
140
- ### Data-binding with conditional queries
141
-
142
- Define custom methods in models and render based on those methods:
27
+ ```javascript
28
+ // app/controllers/index.js
29
+ function sayHello() {
30
+ $.label.text = 'Hello from Titanium';
31
+ }
32
+ $.index.open();
33
+ ```
143
34
 
144
- **Model Method:** `shouldShowCommentRow()` returns `true`
35
+ The semantic color names must exist in `app/assets/semantic.colors.json`; they resolve differently in light and dark mode. Rebuild and tap the button. Use `ti build --platform android --liveview` to reload JavaScript changes while iterating.
145
36
 
146
- **XML View:**
147
- ```xml
148
- <Alloy>
149
- <TableViewRow id="commentRow" hasChild="false" if="$model.shouldShowCommentRow()" onClick="onSelectComment">
150
- <Label id="commentPlaceholderLabel" class="commentRowPreviewLabel placeholderLabel" text="Ti.App.L('AddComment')" />
151
- <Label id="commentRowLabel" class="commentRowPreviewLabel" text="{Comment}" />
152
- </TableViewRow>
153
- </Alloy>
154
- ```
37
+ For a complete persistent list with model definition, XML binding, filtering, transformation, fetch and cleanup, read [models and collections](../../alloy-guides/references/MODELS.md). For a reusable component, read [widgets](../../alloy-guides/references/WIDGETS.md).
155
38
 
156
- See `VIEWS_STYLES.md` in the `alloy-guides` skill (Custom Query Styles section) for more details.
39
+ Sources: [first app](https://titaniumsdk.com/docs/build/first-app.md), [models](https://titaniumsdk.com/docs/alloy/models.md), [widgets](https://titaniumsdk.com/docs/alloy/widgets.md).
@@ -7,7 +7,7 @@ description: 'Use when looking up properties, methods, events, constants, or typ
7
7
 
8
8
  ## Overview
9
9
 
10
- API reference for the Titanium SDK and TiDev-maintained modules. Use it to look up properties, methods, events, constants, and type signatures across ~360 APIs grouped into 20 reference files.
10
+ API reference for the Titanium SDK and TiDev-maintained modules. Use it to look up properties, methods, events, constants, and type signatures across 305 types grouped into 20 reference files.
11
11
 
12
12
  ## When to use
13
13
 
@@ -30,7 +30,15 @@ Do NOT use for:
30
30
 
31
31
  1. Identify which namespace the API belongs to.
32
32
  2. Look up the matching reference file in the table below.
33
- 3. Read the reference file for full property / method / event tables.
33
+ 3. Read the reference file for condensed property / method / event tables. Read the complete release-specific API contract when an example or platform behavior depends on details the table abbreviates.
34
+
35
+ ## Release scope and authoritative contracts
36
+
37
+ The core SDK tables are anchored to **13.4.1.GA**. Match the app's selected SDK before using a contract: `/docs/sdk` is the general API index, while [the 13.4.1 API index](https://titaniumsdk.com/docs/sdk/13.4.1) is explicitly release-scoped. Do not treat the general index or an unreleased `main` API as a feature of the installed GA.
38
+
39
+ For a core type, use its complete name in the release URL, for example [Titanium.UI.Window in 13.4.1](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Window). The canonical source is the matching YAML under [tidev/titanium-sdk, tag 13_4_1_GA, apidoc](https://github.com/tidev/titanium-sdk/tree/13_4_1_GA/apidoc). Complete descriptions, examples, inherited contracts, permission/setup requirements and version restrictions take precedence over a shortened table summary. A table's em dash does not by itself distinguish a null default from an undocumented one. Method rows abbreviate parameter names; optionality, parameter types/defaults and event payload fields require the complete contract. Generated factory methods accept an optional creation dictionary.
40
+
41
+ `Modules.*` types belong to independently versioned native modules. Verify their own module release and documentation; the core SDK's version does not establish a Map, BLE, NFC or other module's behavior. For guide material use [tidev/titaniumsdk.com](https://github.com/tidev/titaniumsdk.com), which owns the current website. The old titanium-docs repository is historical provenance only, excluded from the current guide content.
34
42
 
35
43
  ## Namespace lookup
36
44
 
@@ -24,6 +24,8 @@
24
24
  <!-- TOC-END -->
25
25
 
26
26
  ## Ti.Android
27
+ > Full released contract: [Titanium.Android](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android)
28
+
27
29
  > The top-level Android module.
28
30
  > Extends Ti.Module
29
31
  > Platforms: android
@@ -181,6 +183,8 @@
181
183
  ---
182
184
 
183
185
  ## Ti.Android.ActionBar
186
+ > Full released contract: [Titanium.Android.ActionBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.ActionBar)
187
+
184
188
  > An action bar is a window feature that identifies the application and user location, and provides user actions and navigation modes.
185
189
  > Extends Ti.Proxy
186
190
  > Platforms: android
@@ -214,6 +218,8 @@
214
218
  ---
215
219
 
216
220
  ## Ti.Android.Activity
221
+ > Full released contract: [Titanium.Android.Activity](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.Activity)
222
+
217
223
  > The Titanium binding of an Android Activity.
218
224
  > Extends Ti.Proxy
219
225
  > Platforms: android
@@ -262,6 +268,8 @@
262
268
  ---
263
269
 
264
270
  ## Ti.Android.BigPictureStyle
271
+ > Full released contract: [Titanium.Android.BigPictureStyle](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.BigPictureStyle)
272
+
265
273
  > Helper object for generating large-format notifications that include a large image attachment.
266
274
  > Extends Ti.Proxy
267
275
  > Platforms: android
@@ -281,6 +289,8 @@
281
289
  ---
282
290
 
283
291
  ## Ti.Android.BigTextStyle
292
+ > Full released contract: [Titanium.Android.BigTextStyle](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.BigTextStyle)
293
+
284
294
  > Helper object for generating large-format notifications that include a lot of text.
285
295
  > Extends Ti.Proxy
286
296
  > Platforms: android
@@ -298,6 +308,8 @@
298
308
  ---
299
309
 
300
310
  ## Ti.Android.BroadcastReceiver
311
+ > Full released contract: [Titanium.Android.BroadcastReceiver](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.BroadcastReceiver)
312
+
301
313
  > Monitor and handle Android system broadcasts.
302
314
  > Extends Ti.Proxy
303
315
  > Platforms: android
@@ -314,6 +326,8 @@
314
326
  ---
315
327
 
316
328
  ## Ti.Android.Intent
329
+ > Full released contract: [Titanium.Android.Intent](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.Intent)
330
+
317
331
  > Message objects passed between Android application components.
318
332
  > Extends Ti.Proxy
319
333
  > Platforms: android
@@ -350,6 +364,8 @@
350
364
  ---
351
365
 
352
366
  ## Ti.Android.Menu
367
+ > Full released contract: [Titanium.Android.Menu](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.Menu)
368
+
353
369
  > The Titanium binding of an Android Options Menu.
354
370
  > Extends Ti.Proxy
355
371
  > Platforms: android
@@ -366,8 +382,8 @@
366
382
  | add(options) | Ti.Android.MenuItem | android | Creates a <Titanium.Android.MenuItem> from the pa… |
367
383
  | clear(—) | void | android | Clears all items from this menu. |
368
384
  | close(—) | void | android | Closes the menu, if visible. |
369
- | findItem(item) | Ti.Android.MenuItem | android | Locates a [MenuItem](Titanium.Android.MenuItem) i… |
370
- | getItem(index) | Ti.Android.MenuItem | android | Returns the [MenuItem](Titanium.Android.MenuItem)… |
385
+ | findItem(item) | Ti.Android.MenuItem | android | Locates a [MenuItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.MenuItem) i… |
386
+ | getItem(index) | Ti.Android.MenuItem | android | Returns the [MenuItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.MenuItem)… |
371
387
  | hasVisibleItems(—) | Boolean | android | Returns `true` if this menu has visible items. |
372
388
  | removeGroup(groupId) | void | android | Removes all menu items with the specified [groupI… |
373
389
  | removeItem(itemId) | void | android | Removes a specific [MenuItem](Titanium.Android.Me… |
@@ -379,6 +395,8 @@
379
395
  ---
380
396
 
381
397
  ## Ti.Android.MenuItem
398
+ > Full released contract: [Titanium.Android.MenuItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.MenuItem)
399
+
382
400
  > The Titanium binding of an Android menu item.
383
401
  > Extends Ti.Proxy
384
402
  > Platforms: android
@@ -429,6 +447,8 @@
429
447
  ---
430
448
 
431
449
  ## Ti.Android.Notification
450
+ > Full released contract: [Titanium.Android.Notification](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.Notification)
451
+
432
452
  > UI notifications that can be sent while the application is in the background.
433
453
  > Extends Ti.Proxy
434
454
  > Platforms: android
@@ -475,6 +495,8 @@
475
495
  ---
476
496
 
477
497
  ## Ti.Android.NotificationChannel
498
+ > Full released contract: [Titanium.Android.NotificationChannel](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.NotificationChannel)
499
+
478
500
  > Module for notification channels.
479
501
  > Extends Ti.Proxy
480
502
  > Platforms: android
@@ -502,6 +524,8 @@
502
524
  ---
503
525
 
504
526
  ## Ti.Android.NotificationManager
527
+ > Full released contract: [Titanium.Android.NotificationManager](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.NotificationManager)
528
+
505
529
  > Module for managing notifications.
506
530
  > Extends Ti.Module
507
531
  > Platforms: android
@@ -537,6 +561,8 @@
537
561
  ---
538
562
 
539
563
  ## Ti.Android.PendingIntent
564
+ > Full released contract: [Titanium.Android.PendingIntent](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.PendingIntent)
565
+
540
566
  > The Titanium binding of an Android `PendingIntent`.
541
567
  > Extends Ti.Proxy
542
568
  > Platforms: android
@@ -554,6 +580,8 @@
554
580
  ---
555
581
 
556
582
  ## Ti.Android.QuickSettingsService
583
+ > Full released contract: [Titanium.Android.QuickSettingsService](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.QuickSettingsService)
584
+
557
585
  > Android service for creating custom quick settings tiles and handling user's interaction with them.
558
586
  > Extends Ti.Android.Service
559
587
  > Platforms: android
@@ -598,6 +626,8 @@
598
626
  ---
599
627
 
600
628
  ## Ti.Android.R
629
+ > Full released contract: [Titanium.Android.R](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.R)
630
+
601
631
  > The Titanium binding of the native Android `R` class, giving access to Android system-wide resources or application resources.
602
632
  > Extends Ti.Proxy
603
633
  > Platforms: android
@@ -634,6 +664,8 @@
634
664
  ---
635
665
 
636
666
  ## Ti.Android.RemoteViews
667
+ > Full released contract: [Titanium.Android.RemoteViews](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.RemoteViews)
668
+
637
669
  > The Titanium binding of [Android RemoteViews](https://developer.android.com/reference/android/widget/RemoteViews.html).
638
670
  > Extends Ti.Proxy
639
671
  > Platforms: android
@@ -666,6 +698,8 @@
666
698
  ---
667
699
 
668
700
  ## Ti.Android.Service
701
+ > Full released contract: [Titanium.Android.Service](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Android.Service)
702
+
669
703
  > Android application component that executes in the background.
670
704
  > Extends Ti.Proxy
671
705
  > Platforms: android
@@ -25,6 +25,8 @@
25
25
  <!-- TOC-END -->
26
26
 
27
27
  ## Ti.App
28
+ > Full released contract: [Titanium.App](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App)
29
+
28
30
  > The top-level App module is mainly used for accessing information about the application at runtime, and for sending or listening for system events.
29
31
  > Extends Ti.Module
30
32
  > Platforms: both
@@ -87,6 +89,8 @@
87
89
  ---
88
90
 
89
91
  ## Ti.App.Android
92
+ > Full released contract: [Titanium.App.Android](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.Android)
93
+
90
94
  > A module used to access Android application resources.
91
95
  > Extends Ti.Module
92
96
  > Platforms: android
@@ -114,6 +118,8 @@
114
118
  ---
115
119
 
116
120
  ## Ti.App.Properties
121
+ > Full released contract: [Titanium.App.Properties](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.Properties)
122
+
117
123
  > The App Properties module is used for storing application-related data in property/value pairs that persist beyond application sessions and device power cycles.
118
124
  > Extends Ti.Module
119
125
  > Platforms: both
@@ -148,6 +154,8 @@
148
154
  ---
149
155
 
150
156
  ## Ti.App.iOS
157
+ > Full released contract: [Titanium.App.iOS](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS)
158
+
151
159
  > The top-level App iOS module, available only to iOS devices, that includes the facilities to create and manage local notifications and background services.
152
160
  > Extends Ti.Module
153
161
  > Platforms: ios
@@ -217,11 +225,11 @@
217
225
  | remotenotificationaction | ios | Fired when a user selects an action for an interactive remote notification. |
218
226
  | backgroundfetch | ios | Fired when the application is woken up for a fetch operation. Available only on… |
219
227
  | silentpush | ios | Fired when the application is woken up by a silent remote notification. Availab… |
220
- | backgroundtransfer | ios | Fired when the events related to a [urlSession](Modules.URLSession) are waiting… |
228
+ | backgroundtransfer | ios | Fired when the events related to a [urlSession](api-modules-coremotion-urlsession.md#modulesurlsession) are waiting… |
221
229
  | downloadprogress | ios | Fired periodically to inform the app about the download's progress of a [urlSes… |
222
230
  | uploadprogress | ios | Fired periodically to inform the app about the upload's progress of a [urlSessi… |
223
- | downloadcompleted | ios | Fired to indicate that a [urlSession's](Modules.URLSession) download task has f… |
224
- | sessioncompleted | ios | Fired to indicate that a [urlSession](Modules.URLSession) task finished transfe… |
231
+ | downloadcompleted | ios | Fired to indicate that a [urlSession's](api-modules-coremotion-urlsession.md#modulesurlsession) download task has f… |
232
+ | sessioncompleted | ios | Fired to indicate that a [urlSession](api-modules-coremotion-urlsession.md#modulesurlsession) task finished transfe… |
225
233
  | sessioneventscompleted | ios | Fired to indicate that all messages enqueued for a [urlSession](Modules.URLSess… |
226
234
  | usernotificationsettings | ios | Fired when the user notification settings are registered. |
227
235
  | watchkitextensionrequest | ios | Fired when openParentApplication:reply is called from a WatchKit extension. Ava… |
@@ -234,6 +242,8 @@
234
242
  ---
235
243
 
236
244
  ## Ti.App.iOS.BackgroundService
245
+ > Full released contract: [Titanium.App.iOS.BackgroundService](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.BackgroundService)
246
+
237
247
  > A service that runs when the application is placed in the background.
238
248
  > Extends Ti.Proxy
239
249
  > Platforms: ios
@@ -254,6 +264,8 @@
254
264
  ---
255
265
 
256
266
  ## Ti.App.iOS.LocalNotification
267
+ > Full released contract: [Titanium.App.iOS.LocalNotification](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.LocalNotification)
268
+
257
269
  > A local notification to alert the user of new or pending application information.
258
270
  > Extends Ti.Proxy
259
271
  > Platforms: ios
@@ -268,6 +280,8 @@
268
280
  ---
269
281
 
270
282
  ## Ti.App.iOS.SearchQuery
283
+ > Full released contract: [Titanium.App.iOS.SearchQuery](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.SearchQuery)
284
+
271
285
  > A search query object manages the criteria to apply when searching app content that you have previously indexed by using the Core Spotlight APIs.
272
286
  > Extends Ti.Proxy
273
287
  > Platforms: ios
@@ -295,6 +309,8 @@
295
309
  ---
296
310
 
297
311
  ## Ti.App.iOS.SearchableIndex
312
+ > Full released contract: [Titanium.App.iOS.SearchableIndex](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.SearchableIndex)
313
+
298
314
  > The SearchableIndex module is used to add or remove Ti.App.iOS.SearchableItem objects from the device search index.
299
315
  > Extends Ti.Proxy
300
316
  > Platforms: ios
@@ -313,6 +329,8 @@
313
329
  ---
314
330
 
315
331
  ## Ti.App.iOS.SearchableItem
332
+ > Full released contract: [Titanium.App.iOS.SearchableItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.SearchableItem)
333
+
316
334
  > Used to create a unique object containing all of the search information that will appear in the device search index.
317
335
  > Extends Ti.Proxy
318
336
  > Platforms: ios
@@ -331,6 +349,8 @@
331
349
  ---
332
350
 
333
351
  ## Ti.App.iOS.SearchableItemAttributeSet
352
+ > Full released contract: [Titanium.App.iOS.SearchableItemAttributeSet](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.SearchableItemAttributeSet)
353
+
334
354
  > The SearchableItemAttributeSet module defines metadata properties for SearchItem and UserActivity objects.
335
355
  > Extends Ti.Proxy
336
356
  > Platforms: ios
@@ -439,6 +459,8 @@
439
459
  ---
440
460
 
441
461
  ## Ti.App.iOS.UserActivity
462
+ > Full released contract: [Titanium.App.iOS.UserActivity](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.UserActivity)
463
+
442
464
  > The UserActivity module is used to enable device Handoff and to create User Activities.
443
465
  > Extends Ti.Proxy
444
466
  > Platforms: ios
@@ -483,6 +505,8 @@
483
505
  ---
484
506
 
485
507
  ## Ti.App.iOS.UserDefaults
508
+ > Full released contract: [Titanium.App.iOS.UserDefaults](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.UserDefaults)
509
+
486
510
  > The UserDefaults module is used for storing application-related data in property/value pairs that persist beyond application sessions and device power cycles. UserDefaults allows the suiteName of the UserDefaults to be specified at creation time. **Important**: Using this API requires the `NSPrivacyAccessedAPICategoryUserDefaults` property set in the privacy manifest that was introduced in iOS 17. You can learn more about it [here](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api).
487
511
  > Extends Ti.App.Properties
488
512
  > Platforms: ios
@@ -499,6 +523,8 @@
499
523
  ---
500
524
 
501
525
  ## Ti.App.iOS.UserNotificationAction
526
+ > Full released contract: [Titanium.App.iOS.UserNotificationAction](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.UserNotificationAction)
527
+
502
528
  > An action the user selects in response to an interactive notification.
503
529
  > Extends Ti.Proxy
504
530
  > Platforms: ios
@@ -519,6 +545,8 @@
519
545
  ---
520
546
 
521
547
  ## Ti.App.iOS.UserNotificationCategory
548
+ > Full released contract: [Titanium.App.iOS.UserNotificationCategory](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.UserNotificationCategory)
549
+
522
550
  > A set of notification actions to associate with a notification.
523
551
  > Extends Ti.Proxy
524
552
  > Platforms: ios
@@ -540,6 +568,8 @@
540
568
  ---
541
569
 
542
570
  ## Ti.App.iOS.UserNotificationCenter
571
+ > Full released contract: [Titanium.App.iOS.UserNotificationCenter](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.App.iOS.UserNotificationCenter)
572
+
543
573
  > The top-level App iOS Notification Center module. It is used to control scheduled notifications and receive details about the system-wide notification settings.
544
574
  > Extends Ti.Module
545
575
  > Platforms: ios
@@ -559,6 +589,8 @@
559
589
  ---
560
590
 
561
591
  ## Ti.Platform
592
+ > Full released contract: [Titanium.Platform](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Platform)
593
+
562
594
  > The top-level Platform module. The Platform module is used to access the device's platform-related functionality.
563
595
  > Extends Ti.Module
564
596
  > Platforms: both
@@ -618,6 +650,8 @@
618
650
  ---
619
651
 
620
652
  ## Ti.Platform.Android
653
+ > Full released contract: [Titanium.Platform.Android](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Platform.Android)
654
+
621
655
  > The Android-specific Platform module, used to access the device's platform-related functionality.
622
656
  > Extends Ti.Module
623
657
  > Platforms: android
@@ -638,6 +672,8 @@
638
672
  ---
639
673
 
640
674
  ## Ti.Platform.DisplayCaps
675
+ > Full released contract: [Titanium.Platform.DisplayCaps](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Platform.DisplayCaps)
676
+
641
677
  > The Display Caps object returned by the <Titanium.Platform.displayCaps> property.
642
678
  > Extends Ti.Proxy
643
679
  > Platforms: both