@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
|
@@ -23,6 +23,8 @@
|
|
|
23
23
|
<!-- TOC-END -->
|
|
24
24
|
|
|
25
25
|
## Titanium
|
|
26
|
+
> Full released contract: [Titanium](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium)
|
|
27
|
+
|
|
26
28
|
> The top-level Titanium module.
|
|
27
29
|
> Extends Ti.Module
|
|
28
30
|
> Platforms: both
|
|
@@ -42,7 +44,7 @@ Ti.API.info('Hello Titanium!');
|
|
|
42
44
|
```
|
|
43
45
|
|
|
44
46
|
|
|
45
|
-
|
|
47
|
+
Complete overview, setup, examples and version restrictions: [official Titanium API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium).
|
|
46
48
|
|
|
47
49
|
### Properties (unique: 4/7)
|
|
48
50
|
| Property | Type | Default | Platform | Description |
|
|
@@ -74,6 +76,8 @@ Ti.API.info('Hello Titanium!');
|
|
|
74
76
|
---
|
|
75
77
|
|
|
76
78
|
## Ti.UI
|
|
79
|
+
> Full released contract: [Titanium.UI](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI)
|
|
80
|
+
|
|
77
81
|
> The main <Titanium.UI> module.
|
|
78
82
|
> Extends Ti.Module
|
|
79
83
|
> Platforms: both
|
|
@@ -85,9 +89,9 @@ The UI module is responsible for native user-interface components and interactio
|
|
|
85
89
|
|
|
86
90
|
The UI module is broken down into 3 major area:
|
|
87
91
|
|
|
88
|
-
* **Views** - [Views](Titanium.UI.View) are containers that host visual elements such as controls or other views. Views can have their properties customized, such as their border color and radius, can fire events such as swipe events or touches, and can optionally contain a hierarchy or other views as children. In Titanium, most views are specialized to perform both a visual function and set of interaction behaviors such as [Table View](Titanium.UI.TableView) or [Coverflow View](Titanium.UI.iOS.CoverFlowView). Views are always named with the suffix `View`.
|
|
92
|
+
* **Views** - [Views](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.View) are containers that host visual elements such as controls or other views. Views can have their properties customized, such as their border color and radius, can fire events such as swipe events or touches, and can optionally contain a hierarchy or other views as children. In Titanium, most views are specialized to perform both a visual function and set of interaction behaviors such as [Table View](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TableView) or [Coverflow View](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.CoverFlowView). Views are always named with the suffix `View`.
|
|
89
93
|
|
|
90
|
-
|
|
94
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI).
|
|
91
95
|
|
|
92
96
|
### Properties (unique: 9/285)
|
|
93
97
|
| Property | Type | Default | Platform | Description |
|
|
@@ -232,7 +236,7 @@ The UI module is broken down into 3 major area:
|
|
|
232
236
|
| createMatrix2D(parameters) | Ti.UI.Matrix2D | both | Creates and returns an instance of <Titanium.UI.Matrix2D>. |
|
|
233
237
|
| createMatrix3D(parameters) | Ti.UI.Matrix3D | both | Creates and returns an instance of <Titanium.UI.Matrix3D>. |
|
|
234
238
|
| convertUnits(convertFromValue, convertToUnits) | Number | both | Converts one type of unit to another using the metrics of the main display. |
|
|
235
|
-
| fetchSemanticColor(colorName) |
|
|
239
|
+
| fetchSemanticColor(colorName) | Ti.UI.Color \| String | both | Fetches the correct color to be used with a UI element dependent on the users c… |
|
|
236
240
|
| createView(parameters) | Ti.UI.View | both | Creates and returns an instance of <Titanium.UI.View>. |
|
|
237
241
|
| createActivityIndicator(parameters) | Ti.UI.ActivityIndicator | both | Creates and returns an instance of <Titanium.UI.ActivityIndicator>. |
|
|
238
242
|
| createAlertDialog(parameters) | Ti.UI.AlertDialog | both | Creates and returns an instance of <Titanium.UI.AlertDialog>. |
|
|
@@ -300,7 +304,7 @@ The UI module is broken down into 3 major area:
|
|
|
300
304
|
| Property | Type | Description |
|
|
301
305
|
|----------|------|-------------|
|
|
302
306
|
| scale | Number | Scale the matrix by the specified scaling factor. The same scaling factor is us… |
|
|
303
|
-
| rotate | Number | Rotation angle, in degrees. See the [rotate](Titanium.UI.Matrix2D
|
|
307
|
+
| rotate | Number | Rotation angle, in degrees. See the [rotate](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Matrix2D) metho… |
|
|
304
308
|
| anchorPoint | Point | Point to rotate around, specified as a dictionary object with `x` and `y` prope… |
|
|
305
309
|
|
|
306
310
|
#### Matrix3DCreationDict
|
|
@@ -313,6 +317,8 @@ The UI module is broken down into 3 major area:
|
|
|
313
317
|
---
|
|
314
318
|
|
|
315
319
|
## Ti.API
|
|
320
|
+
> Full released contract: [Titanium.API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.API)
|
|
321
|
+
|
|
316
322
|
> The top-level API module, containing methods to output messages to the system log.
|
|
317
323
|
> Extends Ti.Module
|
|
318
324
|
> Platforms: both
|
|
@@ -334,6 +340,8 @@ The UI module is broken down into 3 major area:
|
|
|
334
340
|
---
|
|
335
341
|
|
|
336
342
|
## Ti.Accelerometer
|
|
343
|
+
> Full released contract: [Titanium.Accelerometer](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Accelerometer)
|
|
344
|
+
|
|
337
345
|
> The top-level Accelerometer module, used to determine the device's physical position.
|
|
338
346
|
> Extends Ti.Module
|
|
339
347
|
> Platforms: both
|
|
@@ -355,21 +363,23 @@ The accelerometer may be switched on and off by simply adding and removing the `
|
|
|
355
363
|
---
|
|
356
364
|
|
|
357
365
|
## Ti.Blob
|
|
366
|
+
> Full released contract: [Titanium.Blob](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Blob)
|
|
367
|
+
|
|
358
368
|
> A container for binary data.
|
|
359
369
|
> Extends Ti.Proxy
|
|
360
370
|
> Platforms: both
|
|
361
371
|
|
|
362
|
-
A `Blob` represents a chunk of binary information, often obtained through an [HTTPClient](Titanium.Network.HTTPClient) or by reading a [File](Titanium.Filesystem.File).
|
|
372
|
+
A `Blob` represents a chunk of binary information, often obtained through an [HTTPClient](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.HTTPClient) or by reading a [File](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File).
|
|
363
373
|
|
|
364
374
|
Blobs are often used to store text or image data. The `Blob` object includes a number of properties and methods specific to image blobs.
|
|
365
375
|
|
|
366
|
-
Android supports an [append](Titanium.Blob
|
|
376
|
+
Android supports an [append](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Blob) method, but otherwise blobs are immutable.
|
|
367
377
|
|
|
368
378
|
The <Titanium.Utils> module provides several utility methods for working with blobs, including methods for converting between blobs and Base64-encoded strings, and methods for generating SHA-1 and SHA-256 hashes and MD5 digests from blob data.
|
|
369
379
|
|
|
370
|
-
The [Buffer](Titanium.Buffer) object can also contain binary data, and is more easily mutable. Extracting blob data to a buffer is somewhat roundabout:
|
|
380
|
+
The [Buffer](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Buffer) object can also contain binary data, and is more easily mutable. Extracting blob data to a buffer is somewhat roundabout:
|
|
371
381
|
|
|
372
|
-
|
|
382
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Blob API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Blob).
|
|
373
383
|
|
|
374
384
|
### Properties (unique: 11/14)
|
|
375
385
|
| Property | Type | Default | Platform | Description |
|
|
@@ -382,7 +392,7 @@ The [Buffer](Titanium.Buffer) object can also contain binary data, and is more e
|
|
|
382
392
|
| uprightHeight | Number | — | both | If the blob references an image, this provides the height in pixels after facto… |
|
|
383
393
|
| width | Number | — | both | If this blob represents an image, this is the width of the image in pixels. |
|
|
384
394
|
| uprightWidth | Number | — | both | If the blob references an image, this provides the width in pixels after factor… |
|
|
385
|
-
| nativePath | String | — | both | If this blob represents a [File](Titanium.Filesystem.File), this is the file UR… |
|
|
395
|
+
| nativePath | String | — | both | If this blob represents a [File](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File), this is the file UR… |
|
|
386
396
|
| size | Number | — | both | Size of the blob in pixels (for image blobs) or bytes (for all other blobs). |
|
|
387
397
|
| rotation | Number | — | android | EXIF rotation of the image if available. Can be `undefined` if no orientation w… |
|
|
388
398
|
|
|
@@ -418,6 +428,8 @@ The [Buffer](Titanium.Buffer) object can also contain binary data, and is more e
|
|
|
418
428
|
---
|
|
419
429
|
|
|
420
430
|
## Ti.BlobStream
|
|
431
|
+
> Full released contract: [Titanium.BlobStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.BlobStream)
|
|
432
|
+
|
|
421
433
|
> Wrapper around <Titanium.Blob> that implements the <Titanium.IOStream> interface.
|
|
422
434
|
> Extends Ti.IOStream
|
|
423
435
|
> Platforms: both
|
|
@@ -430,6 +442,8 @@ Use the <Titanium.Stream.createStream> method to create a `BlobStream` instance
|
|
|
430
442
|
---
|
|
431
443
|
|
|
432
444
|
## Ti.Buffer
|
|
445
|
+
> Full released contract: [Titanium.Buffer](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Buffer)
|
|
446
|
+
|
|
433
447
|
> Buffer is a mutable, resizable container for raw data.
|
|
434
448
|
> Extends Ti.Proxy
|
|
435
449
|
> Platforms: both
|
|
@@ -464,6 +478,8 @@ Use the <Titanium.createBuffer> method to create a buffer.
|
|
|
464
478
|
---
|
|
465
479
|
|
|
466
480
|
## Ti.BufferStream
|
|
481
|
+
> Full released contract: [Titanium.BufferStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.BufferStream)
|
|
482
|
+
|
|
467
483
|
> Wrapper around <Titanium.Buffer> that implements the <Titanium.IOStream> interface.
|
|
468
484
|
> Extends Ti.IOStream
|
|
469
485
|
> Platforms: both
|
|
@@ -476,12 +492,14 @@ Use the <Titanium.Stream.createStream> method to create a `BufferStream` instanc
|
|
|
476
492
|
---
|
|
477
493
|
|
|
478
494
|
## Ti.Codec
|
|
495
|
+
> Full released contract: [Titanium.Codec](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Codec)
|
|
496
|
+
|
|
479
497
|
> A module for translating between primitive types and raw byte streams.
|
|
480
498
|
> Extends Ti.Module
|
|
481
499
|
> Platforms: both
|
|
482
500
|
> Type: module
|
|
483
501
|
|
|
484
|
-
The `Codec` module can be used for encoding strings and numbers into [Buffer](Titanium.Buffer) objects, and decoding primitive types from buffers.
|
|
502
|
+
The `Codec` module can be used for encoding strings and numbers into [Buffer](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Buffer) objects, and decoding primitive types from buffers.
|
|
485
503
|
|
|
486
504
|
### Byte Order
|
|
487
505
|
|
|
@@ -493,7 +511,7 @@ If we represent a buffer as an array of byte values, a big-endian encoding of 0x
|
|
|
493
511
|
[ 0xFE, 0xDC, 0xBA, 0x98 ]
|
|
494
512
|
```
|
|
495
513
|
|
|
496
|
-
|
|
514
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Codec API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Codec).
|
|
497
515
|
|
|
498
516
|
### Constants (14)
|
|
499
517
|
- **BIG_\***: BIG_ENDIAN
|
|
@@ -549,6 +567,8 @@ If we represent a buffer as an array of byte values, a big-endian encoding of 0x
|
|
|
549
567
|
---
|
|
550
568
|
|
|
551
569
|
## Ti.Gesture
|
|
570
|
+
> Full released contract: [Titanium.Gesture](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Gesture)
|
|
571
|
+
|
|
552
572
|
> The Gesture module is responsible for high-level device gestures such as orientation changes and shake gestures.
|
|
553
573
|
> Extends Ti.Module
|
|
554
574
|
> Platforms: both
|
|
@@ -576,6 +596,8 @@ If we represent a buffer as an array of byte values, a big-endian encoding of 0x
|
|
|
576
596
|
---
|
|
577
597
|
|
|
578
598
|
## Ti.IOStream
|
|
599
|
+
> Full released contract: [Titanium.IOStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.IOStream)
|
|
600
|
+
|
|
579
601
|
> IOStream is the interface that all stream types implement.
|
|
580
602
|
> Extends Ti.Proxy
|
|
581
603
|
> Platforms: both
|
|
@@ -596,6 +618,8 @@ See the <Titanium.Stream> module for related utility methods that support asynch
|
|
|
596
618
|
---
|
|
597
619
|
|
|
598
620
|
## Ti.Locale
|
|
621
|
+
> Full released contract: [Titanium.Locale](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Locale)
|
|
622
|
+
|
|
599
623
|
> The top level Locale module.
|
|
600
624
|
> Extends Ti.Module
|
|
601
625
|
> Platforms: both
|
|
@@ -632,12 +656,14 @@ The macro `L` can be used as an alias for the <Titanium.Locale.getString> method
|
|
|
632
656
|
---
|
|
633
657
|
|
|
634
658
|
## Ti.Stream
|
|
659
|
+
> Full released contract: [Titanium.Stream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Stream)
|
|
660
|
+
|
|
635
661
|
> Stream module containing stream utility methods.
|
|
636
662
|
> Extends Ti.Module
|
|
637
663
|
> Platforms: both
|
|
638
664
|
> Type: module
|
|
639
665
|
|
|
640
|
-
This module provides a set of methods for interacting with [IOStream](Titanium.IOStream) objects, including asynchronous versions of the `read` and `write` methods offered by all stream objects. These methods should be used in any place where reading from or writing to a stream might block.
|
|
666
|
+
This module provides a set of methods for interacting with [IOStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.IOStream) objects, including asynchronous versions of the `read` and `write` methods offered by all stream objects. These methods should be used in any place where reading from or writing to a stream might block.
|
|
641
667
|
|
|
642
668
|
See also:
|
|
643
669
|
|
|
@@ -655,9 +681,9 @@ See also:
|
|
|
655
681
|
| Method | Returns | Platform | Description |
|
|
656
682
|
|--------|---------|----------|-------------|
|
|
657
683
|
| createStream(params) | Ti.IOStream | both | Creates stream from a `Buffer` or `Blob` object. |
|
|
658
|
-
| read(sourceStream, buffer, offset, length, resultsCallback) | void | both | Asynchronously reads data from an [IOStream](Titanium.IOStream) into a buffer. |
|
|
659
|
-
| readAll(sourceStream, buffer, resultsCallback) | void | both | Reads all data from the specified [IOStream](Titanium.IOStream). |
|
|
660
|
-
| write(outputStream, buffer, offset, length, resultsCallback) | void | both | Asynchronously writes data from a buffer to an [IOStream](Titanium.IOStream). |
|
|
684
|
+
| read(sourceStream, buffer, offset, length, resultsCallback) | void | both | Asynchronously reads data from an [IOStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.IOStream) into a buffer. |
|
|
685
|
+
| readAll(sourceStream, buffer, resultsCallback) | Ti.Buffer \| void | both | Reads all data from the specified [IOStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.IOStream). |
|
|
686
|
+
| write(outputStream, buffer, offset, length, resultsCallback) | void | both | Asynchronously writes data from a buffer to an [IOStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.IOStream). |
|
|
661
687
|
| writeStream(inputStream, outputStream, maxChunkSize, resultsCallback) | void | both | Writes all data from an input stream to an output stream. |
|
|
662
688
|
| pump(inputStream, handler, maxChunkSize, isAsync) | void | both | Reads data from input stream and passes it to a handler method. |
|
|
663
689
|
|
|
@@ -665,7 +691,7 @@ See also:
|
|
|
665
691
|
### Related Types
|
|
666
692
|
|
|
667
693
|
#### CreateStreamArgs
|
|
668
|
-
> Argument passed to [createStream](Titanium.Stream
|
|
694
|
+
> Argument passed to [createStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Stream).
|
|
669
695
|
|
|
670
696
|
| Property | Type | Description |
|
|
671
697
|
|----------|------|-------------|
|
|
@@ -675,6 +701,8 @@ See also:
|
|
|
675
701
|
---
|
|
676
702
|
|
|
677
703
|
## Ti.Utils
|
|
704
|
+
> Full released contract: [Titanium.Utils](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Utils)
|
|
705
|
+
|
|
678
706
|
> The top-level Utils module, containing a set of JavaScript methods that are often useful when building applications.
|
|
679
707
|
> Extends Ti.Module
|
|
680
708
|
> Platforms: both
|
|
@@ -694,13 +722,15 @@ See also:
|
|
|
694
722
|
---
|
|
695
723
|
|
|
696
724
|
## Ti.Proxy
|
|
725
|
+
> Full released contract: [Titanium.Proxy](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Proxy)
|
|
726
|
+
|
|
697
727
|
> The base for all Titanium objects.
|
|
698
728
|
> Extends Object
|
|
699
729
|
> Platforms: both
|
|
700
730
|
|
|
701
731
|
On platforms that use native code (Android and iOS), the `Proxy` type represents a JavaScript wrapper or _proxy_ around a native object. Setting or getting a property on a proxy object results in a method invocation on the native object. Likewise, calling a method on the proxy object results in a method invocation on the native object.
|
|
702
732
|
|
|
703
|
-
Some Titanium objects are _createable_: new instances of these objects can be created using factory methods. For example, a [Window](Titanium.UI.Window) object can be created using the
|
|
733
|
+
Some Titanium objects are _createable_: new instances of these objects can be created using factory methods. For example, a [Window](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Window) object can be created using the
|
|
704
734
|
|
|
705
735
|
### Properties (unique: 3/3)
|
|
706
736
|
| Property | Type | Default | Platform | Description |
|
|
@@ -727,6 +757,8 @@ Some Titanium objects are _createable_: new instances of these objects can be cr
|
|
|
727
757
|
---
|
|
728
758
|
|
|
729
759
|
## Ti.Module
|
|
760
|
+
> Full released contract: [Titanium.Module](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Module)
|
|
761
|
+
|
|
730
762
|
> Base type for all Titanium modules.
|
|
731
763
|
> Extends Ti.Proxy
|
|
732
764
|
> Platforms: both
|
|
@@ -21,6 +21,8 @@
|
|
|
21
21
|
<!-- TOC-END -->
|
|
22
22
|
|
|
23
23
|
## Ti.Database
|
|
24
|
+
> Full released contract: [Titanium.Database](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Database)
|
|
25
|
+
|
|
24
26
|
> The top-level `Database` module, used for creating and accessing the in-application SQLite database.
|
|
25
27
|
> Extends Ti.Module
|
|
26
28
|
> Platforms: both
|
|
@@ -40,6 +42,8 @@
|
|
|
40
42
|
---
|
|
41
43
|
|
|
42
44
|
## Ti.Database.DB
|
|
45
|
+
> Full released contract: [Titanium.Database.DB](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Database.DB)
|
|
46
|
+
|
|
43
47
|
> The `Database` instance returned by <Titanium.Database.open> or <Titanium.Database.install>.
|
|
44
48
|
> Extends Ti.Proxy
|
|
45
49
|
> Platforms: both
|
|
@@ -67,15 +71,17 @@
|
|
|
67
71
|
---
|
|
68
72
|
|
|
69
73
|
## Ti.Database.ResultSet
|
|
74
|
+
> Full released contract: [Titanium.Database.ResultSet](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Database.ResultSet)
|
|
75
|
+
|
|
70
76
|
> The ResultSet instance returned by <Titanium.Database.DB.execute>.
|
|
71
77
|
> Extends Ti.Proxy
|
|
72
78
|
> Platforms: both
|
|
73
79
|
|
|
74
80
|
A result set represents the results returned by a database query.
|
|
75
81
|
|
|
76
|
-
The [rowCount](Titanium.Database.ResultSet
|
|
82
|
+
The [rowCount](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Database.ResultSet) property identifies the number of rows in the result set. The `ResultSet` object maintains an internal record of the current row. As shown in the example, you can use the [next](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Database.ResultSet) method to iterate through the rows in the set.
|
|
77
83
|
|
|
78
|
-
Use the [field](Titanium.Database.ResultSet
|
|
84
|
+
Use the [field](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Database.ResultSet) or [fieldByName](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Database.ResultSet) methods to query the fields for the current row.
|
|
79
85
|
|
|
80
86
|
On the iOS platform, closing the database also closes the result set, that is, you can only access the result set if the database is currently open.
|
|
81
87
|
|
|
@@ -102,6 +108,8 @@ On the iOS platform, closing the database also closes the result set, that is, y
|
|
|
102
108
|
---
|
|
103
109
|
|
|
104
110
|
## Ti.Filesystem
|
|
111
|
+
> Full released contract: [Titanium.Filesystem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem)
|
|
112
|
+
|
|
105
113
|
> The top level filesystem module, used to access files and directories on the device.
|
|
106
114
|
> Extends Ti.Module
|
|
107
115
|
> Platforms: both
|
|
@@ -134,8 +142,8 @@ For examples of using the Filesystem APIs, refer to the [Filesystem Access and S
|
|
|
134
142
|
### Methods (9)
|
|
135
143
|
| Method | Returns | Platform | Description |
|
|
136
144
|
|--------|---------|----------|-------------|
|
|
137
|
-
| createTempDirectory(—) | Ti.Filesystem.File | both | Creates a temporary directory and returns a [File](Titanium.Filesystem.File) ob… |
|
|
138
|
-
| createTempFile(—) | Ti.Filesystem.File | both | Creates a temporary file and returns a [File](Titanium.Filesystem.File) object … |
|
|
145
|
+
| createTempDirectory(—) | Ti.Filesystem.File | both | Creates a temporary directory and returns a [File](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File) ob… |
|
|
146
|
+
| createTempFile(—) | Ti.Filesystem.File | both | Creates a temporary file and returns a [File](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File) object … |
|
|
139
147
|
| getFile(path) | Ti.Filesystem.File | both | Returns a `File` object representing the file identified by the path arguments. |
|
|
140
148
|
| getAsset(path) | Ti.Blob | ios | Returns a `Blob` object representing the asset catalog image identified by the … |
|
|
141
149
|
| isExternalStoragePresent(—) | Boolean | both | Returns `true` if the device supports external storage *and* the external stora… |
|
|
@@ -148,6 +156,8 @@ For examples of using the Filesystem APIs, refer to the [Filesystem Access and S
|
|
|
148
156
|
---
|
|
149
157
|
|
|
150
158
|
## Ti.Filesystem.File
|
|
159
|
+
> Full released contract: [Titanium.Filesystem.File](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File)
|
|
160
|
+
|
|
151
161
|
> Object representing a path to a file or directory in the device's persistent storage.
|
|
152
162
|
> Extends Ti.Proxy
|
|
153
163
|
> Platforms: both
|
|
@@ -156,12 +166,12 @@ Use the <Titanium.Filesystem.getFile> method to get a handle to a `File` object,
|
|
|
156
166
|
|
|
157
167
|
See <Titanium.Filesystem> for constants identifying commonly-used device directories.
|
|
158
168
|
|
|
159
|
-
Use the [exists](Titanium.Filesystem.File
|
|
169
|
+
Use the [exists](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File) method to test whether the file exists.
|
|
160
170
|
|
|
161
|
-
A file object can point to an ordinary file, a directory or a symbolic link. Use [createDirectory](Titanium.Filesystem.File
|
|
171
|
+
A file object can point to an ordinary file, a directory or a symbolic link. Use [createDirectory](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File) to create a directory. Use the [getDirectoryListing](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File) method to retrieve a list of the directory's contents.
|
|
162
172
|
|
|
163
173
|
|
|
164
|
-
|
|
174
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Filesystem.File API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.File).
|
|
165
175
|
|
|
166
176
|
### Properties (unique: 10/13)
|
|
167
177
|
| Property | Type | Default | Platform | Description |
|
|
@@ -211,6 +221,8 @@ A file object can point to an ordinary file, a directory or a symbolic link. Use
|
|
|
211
221
|
---
|
|
212
222
|
|
|
213
223
|
## Ti.Filesystem.FileStream
|
|
224
|
+
> Full released contract: [Titanium.Filesystem.FileStream](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Filesystem.FileStream)
|
|
225
|
+
|
|
214
226
|
> Wrapper around `Titanium.Filesystem.File` that implements the `Titanium.IOStream` interface
|
|
215
227
|
> Extends Ti.IOStream
|
|
216
228
|
> Platforms: both
|
|
@@ -225,6 +237,8 @@ A file object can point to an ordinary file, a directory or a symbolic link. Use
|
|
|
225
237
|
---
|
|
226
238
|
|
|
227
239
|
## Ti.Network
|
|
240
|
+
> Full released contract: [Titanium.Network](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network)
|
|
241
|
+
|
|
228
242
|
> The top level network module.
|
|
229
243
|
> Extends Ti.Module
|
|
230
244
|
> Platforms: both
|
|
@@ -234,7 +248,7 @@ The `Network` module is used to access networking related functionality.
|
|
|
234
248
|
|
|
235
249
|
For TCP sockets, see <Titanium.Network.Socket.TCP>.
|
|
236
250
|
|
|
237
|
-
The legacy <Titanium.Network.TCPSocket> object is still required by the [BonjourBrowser](Titanium.Network.BonjourBrowser) and [BonjourService](Titanium.Network.BonjourService) objects.
|
|
251
|
+
The legacy <Titanium.Network.TCPSocket> object is still required by the [BonjourBrowser](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.BonjourBrowser) and [BonjourService](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.BonjourService) objects.
|
|
238
252
|
|
|
239
253
|
For all other socket needs, use <Titanium.Network.Socket.TCP>.
|
|
240
254
|
|
|
@@ -243,7 +257,7 @@ For all other socket needs, use <Titanium.Network.Socket.TCP>.
|
|
|
243
257
|
Starting with iOS 9, Apple introduced new security and compatibility guidelines for networking and connectivity, which include:
|
|
244
258
|
|
|
245
259
|
|
|
246
|
-
|
|
260
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Network API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network).
|
|
247
261
|
|
|
248
262
|
### Properties (unique: 7/24)
|
|
249
263
|
| Property | Type | Default | Platform | Description |
|
|
@@ -294,7 +308,7 @@ Starting with iOS 9, Apple introduced new security and compatibility guidelines
|
|
|
294
308
|
### Related Types
|
|
295
309
|
|
|
296
310
|
#### PushNotificationConfig
|
|
297
|
-
> Simple object for specifying push notification options to [registerForPushNotifications](Titanium.Network
|
|
311
|
+
> Simple object for specifying push notification options to [registerForPushNotifications](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network).
|
|
298
312
|
|
|
299
313
|
| Property | Type | Description |
|
|
300
314
|
|----------|------|-------------|
|
|
@@ -306,6 +320,8 @@ Starting with iOS 9, Apple introduced new security and compatibility guidelines
|
|
|
306
320
|
---
|
|
307
321
|
|
|
308
322
|
## Ti.Network.BonjourBrowser
|
|
323
|
+
> Full released contract: [Titanium.Network.BonjourBrowser](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.BonjourBrowser)
|
|
324
|
+
|
|
309
325
|
> A browser for the discovery and retrieval of Bonjour services available on the network.
|
|
310
326
|
> Extends Ti.Proxy
|
|
311
327
|
> Platforms: ios
|
|
@@ -317,7 +333,7 @@ If your application publishes Bonjour services itself, that service will be disc
|
|
|
317
333
|
In iOS 14.0+, to browse services add key `NSLocalNetworkUsageDescription` and `NSBonjourServices` to the `ios plist` section of the tiapp.xml file.
|
|
318
334
|
|
|
319
335
|
|
|
320
|
-
|
|
336
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Network.BonjourBrowser API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.BonjourBrowser).
|
|
321
337
|
|
|
322
338
|
### Properties (unique: 3/5)
|
|
323
339
|
| Property | Type | Default | Platform | Description |
|
|
@@ -341,11 +357,13 @@ In iOS 14.0+, to browse services add key `NSLocalNetworkUsageDescription` and `N
|
|
|
341
357
|
---
|
|
342
358
|
|
|
343
359
|
## Ti.Network.BonjourService
|
|
360
|
+
> Full released contract: [Titanium.Network.BonjourService](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.BonjourService)
|
|
361
|
+
|
|
344
362
|
> Describes a service on the network which is published by Bonjour.
|
|
345
363
|
> Extends Ti.Proxy
|
|
346
364
|
> Platforms: ios
|
|
347
365
|
|
|
348
|
-
You can obtain a `BonjourService` instance by calling <Titanium.Network.createBonjourService> or from the `service` list from a [BonjourBrowser](Titanium.Network.BonjourBrowser) `updatedservices` event.
|
|
366
|
+
You can obtain a `BonjourService` instance by calling <Titanium.Network.createBonjourService> or from the `service` list from a [BonjourBrowser](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.BonjourBrowser) `updatedservices` event.
|
|
349
367
|
|
|
350
368
|
You can only publish Bonjour services attached to a socket which is currently listening; you cannot publish a service for a remotely connected socket. If you stop the Bonjour service and wish to close the socket it uses, it is strongly recommended that you stop the service first. When a window which publishes a Bonjour service is closed, you must stop the service if the associated socket is also to be closed, or if it is no longer necessary to publish. Bonjour service resolution and publishing is asynchronous.
|
|
351
369
|
|
|
@@ -354,7 +372,7 @@ In iOS 14.0+, to publish service add key `NSLocalNetworkUsageDescription` and `N
|
|
|
354
372
|
Example:
|
|
355
373
|
|
|
356
374
|
|
|
357
|
-
|
|
375
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Network.BonjourService API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.BonjourService).
|
|
358
376
|
|
|
359
377
|
### Properties (unique: 5/7)
|
|
360
378
|
| Property | Type | Default | Platform | Description |
|
|
@@ -383,27 +401,15 @@ Example:
|
|
|
383
401
|
---
|
|
384
402
|
|
|
385
403
|
## Ti.Network.Cookie
|
|
404
|
+
> Full released contract: [Titanium.Network.Cookie](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Cookie)
|
|
405
|
+
|
|
386
406
|
> Cookie object used to manage the system cookie store and HTTP client cookie store.
|
|
387
407
|
> Extends Ti.Proxy
|
|
388
408
|
> Platforms: both
|
|
389
409
|
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
``` js
|
|
393
|
-
if (!Date.prototype.toISOString) {
|
|
394
|
-
(function() {
|
|
395
|
-
function pad(number) {
|
|
396
|
-
const r = String(number);
|
|
397
|
-
if (r.length === 1) {
|
|
398
|
-
r = '0' + r;
|
|
399
|
-
}
|
|
400
|
-
return r;
|
|
401
|
-
}
|
|
402
|
-
|
|
403
|
-
Date.prototype.toISOString = function() {
|
|
404
|
-
```
|
|
410
|
+
Create a cookie with `Ti.Network.createCookie()`. For the complete cookie-store/WebView example and platform behavior, use the released contract linked below.
|
|
405
411
|
|
|
406
|
-
|
|
412
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Network.Cookie API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Cookie).
|
|
407
413
|
|
|
408
414
|
### Properties (unique: 11/14)
|
|
409
415
|
| Property | Type | Default | Platform | Description |
|
|
@@ -430,6 +436,8 @@ if (!Date.prototype.toISOString) {
|
|
|
430
436
|
---
|
|
431
437
|
|
|
432
438
|
## Ti.Network.HTTPClient
|
|
439
|
+
> Full released contract: [Titanium.Network.HTTPClient](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.HTTPClient)
|
|
440
|
+
|
|
433
441
|
> HTTP client object that (mostly) implements the XMLHttpRequest specification.
|
|
434
442
|
> Extends Ti.Proxy
|
|
435
443
|
> Platforms: both
|
|
@@ -448,7 +456,7 @@ Before opening the request, you must define one or more callbacks to handle the
|
|
|
448
456
|
|
|
449
457
|
The `HTTPClient` callbacks operate somewhat differently from other
|
|
450
458
|
|
|
451
|
-
|
|
459
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Network.HTTPClient API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.HTTPClient).
|
|
452
460
|
|
|
453
461
|
### Properties (unique: 31/39)
|
|
454
462
|
| Property | Type | Default | Platform | Description |
|
|
@@ -514,6 +522,8 @@ The `HTTPClient` callbacks operate somewhat differently from other
|
|
|
514
522
|
---
|
|
515
523
|
|
|
516
524
|
## Ti.Network.Socket
|
|
525
|
+
> Full released contract: [Titanium.Network.Socket](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Socket)
|
|
526
|
+
|
|
517
527
|
> Socket module, used for creating sockets.
|
|
518
528
|
> Extends Ti.Module
|
|
519
529
|
> Platforms: both
|
|
@@ -532,19 +542,21 @@ The `HTTPClient` callbacks operate somewhat differently from other
|
|
|
532
542
|
---
|
|
533
543
|
|
|
534
544
|
## Ti.Network.Socket.TCP
|
|
545
|
+
> Full released contract: [Titanium.Network.Socket.TCP](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Socket.TCP)
|
|
546
|
+
|
|
535
547
|
> TCP socket that implements the `Titanium.IOStream` interface.
|
|
536
548
|
> Extends Ti.IOStream
|
|
537
549
|
> Platforms: both
|
|
538
550
|
|
|
539
551
|
Most socket operations are asynchronous. When you create a socket, you can define callback functions to receive the results of API calls, as well as to handle incoming data.
|
|
540
552
|
|
|
541
|
-
For example, for a client-side socket, you define [connected](Titanium.Network.Socket.TCP
|
|
553
|
+
For example, for a client-side socket, you define [connected](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Socket.TCP) and [error](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Socket.TCP) callback functions.
|
|
542
554
|
|
|
543
|
-
To connect to a remote host, call the socket's [connect](Titanium.Network.Socket.TCP
|
|
555
|
+
To connect to a remote host, call the socket's [connect](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Socket.TCP) method. If the socket connects successfully, your `connected` callback is invoked, and you can send and receive data on the socket. If the socket connection fails, your `error` callback is invoked.
|
|
544
556
|
|
|
545
557
|
After a socket is connected, you can access it like any other <Titanium.IOStream>. Note that the socket's `read` and `write` methods may block, so in most cases
|
|
546
558
|
|
|
547
|
-
|
|
559
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.Network.Socket.TCP API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Socket.TCP).
|
|
548
560
|
|
|
549
561
|
### Properties (unique: 9/12)
|
|
550
562
|
| Property | Type | Default | Platform | Description |
|
|
@@ -566,13 +578,13 @@ After a socket is connected, you can access it like any other <Titanium.IOStream
|
|
|
566
578
|
| close(—) | void | both | Closes a socket. |
|
|
567
579
|
| connect(—) | void | both | Attempts to connect the socket to its host/port. |
|
|
568
580
|
| listen(—) | void | both | Attempts to start listening on the socket's host/port. |
|
|
569
|
-
| accept(options) | void | both | Tells a [LISTENING](Titanium.Network.Socket
|
|
581
|
+
| accept(options) | void | both | Tells a [LISTENING](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Socket) socket to accept a conne… |
|
|
570
582
|
|
|
571
583
|
|
|
572
584
|
### Related Types
|
|
573
585
|
|
|
574
586
|
#### AcceptDict
|
|
575
|
-
> Options object for the [accept](Titanium.Network.Socket.TCP
|
|
587
|
+
> Options object for the [accept](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.Socket.TCP) method.
|
|
576
588
|
|
|
577
589
|
| Property | Type | Description |
|
|
578
590
|
|----------|------|-------------|
|
|
@@ -582,6 +594,8 @@ After a socket is connected, you can access it like any other <Titanium.IOStream
|
|
|
582
594
|
---
|
|
583
595
|
|
|
584
596
|
## Ti.Network.TCPSocket
|
|
597
|
+
> Full released contract: [Titanium.Network.TCPSocket](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.Network.TCPSocket)
|
|
598
|
+
|
|
585
599
|
> The TCPSocket instance returned from <Titanium.Network.createTCPSocket>. This object represents a socket which either listens locally on the device for connections, or connects to a remote machine.
|
|
586
600
|
> Extends Ti.Proxy
|
|
587
601
|
> Platforms: ios
|