@maccesar/titools 5.2.5 → 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.
- package/CONTRIBUTING.md +1 -1
- package/README.md +58 -97
- package/agents/ti-pro.md +4 -2
- package/commands/ti-audit.md +7 -5
- package/docs/examples.md +24 -13
- package/docs/knowledge-index.md +2 -1
- package/lib/config.js +1 -0
- package/package.json +1 -1
- package/skills/alloy-guides/SKILL.md +18 -179
- package/skills/alloy-guides/references/CLI_TASKS.md +17 -216
- package/skills/alloy-guides/references/CONCEPTS.md +27 -162
- package/skills/alloy-guides/references/CONTROLLERS.md +38 -236
- package/skills/alloy-guides/references/MODELS.md +47 -723
- package/skills/alloy-guides/references/MODELS_ADVANCED.md +21 -482
- package/skills/alloy-guides/references/VIEWS_DYNAMIC.md +12 -222
- package/skills/alloy-guides/references/VIEWS_STYLES.md +39 -358
- package/skills/alloy-guides/references/VIEWS_XML.md +36 -552
- package/skills/alloy-guides/references/WIDGETS.md +49 -127
- package/skills/alloy-howtos/SKILL.md +14 -169
- package/skills/alloy-howtos/references/best_practices.md +9 -113
- package/skills/alloy-howtos/references/cli_reference.md +18 -223
- package/skills/alloy-howtos/references/config_files.md +50 -133
- package/skills/alloy-howtos/references/debugging_troubleshooting.md +19 -63
- package/skills/alloy-howtos/references/samples.md +21 -138
- package/skills/ti-api/SKILL.md +10 -2
- package/skills/ti-api/references/api-android.md +36 -2
- package/skills/ti-api/references/api-app-platform.md +39 -3
- package/skills/ti-api/references/api-core.md +50 -18
- package/skills/ti-api/references/api-data-network.md +49 -35
- package/skills/ti-api/references/api-media.md +45 -27
- package/skills/ti-api/references/api-services.md +39 -9
- package/skills/ti-api/references/api-ui-android.md +33 -13
- package/skills/ti-api/references/api-ui-extras.md +41 -15
- package/skills/ti-api/references/api-ui-ios-animator.md +42 -26
- package/skills/ti-api/references/api-ui-ios.md +74 -2
- package/skills/ti-api/references/api-ui-lists.md +32 -16
- package/skills/ti-api/references/api-ui-text-input.md +34 -17
- package/skills/ti-api/references/api-ui-views.md +27 -1
- package/skills/ti-api/references/api-ui-windows-navigation.md +32 -18
- package/skills/ti-api/references/api-xml-global.md +66 -16
- package/skills/ti-create-release/SKILL.md +98 -0
- package/skills/ti-create-release/references/module-discovery.md +69 -0
- package/skills/ti-expert/references/adaptive-layouts.md +1 -1
- package/skills/ti-guides/SKILL.md +37 -76
- package/skills/ti-guides/references/advanced-data-and-images.md +122 -126
- package/skills/ti-guides/references/android-manifest.md +24 -83
- package/skills/ti-guides/references/app-distribution.md +31 -377
- package/skills/ti-guides/references/application-frameworks.md +127 -335
- package/skills/ti-guides/references/cli-reference.md +184 -633
- package/skills/ti-guides/references/commonjs-advanced.md +81 -231
- package/skills/ti-guides/references/compatibility-matrix.md +36 -75
- package/skills/ti-guides/references/hello-world.md +95 -70
- package/skills/ti-guides/references/hyperloop-native-access.md +52 -448
- package/skills/ti-guides/references/resources.md +174 -142
- package/skills/ti-guides/references/sdk-release-notes.md +28 -71
- package/skills/ti-guides/references/tiapp-config.md +222 -598
- package/skills/ti-howtos/SKILL.md +23 -123
- package/skills/ti-howtos/references/cross-platform-development.md +119 -324
- package/skills/ti-howtos/references/debugging-profiling.md +77 -445
- package/skills/ti-howtos/references/extending-titanium.md +199 -673
- package/skills/ti-howtos/references/local-data-sources.md +87 -300
- package/skills/ti-howtos/references/location-and-maps.md +86 -213
- package/skills/ti-howtos/references/media-apis.md +103 -223
- package/skills/ti-howtos/references/notification-services.md +86 -506
- package/skills/ti-howtos/references/remote-data-sources.md +97 -316
- package/skills/ti-howtos/references/using-modules.md +77 -133
- package/skills/ti-synthengine/SKILL.md +62 -111
- package/skills/ti-synthengine/assets/example/README.md +50 -59
- package/skills/ti-synthengine/assets/example/app.js +67 -65
- package/skills/ti-synthengine/assets/example/lib/sequenceOwner.js +39 -40
- package/skills/ti-synthengine/assets/example/lib/soundPreset.js +34 -0
- package/skills/ti-synthengine/assets/index.d.ts +122 -2
- package/skills/ti-synthengine/references/advanced-examples.md +4 -4
- package/skills/ti-synthengine/references/api.md +40 -18
- package/skills/ti-synthengine/references/audio-engine.md +15 -57
- package/skills/ti-synthengine/references/examples.md +63 -6
- package/skills/ti-synthengine/references/guide.md +61 -57
- package/skills/ti-synthengine/references/instruments-and-effects.md +15 -15
- package/skills/ti-synthengine/references/native-variation.md +53 -14
- package/skills/ti-synthengine/references/recipes-interaction.md +25 -20
- package/skills/ti-synthengine/references/recipes.md +19 -16
- package/skills/ti-synthengine/references/recommendations.md +12 -12
- package/skills/ti-synthengine/references/sound-api.md +197 -0
- package/skills/ti-synthengine/references/sound-design.md +7 -7
- package/skills/ti-synthengine/references/source-notes.md +62 -172
- package/skills/ti-synthengine/references/troubleshooting.md +17 -19
- package/skills/ti-synthengine/references/upgrade-2.0.0.md +40 -0
- package/skills/ti-ui/SKILL.md +28 -143
- package/skills/ti-ui/references/icons-and-splash-screens.md +74 -403
- package/skills/ti-ui/references/layouts-and-positioning.md +175 -402
- package/skills/ti-ui/references/listviews-and-performance.md +100 -703
- package/skills/ti-ui/references/platform-conventions.md +180 -0
- package/skills/ti-ui/references/user-interface.md +43 -0
- package/skills/alloy-guides/references/VIEWS_WITHOUT_CONTROLLERS.md +0 -102
- package/skills/alloy-howtos/references/custom_tags.md +0 -148
- package/skills/ti-guides/references/coding-best-practices.md +0 -149
- package/skills/ti-guides/references/javascript-primer.md +0 -414
- package/skills/ti-guides/references/reserved-words.md +0 -36
- package/skills/ti-guides/references/style-and-conventions.md +0 -103
- package/skills/ti-howtos/references/android-platform-deep-dives.md +0 -624
- package/skills/ti-howtos/references/automation-fastlane-appium.md +0 -96
- package/skills/ti-howtos/references/buffer-codec-streams.md +0 -162
- package/skills/ti-howtos/references/google-maps-v2.md +0 -172
- package/skills/ti-howtos/references/ios-map-kit.md +0 -149
- package/skills/ti-howtos/references/ios-platform-deep-dives.md +0 -611
- package/skills/ti-howtos/references/tutorials.md +0 -565
- package/skills/ti-howtos/references/web-content-integration.md +0 -287
- package/skills/ti-howtos/references/webpack-build-pipeline.md +0 -124
- package/skills/ti-synthengine/references/android-sim80-correction-evidence.zip +0 -0
- package/skills/ti-synthengine/references/android-sim80-correction.json +0 -162
- package/skills/ti-synthengine/references/audio-pipeline-validation.md +0 -19
- package/skills/ti-synthengine/references/bypass-physical-recheck-evidence.zip +0 -0
- package/skills/ti-synthengine/references/frontier-android-evidence.zip +0 -0
- package/skills/ti-synthengine/references/frontier-ipad-evidence.zip +0 -0
- package/skills/ti-synthengine/references/frontier-physical-validation.json +0 -1918
- package/skills/ti-synthengine/references/native-tone-repetition-validation.md +0 -59
- package/skills/ti-synthengine/references/native-variation-proposal.md +0 -182
- package/skills/ti-synthengine/references/native-variation-validation.md +0 -63
- package/skills/ti-synthengine/references/performance-review-evidence.zip +0 -0
- package/skills/ti-synthengine/references/performance-review.json +0 -1146
- package/skills/ti-synthengine/references/physical-validation.json +0 -1457
- package/skills/ti-synthengine/references/source-snapshot.json +0 -542
- package/skills/ti-synthengine/references/stats-performance.json +0 -2992
- package/skills/ti-synthengine/references/stats-performance.md +0 -82
- package/skills/ti-synthengine/references/studio-validation.json +0 -6202
- package/skills/ti-synthengine/references/unified-bypass-performance.json +0 -22425
- package/skills/ti-synthengine/references/unified-validation.json +0 -314
- package/skills/ti-ui/references/accessibility-deep-dive.md +0 -288
- package/skills/ti-ui/references/animation-and-matrices.md +0 -569
- package/skills/ti-ui/references/application-structures.md +0 -626
- package/skills/ti-ui/references/custom-fonts-styling.md +0 -549
- package/skills/ti-ui/references/event-handling.md +0 -401
- package/skills/ti-ui/references/gestures.md +0 -448
- package/skills/ti-ui/references/orientation.md +0 -374
- package/skills/ti-ui/references/platform-ui-android.md +0 -727
- package/skills/ti-ui/references/platform-ui-ios.md +0 -576
- package/skills/ti-ui/references/scrolling-views.md +0 -288
- package/skills/ti-ui/references/tableviews.md +0 -542
|
@@ -16,6 +16,8 @@
|
|
|
16
16
|
<!-- TOC-END -->
|
|
17
17
|
|
|
18
18
|
## Ti.Media
|
|
19
|
+
> Full released contract: [Titanium.Media](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media)
|
|
20
|
+
|
|
19
21
|
> The top-level Media module.
|
|
20
22
|
> Extends Ti.Module
|
|
21
23
|
> Platforms: both
|
|
@@ -170,7 +172,7 @@ The Media module is used to access the device's media-related functionality, suc
|
|
|
170
172
|
| success | Boolean | both | Indicates if the operation succeeded. Returns `true`. |
|
|
171
173
|
| error | String | both | Error message, if any returned. |
|
|
172
174
|
| code | Number | both | Error code. Returns 0. |
|
|
173
|
-
| media | Ti.Blob | both | The media object, as a [Blob](Titanium.Blob). |
|
|
175
|
+
| media | Ti.Blob | both | The media object, as a [Blob](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Blob). |
|
|
174
176
|
| path | String | android | The path of the image when returning data from the gallery. |
|
|
175
177
|
| mediaType | String | both | The type of media, either `MEDIA_TYPE_PHOTO`, `MEDIA_TYPE_LIVEPHOTO` or `MEDIA_… |
|
|
176
178
|
| cropRect | Dimension | both | Simple object defining the user's selected crop rectangle, or `null` if the use… |
|
|
@@ -198,7 +200,7 @@ The Media module is used to access the device's media-related functionality, suc
|
|
|
198
200
|
| height | Number | android | Height of the preview camera image |
|
|
199
201
|
|
|
200
202
|
#### CameraOptionsType
|
|
201
|
-
> Simple object for specifying options to [showCamera](Titanium.Media
|
|
203
|
+
> Simple object for specifying options to [showCamera](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media).
|
|
202
204
|
|
|
203
205
|
| Property | Type | Platform | Description |
|
|
204
206
|
|----------|------|----------|-------------|
|
|
@@ -287,7 +289,7 @@ The Media module is used to access the device's media-related functionality, suc
|
|
|
287
289
|
| podcastPersistentID | MediaQueryInfoType \| Number | ios | The podcast persistent ID to filter on. Value should be a Number. |
|
|
288
290
|
|
|
289
291
|
#### MusicLibraryOptionsType
|
|
290
|
-
> Simple object for specifying options to [openMusicLibrary](Titanium.Media
|
|
292
|
+
> Simple object for specifying options to [openMusicLibrary](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media).
|
|
291
293
|
|
|
292
294
|
| Property | Type | Platform | Description |
|
|
293
295
|
|----------|------|----------|-------------|
|
|
@@ -300,7 +302,7 @@ The Media module is used to access the device's media-related functionality, suc
|
|
|
300
302
|
| allowMultipleSelections | Boolean | ios | Set to `true` to allow the user to select multiple items from the library. |
|
|
301
303
|
|
|
302
304
|
#### MusicLibraryResponseType
|
|
303
|
-
> Simple object passed to the [openMusicLibrary](Titanium.Media
|
|
305
|
+
> Simple object passed to the [openMusicLibrary](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media) `success` callback function.
|
|
304
306
|
|
|
305
307
|
| Property | Type | Platform | Description |
|
|
306
308
|
|----------|------|----------|-------------|
|
|
@@ -309,7 +311,7 @@ The Media module is used to access the device's media-related functionality, suc
|
|
|
309
311
|
| types | Number | both | Media types in this collection, represented as the bitwise OR of the media type… |
|
|
310
312
|
|
|
311
313
|
#### PhotoGalleryOptionsType
|
|
312
|
-
> Simple object for specifying options to [openPhotoGallery](Titanium.Media
|
|
314
|
+
> Simple object for specifying options to [openPhotoGallery](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media).
|
|
313
315
|
|
|
314
316
|
| Property | Type | Platform | Description |
|
|
315
317
|
|----------|------|----------|-------------|
|
|
@@ -385,6 +387,8 @@ Also referenced by this API, documented elsewhere: `Dictionary`.
|
|
|
385
387
|
---
|
|
386
388
|
|
|
387
389
|
## Ti.Media.Android
|
|
390
|
+
> Full released contract: [Titanium.Media.Android](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Android)
|
|
391
|
+
|
|
388
392
|
> Android-specific media-related functionality.
|
|
389
393
|
> Extends Ti.Module
|
|
390
394
|
> Platforms: android
|
|
@@ -401,11 +405,13 @@ Also referenced by this API, documented elsewhere: `Dictionary`.
|
|
|
401
405
|
---
|
|
402
406
|
|
|
403
407
|
## Ti.Media.AudioPlayer
|
|
408
|
+
> Full released contract: [Titanium.Media.AudioPlayer](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer)
|
|
409
|
+
|
|
404
410
|
> An audio player object used for streaming audio to the device, and low-level control of the audio playback.
|
|
405
411
|
> Extends Ti.Proxy
|
|
406
412
|
> Platforms: both
|
|
407
413
|
|
|
408
|
-
On Android, when you are done playing a given audio file, you must call the [release](Titanium.Media.AudioPlayer
|
|
414
|
+
On Android, when you are done playing a given audio file, you must call the [release](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) method to stop buffering audio data and release associated system resources. Since 7.5.0, this method is available on iOS as well and will release all audio-player related resources. After this method has been called, the object should not be accessed anymore.
|
|
409
415
|
|
|
410
416
|
On iOS, you can control how the audio stream interacts with other system sounds by setting <Titanium.Media.audioSessionCategory>. Since Titanium 7.5.0, this API uses the [AVPlayer API](https://developer.apple.com/documentation/avfoundation/avplayer) for a more modern and performant audio playback.
|
|
411
417
|
|
|
@@ -444,19 +450,19 @@ Use the <Titanium.Media.createAudioPlayer> method to create an audio player.
|
|
|
444
450
|
### Methods (14)
|
|
445
451
|
| Method | Returns | Platform | Description |
|
|
446
452
|
|--------|---------|----------|-------------|
|
|
447
|
-
| getPaused(—) | Boolean | ios | Returns the value of the [paused](Titanium.Media.AudioPlayer
|
|
448
|
-
| isPaused(—) | Boolean | android | Returns the value of the [paused](Titanium.Media.AudioPlayer
|
|
449
|
-
| getPlaying(—) | Boolean | ios | Returns the value of the [playing](Titanium.Media.AudioPlayer
|
|
450
|
-
| isPlaying(—) | Boolean | android | Returns the value of the [playing](Titanium.Media.AudioPlayer
|
|
453
|
+
| getPaused(—) | Boolean | ios | Returns the value of the [paused](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) property. |
|
|
454
|
+
| isPaused(—) | Boolean | android | Returns the value of the [paused](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) property. |
|
|
455
|
+
| getPlaying(—) | Boolean | ios | Returns the value of the [playing](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) property. |
|
|
456
|
+
| isPlaying(—) | Boolean | android | Returns the value of the [playing](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) property. |
|
|
451
457
|
| pause(—) | void | both | Pauses audio playback. |
|
|
452
458
|
| play(—) | void | android | Starts or resumes audio playback. |
|
|
453
|
-
| setPaused(paused) | void | ios | Sets the value of the [paused](Titanium.Media.AudioPlayer
|
|
459
|
+
| setPaused(paused) | void | ios | Sets the value of the [paused](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) property. |
|
|
454
460
|
| seekToTime(time) | void | ios | Moves the playback cursor and invokes the specified block when the seek operati… |
|
|
455
461
|
| release(—) | void | both | Stops buffering audio data and releases audio resources. |
|
|
456
462
|
| getAudioSessionId(—) | Number | android | Returns the audio session id. |
|
|
457
463
|
| start(—) | void | both | Starts or resumes audio playback. |
|
|
458
464
|
| restart(—) | void | both | Restarts (stops and stars) audio playback. |
|
|
459
|
-
| stateDescription(state) | String | ios | Converts a [state](Titanium.Media.AudioPlayer
|
|
465
|
+
| stateDescription(state) | String | ios | Converts a [state](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) value into a text descript… |
|
|
460
466
|
| stop(—) | void | both | Stops audio playback. |
|
|
461
467
|
|
|
462
468
|
### Events (6)
|
|
@@ -467,11 +473,13 @@ Use the <Titanium.Media.createAudioPlayer> method to create an audio player.
|
|
|
467
473
|
| metadata | ios | Fired when the timed metadata was encountered most recently within the media as… |
|
|
468
474
|
| error | both | Fired when there's an error. |
|
|
469
475
|
| progress | both | Fired once per second with the current progress during playback. |
|
|
470
|
-
| seek | ios | Fired once the [seekToTime](Titanium.Media.AudioPlayer
|
|
476
|
+
| seek | ios | Fired once the [seekToTime](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) method completes. |
|
|
471
477
|
|
|
472
478
|
---
|
|
473
479
|
|
|
474
480
|
## Ti.Media.AudioRecorder
|
|
481
|
+
> Full released contract: [Titanium.Media.AudioRecorder](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioRecorder)
|
|
482
|
+
|
|
475
483
|
> An audio recorder object used for recording audio from the device microphone.
|
|
476
484
|
> Extends Ti.Proxy
|
|
477
485
|
> Platforms: both
|
|
@@ -505,13 +513,15 @@ Ensure to request the permissions for audio-recording before starting a new reco
|
|
|
505
513
|
---
|
|
506
514
|
|
|
507
515
|
## Ti.Media.Item
|
|
508
|
-
>
|
|
516
|
+
> Full released contract: [Titanium.Media.Item](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Item)
|
|
517
|
+
|
|
518
|
+
> A representation of a media item returned by [openMusicLibrary](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media) or [queryMusicLibrary](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media).
|
|
509
519
|
> Extends Ti.Proxy
|
|
510
520
|
> Platforms: ios
|
|
511
521
|
|
|
512
522
|
This is a read-only object that describes a single media item, not a playlist. Titanium does not support access to playlists.
|
|
513
523
|
|
|
514
|
-
`Item` objects cannot be created explicitly. The [openMusicLibrary](Titanium.Media
|
|
524
|
+
`Item` objects cannot be created explicitly. The [openMusicLibrary](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media) returns `Item` objects in its `success` callback function, while [queryMusicLibrary](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media) returns an array of `Item` objects.
|
|
515
525
|
|
|
516
526
|
### Properties (unique: 36/38)
|
|
517
527
|
| Property | Type | Default | Platform | Description |
|
|
@@ -559,11 +569,13 @@ This is a read-only object that describes a single media item, not a playlist. T
|
|
|
559
569
|
---
|
|
560
570
|
|
|
561
571
|
## Ti.Media.MusicPlayer
|
|
572
|
+
> Full released contract: [Titanium.Media.MusicPlayer](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.MusicPlayer)
|
|
573
|
+
|
|
562
574
|
> This object represents a music controller.
|
|
563
575
|
> Extends Ti.Proxy
|
|
564
576
|
> Platforms: ios
|
|
565
577
|
|
|
566
|
-
A `MusicPlayer` lets you manage and playback a queue of media [Item](Titanium.Media.Item) objects.
|
|
578
|
+
A `MusicPlayer` lets you manage and playback a queue of media [Item](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Item) objects.
|
|
567
579
|
|
|
568
580
|
To retrieve an instance of a MusicPlayer object, use either the
|
|
569
581
|
|
|
@@ -600,11 +612,13 @@ To retrieve an instance of a MusicPlayer object, use either the
|
|
|
600
612
|
---
|
|
601
613
|
|
|
602
614
|
## Ti.Media.Sound
|
|
615
|
+
> Full released contract: [Titanium.Media.Sound](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Sound)
|
|
616
|
+
|
|
603
617
|
> An object for playing basic audio resources.
|
|
604
618
|
> Extends Ti.Proxy
|
|
605
619
|
> Platforms: both
|
|
606
620
|
|
|
607
|
-
The `Sound` object loads the entire media resource in memory before playing. If you need to support streaming, use the [AudioPlayer](Titanium.Media.AudioPlayer) API.
|
|
621
|
+
The `Sound` object loads the entire media resource in memory before playing. If you need to support streaming, use the [AudioPlayer](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.AudioPlayer) API.
|
|
608
622
|
|
|
609
623
|
You can control how the sound interacts with other system sounds by setting <Titanium.Media.audioSessionCategory>.
|
|
610
624
|
|
|
@@ -635,15 +649,15 @@ Use the <Titanium.Media.createSound> method to create a `Sound` object. You can
|
|
|
635
649
|
### Methods (10)
|
|
636
650
|
| Method | Returns | Platform | Description |
|
|
637
651
|
|--------|---------|----------|-------------|
|
|
638
|
-
| isLooping(—) | Boolean | both | Returns the value of the [looping](Titanium.Media.Sound
|
|
639
|
-
| isPaused(—) | Boolean | both | Returns the value of the [paused](Titanium.Media.Sound
|
|
640
|
-
| isPlaying(—) | Boolean | both | Returns the value of the [playing](Titanium.Media.Sound
|
|
652
|
+
| isLooping(—) | Boolean | both | Returns the value of the [looping](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Sound) property. |
|
|
653
|
+
| isPaused(—) | Boolean | both | Returns the value of the [paused](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Sound) property. |
|
|
654
|
+
| isPlaying(—) | Boolean | both | Returns the value of the [playing](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Sound) property. |
|
|
641
655
|
| pause(—) | void | both | Pauses the audio. |
|
|
642
656
|
| play(—) | void | both | Starting playing the sound, or resume playing a paused sound. |
|
|
643
657
|
| release(—) | void | both | Releases all internal resources. |
|
|
644
658
|
| reset(—) | void | both | Resets the audio playback position to the beginning. |
|
|
645
|
-
| setLooping(looping) | void | both | Sets the value of the [looping](Titanium.Media.Sound
|
|
646
|
-
| setPaused(paused) | void | ios | Sets the value of the [paused](Titanium.Media.Sound
|
|
659
|
+
| setLooping(looping) | void | both | Sets the value of the [looping](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Sound) property. |
|
|
660
|
+
| setPaused(paused) | void | ios | Sets the value of the [paused](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.Sound) property. |
|
|
647
661
|
| stop(—) | void | both | Stops playing the audio and resets the playback position to the beginning of th… |
|
|
648
662
|
|
|
649
663
|
### Events (5)
|
|
@@ -658,6 +672,8 @@ Use the <Titanium.Media.createSound> method to create a `Sound` object. You can
|
|
|
658
672
|
---
|
|
659
673
|
|
|
660
674
|
## Ti.Media.SystemAlert
|
|
675
|
+
> Full released contract: [Titanium.Media.SystemAlert](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.SystemAlert)
|
|
676
|
+
|
|
661
677
|
> An object for playing system sounds.
|
|
662
678
|
> Extends Ti.Proxy
|
|
663
679
|
> Platforms: ios
|
|
@@ -687,6 +703,8 @@ Know more about [System Sound Services](https://developer.apple.com/reference/au
|
|
|
687
703
|
---
|
|
688
704
|
|
|
689
705
|
## Ti.Media.VideoPlayer
|
|
706
|
+
> Full released contract: [Titanium.Media.VideoPlayer](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.VideoPlayer)
|
|
707
|
+
|
|
690
708
|
> A native control for playing videos.
|
|
691
709
|
> Extends Ti.UI.View
|
|
692
710
|
> Platforms: both
|
|
@@ -695,14 +713,14 @@ The video player is a native view that can be used to play videos, either stored
|
|
|
695
713
|
|
|
696
714
|
Use the <Titanium.Media.createVideoPlayer> method to create a video player.
|
|
697
715
|
|
|
698
|
-
All platforms support specifying the video content as a URL, either to a local file or a remote stream. This is done by setting the [url](Titanium.Media.VideoPlayer
|
|
716
|
+
All platforms support specifying the video content as a URL, either to a local file or a remote stream. This is done by setting the [url](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.VideoPlayer) property.
|
|
699
717
|
|
|
700
718
|
### iOS Implementation Notes
|
|
701
719
|
|
|
702
|
-
On iOS, video content can also be specified as a [Blob](Titanium.Blob) or [File](Titanium.Filesystem.File) object using the [media](Titanium.Media.VideoPlayer
|
|
720
|
+
On iOS, video content can also be specified as a [Blob](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Blob) or [File](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File) object using the [media](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.VideoPlayer) property.
|
|
703
721
|
|
|
704
722
|
|
|
705
|
-
|
|
723
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Media.VideoPlayer API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.VideoPlayer).
|
|
706
724
|
|
|
707
725
|
### Properties (unique: 27/99)
|
|
708
726
|
| Property | Type | Default | Platform | Description |
|
|
@@ -758,9 +776,9 @@ On iOS, video content can also be specified as a [Blob](Titanium.Blob) or [File]
|
|
|
758
776
|
| durationavailable | both | Fired when the video duration is available. |
|
|
759
777
|
| error | both | Fired when movie playback encounters an error. |
|
|
760
778
|
| load | both | Fired when the movie play loads. |
|
|
761
|
-
| loadstate | both | Fired when the network [loadState](Titanium.Media.VideoPlayer
|
|
779
|
+
| loadstate | both | Fired when the network [loadState](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.VideoPlayer) change… |
|
|
762
780
|
| naturalsizeavailable | ios | Fired when the natural size of the current movie is determined. |
|
|
763
|
-
| playbackstate | both | Fired when the [playbackState](Titanium.Media.VideoPlayer
|
|
781
|
+
| playbackstate | both | Fired when the [playbackState](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Media.VideoPlayer) change… |
|
|
764
782
|
| playing | both | Fired when the currently playing movie changes. |
|
|
765
783
|
| preload | android | Fired when the movie has preloaded and is ready to play. |
|
|
766
784
|
| resize | ios | Fired when the movie player is resized. |
|
|
@@ -22,6 +22,8 @@
|
|
|
22
22
|
<!-- TOC-END -->
|
|
23
23
|
|
|
24
24
|
## Ti.Calendar
|
|
25
|
+
> Full released contract: [Titanium.Calendar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar)
|
|
26
|
+
|
|
25
27
|
> The Calendar module provides an API for accessing the native calendar functionality.
|
|
26
28
|
> Extends Ti.Module
|
|
27
29
|
> Platforms: both
|
|
@@ -32,7 +34,7 @@ Modifying or deleting existing events and creating recurring events are only sup
|
|
|
32
34
|
|
|
33
35
|
### Android
|
|
34
36
|
On Android, calendar permissions must be explicitly configured in `tiapp.xml` in order to access the
|
|
35
|
-
calendar and you have to use [requestCalendarPermissions](Titanium.Calendar
|
|
37
|
+
calendar and you have to use [requestCalendarPermissions](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar)
|
|
36
38
|
to request runtime permissions.
|
|
37
39
|
|
|
38
40
|
|
|
@@ -79,6 +81,8 @@ to request runtime permissions.
|
|
|
79
81
|
---
|
|
80
82
|
|
|
81
83
|
## Ti.Calendar.Alert
|
|
84
|
+
> Full released contract: [Titanium.Calendar.Alert](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.Alert)
|
|
85
|
+
|
|
82
86
|
> An object that represents a single alert for an event in an calendar.
|
|
83
87
|
> Extends Ti.Proxy
|
|
84
88
|
> Platforms: both
|
|
@@ -102,6 +106,8 @@ to request runtime permissions.
|
|
|
102
106
|
---
|
|
103
107
|
|
|
104
108
|
## Ti.Calendar.Attendee
|
|
109
|
+
> Full released contract: [Titanium.Calendar.Attendee](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.Attendee)
|
|
110
|
+
|
|
105
111
|
> An object that represents a single attendee of an event.
|
|
106
112
|
> Extends Ti.Proxy
|
|
107
113
|
> Platforms: ios
|
|
@@ -127,6 +133,8 @@ The type declares `platforms: [iphone, ipad, macos]`, but four of its properties
|
|
|
127
133
|
---
|
|
128
134
|
|
|
129
135
|
## Ti.Calendar.Calendar
|
|
136
|
+
> Full released contract: [Titanium.Calendar.Calendar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.Calendar)
|
|
137
|
+
|
|
130
138
|
> An object that represents a single calendar.
|
|
131
139
|
> Extends Ti.Proxy
|
|
132
140
|
> Platforms: both
|
|
@@ -160,6 +168,8 @@ The type declares `platforms: [iphone, ipad, macos]`, but four of its properties
|
|
|
160
168
|
---
|
|
161
169
|
|
|
162
170
|
## Ti.Calendar.Event
|
|
171
|
+
> Full released contract: [Titanium.Calendar.Event](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.Event)
|
|
172
|
+
|
|
163
173
|
> An object that represents a single event in a calendar.
|
|
164
174
|
> Extends Ti.Proxy
|
|
165
175
|
> Platforms: both
|
|
@@ -216,15 +226,17 @@ See <Titanium.Calendar> for examples of retrieving event information and creatin
|
|
|
216
226
|
---
|
|
217
227
|
|
|
218
228
|
## Ti.Calendar.RecurrenceRule
|
|
229
|
+
> Full released contract: [Titanium.Calendar.RecurrenceRule](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.RecurrenceRule)
|
|
230
|
+
|
|
219
231
|
> An object that is used to describe the recurrence pattern for a recurring event.
|
|
220
232
|
> Extends Ti.Proxy
|
|
221
233
|
> Platforms: both
|
|
222
234
|
|
|
223
235
|
On Android there is no option to have multiple recurrence rules set for the same event.
|
|
224
|
-
Android always uses only the first element in the array passed to [recurrenceRules](Titanium.Calendar.Event
|
|
236
|
+
Android always uses only the first element in the array passed to [recurrenceRules](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.Event).
|
|
225
237
|
|
|
226
|
-
In case of having [daysOfTheWeek](Titanium.Calendar.RecurrenceRule
|
|
227
|
-
for an event with a recurrence rule of type [RECURRENCEFREQUENCY_MONTHLY](Titanium.Calendar
|
|
238
|
+
In case of having [daysOfTheWeek](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.RecurrenceRule) and [daysOfTheMonth](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.RecurrenceRule)
|
|
239
|
+
for an event with a recurrence rule of type [RECURRENCEFREQUENCY_MONTHLY](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar) only
|
|
228
240
|
[daysOfTheWeek] will be used.
|
|
229
241
|
|
|
230
242
|
### Properties (unique: 10/13)
|
|
@@ -257,6 +269,8 @@ for an event with a recurrence rule of type [RECURRENCEFREQUENCY_MONTHLY](Titani
|
|
|
257
269
|
---
|
|
258
270
|
|
|
259
271
|
## Ti.Calendar.Reminder
|
|
272
|
+
> Full released contract: [Titanium.Calendar.Reminder](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Calendar.Reminder)
|
|
273
|
+
|
|
260
274
|
> An object that represents a single reminder for an event in a calendar.
|
|
261
275
|
> Extends Ti.Proxy
|
|
262
276
|
> Platforms: android
|
|
@@ -280,6 +294,8 @@ reminders for events.
|
|
|
280
294
|
---
|
|
281
295
|
|
|
282
296
|
## Ti.Contacts
|
|
297
|
+
> Full released contract: [Titanium.Contacts](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Contacts)
|
|
298
|
+
|
|
283
299
|
> The top-level Contacts module, used for accessing and modifying the system contacts address book.
|
|
284
300
|
> Extends Ti.Module
|
|
285
301
|
> Platforms: both
|
|
@@ -294,14 +310,14 @@ On iOS, the contacts database may be modified by an external application, causin
|
|
|
294
310
|
not guaranteed to remain the same, so updating an object when it is out of sync may have
|
|
295
311
|
unpredictable results.
|
|
296
312
|
|
|
297
|
-
To avoid this, listen for the [reload](Titanium.Contacts
|
|
313
|
+
To avoid this, listen for the [reload](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Contacts) event. When you receive a
|
|
298
314
|
`reload` event, you should assume that any existing `Person` or `Group` objects are invalid and
|
|
299
315
|
reload them from the `Contacts` module before modifying them.
|
|
300
316
|
|
|
301
317
|
See the examples for a sample use of the `reload` event.
|
|
302
318
|
|
|
303
319
|
|
|
304
|
-
|
|
320
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Contacts API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Contacts).
|
|
305
321
|
|
|
306
322
|
### Properties (unique: 2/12)
|
|
307
323
|
| Property | Type | Default | Platform | Description |
|
|
@@ -354,6 +370,8 @@ See the examples for a sample use of the `reload` event.
|
|
|
354
370
|
---
|
|
355
371
|
|
|
356
372
|
## Ti.Contacts.Group
|
|
373
|
+
> Full released contract: [Titanium.Contacts.Group](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Contacts.Group)
|
|
374
|
+
|
|
357
375
|
> An object which represents a group in the system contacts address book.
|
|
358
376
|
> Extends Ti.Proxy
|
|
359
377
|
> Platforms: ios
|
|
@@ -381,6 +399,8 @@ These APIs are unavailable on macOS if the app is built on a version of Xcode <
|
|
|
381
399
|
---
|
|
382
400
|
|
|
383
401
|
## Ti.Contacts.Person
|
|
402
|
+
> Full released contract: [Titanium.Contacts.Person](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Contacts.Person)
|
|
403
|
+
|
|
384
404
|
> An object that represents a contact record for a person or organization in the system contacts address book.
|
|
385
405
|
> Extends Ti.Proxy
|
|
386
406
|
> Platforms: both
|
|
@@ -401,7 +421,7 @@ Support for adding and modifying properties is currently supported on iOS and An
|
|
|
401
421
|
|
|
402
422
|
### Keys as Address Book UI Labels
|
|
403
423
|
|
|
404
|
-
|
|
424
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Contacts.Person API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Contacts.Person).
|
|
405
425
|
|
|
406
426
|
### Properties (unique: 29/32)
|
|
407
427
|
| Property | Type | Default | Platform | Description |
|
|
@@ -447,6 +467,8 @@ Support for adding and modifying properties is currently supported on iOS and An
|
|
|
447
467
|
---
|
|
448
468
|
|
|
449
469
|
## Ti.Geolocation
|
|
470
|
+
> Full released contract: [Titanium.Geolocation](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Geolocation)
|
|
471
|
+
|
|
450
472
|
> The top level Geolocation module. The Geolocation module is used for accessing device location based information.
|
|
451
473
|
> Extends Ti.Module
|
|
452
474
|
> Platforms: both
|
|
@@ -468,7 +490,7 @@ The location services systems of the underlying platforms are very different, so
|
|
|
468
490
|
are significant implementation differences between the platforms.
|
|
469
491
|
|
|
470
492
|
|
|
471
|
-
|
|
493
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Geolocation API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Geolocation).
|
|
472
494
|
|
|
473
495
|
### Properties (unique: 15/46)
|
|
474
496
|
| Property | Type | Default | Platform | Description |
|
|
@@ -570,6 +592,8 @@ are significant implementation differences between the platforms.
|
|
|
570
592
|
---
|
|
571
593
|
|
|
572
594
|
## Ti.Geolocation.Android
|
|
595
|
+
> Full released contract: [Titanium.Geolocation.Android](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Geolocation.Android)
|
|
596
|
+
|
|
573
597
|
> Module for Android-specific geolocation functionality.
|
|
574
598
|
> Extends Ti.Module
|
|
575
599
|
> Platforms: android
|
|
@@ -591,7 +615,7 @@ Manual configuration involves managing *providers* and *rules*:
|
|
|
591
615
|
Configuring geolocation manually involves three steps:
|
|
592
616
|
|
|
593
617
|
|
|
594
|
-
|
|
618
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Geolocation.Android API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Geolocation.Android).
|
|
595
619
|
|
|
596
620
|
### Properties (unique: 1/7)
|
|
597
621
|
| Property | Type | Default | Platform | Description |
|
|
@@ -616,6 +640,8 @@ Configuring geolocation manually involves three steps:
|
|
|
616
640
|
---
|
|
617
641
|
|
|
618
642
|
## Ti.Geolocation.Android.LocationProvider
|
|
643
|
+
> Full released contract: [Titanium.Geolocation.Android.LocationProvider](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Geolocation.Android.LocationProvider)
|
|
644
|
+
|
|
619
645
|
> Represents a source of location information, such as GPS.
|
|
620
646
|
> Extends Ti.Proxy
|
|
621
647
|
> Platforms: android
|
|
@@ -636,6 +662,8 @@ manually configure location updates.
|
|
|
636
662
|
---
|
|
637
663
|
|
|
638
664
|
## Ti.Geolocation.Android.LocationRule
|
|
665
|
+
> Full released contract: [Titanium.Geolocation.Android.LocationRule](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Geolocation.Android.LocationRule)
|
|
666
|
+
|
|
639
667
|
> A location rule to filter the results returned by location providers.
|
|
640
668
|
> Extends Ti.Proxy
|
|
641
669
|
> Platforms: android
|
|
@@ -659,6 +687,8 @@ manually configure location updates.
|
|
|
659
687
|
---
|
|
660
688
|
|
|
661
689
|
## Ti.WatchSession
|
|
690
|
+
> Full released contract: [Titanium.WatchSession](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.WatchSession)
|
|
691
|
+
|
|
662
692
|
> Used to enable data and file transfers between a watchOS and iOS application.
|
|
663
693
|
> Extends Ti.Module
|
|
664
694
|
> Platforms: ios
|
|
@@ -18,6 +18,8 @@
|
|
|
18
18
|
<!-- TOC-END -->
|
|
19
19
|
|
|
20
20
|
## Ti.UI.Android
|
|
21
|
+
> Full released contract: [Titanium.UI.Android](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android)
|
|
22
|
+
|
|
21
23
|
> The Android-specific UI capabilities. All properties, methods and events in this namespace will only work on Android systems. #### Drawer Layout The drawer-layout components acts as a top-level container for window content that allows for interactive "drawer" views to be pulled out from one or both vertical edges of the window. It is represented by a `centerView` and optional `leftView` and `rightView` components that can be swiped in and out with additional configuration and transitions. Learn more about drawer-layouts in it's dedicated <Titanium.UI.Android.DrawerLayout> docs.
|
|
22
24
|
> Extends Ti.Module
|
|
23
25
|
> Platforms: android
|
|
@@ -40,7 +42,7 @@ button.addEventListener('click', function() {
|
|
|
40
42
|
});
|
|
41
43
|
```
|
|
42
44
|
|
|
43
|
-
|
|
45
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Android API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android).
|
|
44
46
|
|
|
45
47
|
### Constants (101)
|
|
46
48
|
- **FLAG_LAYOUT_NO_\***: FLAG_LAYOUT_NO_LIMITS
|
|
@@ -123,13 +125,15 @@ button.addEventListener('click', function() {
|
|
|
123
125
|
---
|
|
124
126
|
|
|
125
127
|
## Ti.UI.Android.CardView
|
|
128
|
+
> Full released contract: [Titanium.UI.Android.CardView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.CardView)
|
|
129
|
+
|
|
126
130
|
> CardView provides a layout container with rounded corners and a shadow indicating the view is elevated.
|
|
127
131
|
> Extends Ti.UI.View
|
|
128
132
|
> Platforms: android
|
|
129
133
|
|
|
130
134
|
| Android |
|
|
131
135
|
| ------- |
|
|
132
|
-
|
|
|
136
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.CardView) |
|
|
133
137
|
|
|
134
138
|
Use a CardView to layout content that:
|
|
135
139
|
|
|
@@ -138,11 +142,11 @@ Use a CardView to layout content that:
|
|
|
138
142
|
* Supports variable length content or displays more than three lines of text
|
|
139
143
|
* Contains rich content or interactive elements, such as comments or a favorite button
|
|
140
144
|
|
|
141
|
-
If you are displaying a collection of the same type in a uniform layout without many actions, use a [ListView](Titanium.UI.ListView) or [TableView](Titanium.UI.TableView) instead.
|
|
145
|
+
If you are displaying a collection of the same type in a uniform layout without many actions, use a [ListView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ListView) or [TableView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TableView) instead.
|
|
142
146
|
|
|
143
147
|
For design guidelines, see
|
|
144
148
|
|
|
145
|
-
|
|
149
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Android.CardView API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.CardView).
|
|
146
150
|
|
|
147
151
|
### Properties (unique: 11/65)
|
|
148
152
|
| Property | Type | Default | Platform | Description |
|
|
@@ -165,13 +169,15 @@ For design guidelines, see
|
|
|
165
169
|
---
|
|
166
170
|
|
|
167
171
|
## Ti.UI.Android.CollapseToolbar
|
|
172
|
+
> Full released contract: [Titanium.UI.Android.CollapseToolbar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.CollapseToolbar)
|
|
173
|
+
|
|
168
174
|
> A collapsing toolbar layout.
|
|
169
175
|
> Extends Ti.UI.View
|
|
170
176
|
> Platforms: android
|
|
171
177
|
|
|
172
178
|
| Android |
|
|
173
179
|
| ------- |
|
|
174
|
-
|
|
|
180
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.CollapseToolbar) |
|
|
175
181
|
|
|
176
182
|
CollapseToolbar acts as a top-level container for window content that allows to set a parallax image and title in the toolbar. The main content goes into `centerView` and will automatically be scrollable.
|
|
177
183
|
|
|
@@ -196,13 +202,15 @@ CollapseToolbar acts as a top-level container for window content that allows to
|
|
|
196
202
|
---
|
|
197
203
|
|
|
198
204
|
## Ti.UI.Android.DrawerLayout
|
|
205
|
+
> Full released contract: [Titanium.UI.Android.DrawerLayout](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.DrawerLayout)
|
|
206
|
+
|
|
199
207
|
> A panel that displays the app's main navigation options on the left edge of the screen.
|
|
200
208
|
> Extends Ti.UI.View
|
|
201
209
|
> Platforms: android
|
|
202
210
|
|
|
203
211
|
| Android |
|
|
204
212
|
| ------- |
|
|
205
|
-
|
|
|
213
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.DrawerLayout) |
|
|
206
214
|
|
|
207
215
|
DrawerLayout acts as a top-level container for window content that allows for interactive "drawer" views to be pulled out from one or both vertical edges of the window.
|
|
208
216
|
|
|
@@ -256,6 +264,8 @@ For design guidelines, see [Google Design Guidelines: DrawerLayout](https://deve
|
|
|
256
264
|
---
|
|
257
265
|
|
|
258
266
|
## Ti.UI.Android.FloatingActionButton
|
|
267
|
+
> Full released contract: [Titanium.UI.Android.FloatingActionButton](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.FloatingActionButton)
|
|
268
|
+
|
|
259
269
|
> A floating action button (FAB) is a circular button that triggers the primary action in your app's UI.
|
|
260
270
|
> Extends Ti.UI.View
|
|
261
271
|
> Platforms: android
|
|
@@ -280,13 +290,15 @@ For design guidelines, see [Material design: Snackbars](https://material.io/comp
|
|
|
280
290
|
---
|
|
281
291
|
|
|
282
292
|
## Ti.UI.Android.ProgressIndicator
|
|
293
|
+
> Full released contract: [Titanium.UI.Android.ProgressIndicator](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.ProgressIndicator)
|
|
294
|
+
|
|
283
295
|
> A progress dialog or a horizontal progress bar in the title of the window.
|
|
284
296
|
> Extends Ti.UI.View
|
|
285
297
|
> Platforms: android
|
|
286
298
|
|
|
287
299
|
| Android |
|
|
288
300
|
| ------- |
|
|
289
|
-
|
|
|
301
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.ProgressIndicator) |
|
|
290
302
|
|
|
291
303
|
A progress indicator can be used to show the progress of an operation in the UI to let the user know that some action is taking place. It is used to indicate an ongoing activity of determinate or indeterminate length.
|
|
292
304
|
|
|
@@ -330,24 +342,26 @@ A progress indicator can be either a progress dialog or a horizontal progress ba
|
|
|
330
342
|
---
|
|
331
343
|
|
|
332
344
|
## Ti.UI.Android.SearchView
|
|
345
|
+
> Full released contract: [Titanium.UI.Android.SearchView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.SearchView)
|
|
346
|
+
|
|
333
347
|
> A specialized text field for entering search text.
|
|
334
348
|
> Extends Ti.UI.View
|
|
335
349
|
> Platforms: android
|
|
336
350
|
|
|
337
351
|
| Android |
|
|
338
352
|
| ------- |
|
|
339
|
-
|
|
|
353
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.SearchView) |
|
|
340
354
|
|
|
341
355
|
`SearchView` provides a user interface to enter a search query and submit a request to a search provider.
|
|
342
356
|
|
|
343
|
-
Search views are most commonly used for filtering the rows in a [TableView](Titanium.UI.TableView). Similar to [SearchBar](Titanium.UI.SearchBar), you can add a search view to a table view by setting the table view's [search](Titanium.UI.TableView
|
|
357
|
+
Search views are most commonly used for filtering the rows in a [TableView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TableView). Similar to [SearchBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.SearchBar), you can add a search view to a table view by setting the table view's [search](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TableView) property. A search view can be used without a `TableView`.
|
|
344
358
|
|
|
345
|
-
You can also use a `SearchView` object as the <Titanium.UI.ListView.searchView> property of a [ListView](Titanium.UI.ListView) object.
|
|
359
|
+
You can also use a `SearchView` object as the <Titanium.UI.ListView.searchView> property of a [ListView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ListView) object.
|
|
346
360
|
|
|
347
361
|
You can also add `SearchView` to an `ActionBar` as a view (see example below).
|
|
348
362
|
|
|
349
363
|
|
|
350
|
-
|
|
364
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Android.SearchView API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.SearchView).
|
|
351
365
|
|
|
352
366
|
### Properties (unique: 7/68)
|
|
353
367
|
| Property | Type | Default | Platform | Description |
|
|
@@ -379,13 +393,15 @@ You can also add `SearchView` to an `ActionBar` as a view (see example below).
|
|
|
379
393
|
---
|
|
380
394
|
|
|
381
395
|
## Ti.UI.Android.Snackbar
|
|
396
|
+
> Full released contract: [Titanium.UI.Android.Snackbar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.Snackbar)
|
|
397
|
+
|
|
382
398
|
> Snackbars provide brief messages about app processes at the bottom of the screen.
|
|
383
399
|
> Extends Ti.UI.View
|
|
384
400
|
> Platforms: android
|
|
385
401
|
|
|
386
402
|
| Android |
|
|
387
403
|
| ------- |
|
|
388
|
-
|
|
|
404
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Android.Snackbar) |
|
|
389
405
|
|
|
390
406
|
For design guidelines, see [Material design: Snackbars](https://material.io/components/snackbars)
|
|
391
407
|
|
|
@@ -422,6 +438,8 @@ For design guidelines, see [Material design: Snackbars](https://material.io/comp
|
|
|
422
438
|
---
|
|
423
439
|
|
|
424
440
|
## Ti.UI.iPad.Popover
|
|
441
|
+
> Full released contract: [Titanium.UI.iPad.Popover](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iPad.Popover)
|
|
442
|
+
|
|
425
443
|
> A Popover is used to manage the presentation of content in a popover.
|
|
426
444
|
> Extends Ti.UI.View
|
|
427
445
|
> Platforms: ios
|
|
@@ -430,7 +448,7 @@ A popover is created using the <Titanium.UI.iPad.createPopover> method or **`<Po
|
|
|
430
448
|
|
|
431
449
|
Popovers are used to present information temporarily, but in a way that does not take over the entire screen in the way that a modal view does. The popover content is layered on top of the existing content in a special type of window. The popover remains visible until the user taps outside of the popover window or it is explicitly dismissed.
|
|
432
450
|
|
|
433
|
-
Do not add top-level view containers, such as a `SplitWindow` or `TabGroup`, to a popover. Adding top-level view containers may have unintended side effects. See the [contentView](Titanium.UI.iPad.Popover
|
|
451
|
+
Do not add top-level view containers, such as a `SplitWindow` or `TabGroup`, to a popover. Adding top-level view containers may have unintended side effects. See the [contentView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iPad.Popover) property for more information.
|
|
434
452
|
|
|
435
453
|
### Properties (unique: 4/13)
|
|
436
454
|
| Property | Type | Default | Platform | Description |
|
|
@@ -473,6 +491,8 @@ Do not add top-level view containers, such as a `SplitWindow` or `TabGroup`, to
|
|
|
473
491
|
---
|
|
474
492
|
|
|
475
493
|
## Ti.UI.iPad
|
|
494
|
+
> Full released contract: [Titanium.UI.iPad](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iPad)
|
|
495
|
+
|
|
476
496
|
> iPad specific UI capabilities.
|
|
477
497
|
> Extends Ti.Module
|
|
478
498
|
> Platforms: ios
|