@maccesar/titools 2.10.1 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/AGENTS-VERCEL-RESEARCH.md +23 -12
  2. package/README.md +81 -182
  3. package/agents/ti-pro.md +8 -14
  4. package/lib/cleanup.js +13 -0
  5. package/lib/commands/skills.js +2 -1
  6. package/lib/config.js +9 -11
  7. package/lib/platform.js +1 -1
  8. package/package.json +2 -3
  9. package/skills/purgetss/SKILL.md +44 -57
  10. package/skills/purgetss/references/EXAMPLES.md +8 -1
  11. package/skills/purgetss/references/app-branding.md +96 -16
  12. package/skills/purgetss/references/apply-directive.md +26 -1
  13. package/skills/purgetss/references/arbitrary-values.md +72 -2
  14. package/skills/purgetss/references/class-categories.md +1 -1
  15. package/skills/purgetss/references/cli-commands.md +37 -13
  16. package/skills/purgetss/references/customization-deep-dive.md +18 -11
  17. package/skills/purgetss/references/dynamic-component-creation.md +0 -1
  18. package/skills/purgetss/references/migration-guide.md +162 -1
  19. package/skills/purgetss/references/multi-density-images.md +69 -0
  20. package/skills/purgetss/references/version-history.md +82 -0
  21. package/skills/ti-expert/SKILL.md +1 -1
  22. package/skills/ti-ui/SKILL.md +1 -1
  23. package/skills/alloy-guides/SKILL.md +0 -190
  24. package/skills/alloy-guides/references/CLI_TASKS.md +0 -233
  25. package/skills/alloy-guides/references/CONCEPTS.md +0 -171
  26. package/skills/alloy-guides/references/CONTROLLERS.md +0 -279
  27. package/skills/alloy-guides/references/MODELS.md +0 -1214
  28. package/skills/alloy-guides/references/PURGETSS.md +0 -46
  29. package/skills/alloy-guides/references/VIEWS_DYNAMIC.md +0 -235
  30. package/skills/alloy-guides/references/VIEWS_STYLES.md +0 -375
  31. package/skills/alloy-guides/references/VIEWS_WITHOUT_CONTROLLERS.md +0 -102
  32. package/skills/alloy-guides/references/VIEWS_XML.md +0 -581
  33. package/skills/alloy-guides/references/WIDGETS.md +0 -160
  34. package/skills/alloy-howtos/SKILL.md +0 -181
  35. package/skills/alloy-howtos/references/best_practices.md +0 -121
  36. package/skills/alloy-howtos/references/cli_reference.md +0 -230
  37. package/skills/alloy-howtos/references/config_files.md +0 -158
  38. package/skills/alloy-howtos/references/custom_tags.md +0 -148
  39. package/skills/alloy-howtos/references/debugging_troubleshooting.md +0 -78
  40. package/skills/alloy-howtos/references/samples.md +0 -156
  41. package/skills/ti-api/SKILL.md +0 -109
  42. package/skills/ti-api/references/api-android.md +0 -675
  43. package/skills/ti-api/references/api-app-platform.md +0 -636
  44. package/skills/ti-api/references/api-core.md +0 -764
  45. package/skills/ti-api/references/api-data-network.md +0 -641
  46. package/skills/ti-api/references/api-media.md +0 -655
  47. package/skills/ti-api/references/api-modules-ble-bluetooth.md +0 -657
  48. package/skills/ti-api/references/api-modules-coremotion-urlsession.md +0 -411
  49. package/skills/ti-api/references/api-modules-map.md +0 -632
  50. package/skills/ti-api/references/api-modules-nfc.md +0 -725
  51. package/skills/ti-api/references/api-modules-social-misc.md +0 -526
  52. package/skills/ti-api/references/api-services.md +0 -700
  53. package/skills/ti-api/references/api-ui-android.md +0 -499
  54. package/skills/ti-api/references/api-ui-extras.md +0 -702
  55. package/skills/ti-api/references/api-ui-ios-animator.md +0 -378
  56. package/skills/ti-api/references/api-ui-ios.md +0 -756
  57. package/skills/ti-api/references/api-ui-lists.md +0 -581
  58. package/skills/ti-api/references/api-ui-text-input.md +0 -607
  59. package/skills/ti-api/references/api-ui-views.md +0 -572
  60. package/skills/ti-api/references/api-ui-windows-navigation.md +0 -676
  61. package/skills/ti-api/references/api-xml-global.md +0 -743
  62. package/skills/ti-guides/SKILL.md +0 -75
  63. package/skills/ti-guides/references/advanced-data-and-images.md +0 -155
  64. package/skills/ti-guides/references/android-manifest.md +0 -97
  65. package/skills/ti-guides/references/app-distribution.md +0 -373
  66. package/skills/ti-guides/references/application-frameworks.md +0 -366
  67. package/skills/ti-guides/references/cli-reference.md +0 -700
  68. package/skills/ti-guides/references/coding-best-practices.md +0 -150
  69. package/skills/ti-guides/references/commonjs-advanced.md +0 -279
  70. package/skills/ti-guides/references/hello-world.md +0 -99
  71. package/skills/ti-guides/references/hyperloop-native-access.md +0 -458
  72. package/skills/ti-guides/references/javascript-primer.md +0 -402
  73. package/skills/ti-guides/references/reserved-words.md +0 -36
  74. package/skills/ti-guides/references/resources.md +0 -172
  75. package/skills/ti-guides/references/style-and-conventions.md +0 -104
  76. package/skills/ti-guides/references/tiapp-config.md +0 -655
  77. package/skills/ti-howtos/SKILL.md +0 -143
  78. package/skills/ti-howtos/references/android-platform-deep-dives.md +0 -609
  79. package/skills/ti-howtos/references/automation-fastlane-appium.md +0 -96
  80. package/skills/ti-howtos/references/buffer-codec-streams.md +0 -162
  81. package/skills/ti-howtos/references/cross-platform-development.md +0 -358
  82. package/skills/ti-howtos/references/debugging-profiling.md +0 -473
  83. package/skills/ti-howtos/references/extending-titanium.md +0 -684
  84. package/skills/ti-howtos/references/google-maps-v2.md +0 -172
  85. package/skills/ti-howtos/references/ios-map-kit.md +0 -149
  86. package/skills/ti-howtos/references/ios-platform-deep-dives.md +0 -595
  87. package/skills/ti-howtos/references/local-data-sources.md +0 -310
  88. package/skills/ti-howtos/references/location-and-maps.md +0 -267
  89. package/skills/ti-howtos/references/media-apis.md +0 -268
  90. package/skills/ti-howtos/references/notification-services.md +0 -539
  91. package/skills/ti-howtos/references/remote-data-sources.md +0 -339
  92. package/skills/ti-howtos/references/tutorials.md +0 -552
  93. package/skills/ti-howtos/references/using-modules.md +0 -182
  94. package/skills/ti-howtos/references/web-content-integration.md +0 -288
  95. package/skills/ti-howtos/references/webpack-build-pipeline.md +0 -125
@@ -1,764 +0,0 @@
1
- # Ti Core API Reference
2
-
3
- ## Titanium
4
- > The top-level Titanium module.
5
- > Extends Ti.Module
6
- > Platforms: both
7
- > Type: module
8
-
9
- The Titanium module provides the Titanium Mobile API, allowing developers to access native
10
- features of each target environment. Currently, the Android and iOSenvironments are supported.
11
-
12
- ### Titanium Namespace
13
-
14
- The complete Titanium API is accessible from the `Titanium` namespace but, for convenience and
15
- brevity, the alias `Ti` is also provided. As the `Titanium` namespace is functionally-identical
16
- to its `Ti` alias, it is always recommended to use `Ti` in your code.
17
-
18
- For example, the following pairs of Titanium calls behave exactly the same.
19
-
20
- ``` js
21
- Titanium.API.info('Hello Titanium!');
22
- Ti.API.info('Hello Titanium!');
23
-
24
-
25
- *(See full overview in titanium-docs)*
26
-
27
- ### Properties (unique: 4/7)
28
- | Property | Type | Default | Platform | Description |
29
- |----------|------|---------|----------|-------------|
30
- | userAgent | String | — | both | User-agent string used by Titanium. |
31
- | version | String | — | both | Version of Titanium that is executing. |
32
- | buildDate | String | — | both | Date of the Titanium build. |
33
- | buildHash | String | — | both | Git hash of the Titanium build. |
34
-
35
-
36
- ### Methods (1)
37
- | Method | Returns | Platform | Description |
38
- |--------|---------|----------|-------------|
39
- | createBuffer(params) | Ti.Buffer | both | Creates a new buffer based on the params. |
40
-
41
-
42
- ### Related Types
43
-
44
- #### CreateBufferArgs
45
- > Arguments to be passed to createBuffer
46
-
47
- | Property | Type | Description |
48
- |----------|------|-------------|
49
- | value | String \| Number | An initial value which will be encoded and placed in the buffer. If value is a … |
50
- | length | Number | The length of the buffer. |
51
- | type | String | The type of data encoding to use with `value`. |
52
- | byteOrder | Number | The byte order of this buffer. |
53
-
54
- ---
55
-
56
- ## Ti.UI
57
- > The main <Titanium.UI> module.
58
- > Extends Ti.Module
59
- > Platforms: both
60
- > Type: module
61
-
62
- The UI module is responsible for native user-interface components and interaction inside
63
- Titanium. The goal of the UI module is to provide a native experience along with native
64
- performance by compiling Javascript code into their native counterparts as part of the
65
- build process.
66
-
67
- ### Design
68
-
69
- The UI module is broken down into 3 major area:
70
-
71
- * **Views** - [Views](Titanium.UI.View) are containers that host visual elements such as
72
- controls or other views. Views can have their properties customized, such as their border color
73
- and radius, can fire events such as swipe events or touches, and can optionally contain a
74
- hierarchy or other views as children. In Titanium, most views are specialized to perform both a
75
- visual function and set of interaction behaviors such as [Table View](Titanium.UI.TableView) or
76
- [Coverflow View](Titanium.UI.iOS.CoverFlowView). Views are always named with the suffix `View`.
77
-
78
- *(See full overview in titanium-docs)*
79
-
80
- ### Properties (unique: 9/285)
81
- | Property | Type | Default | Platform | Description |
82
- |----------|------|---------|----------|-------------|
83
- | semanticColorType | String | — | both | The current mode for the device (corresponding to night/dark or light/normal) |
84
- | availableSystemFontFamilies | Array<String> | — | both | Returns a list of font families that are provided by the system. |
85
- | backgroundColor | String \| Ti.UI.Color | — | both | Sets the background color of the master view (when there are no windows or othe… |
86
- | backgroundImage | String | — | both | Local path or URL to an image file for setting a background for the master view… |
87
- | overrideUserInterfaceStyle | Number | Titanium.UI.USER_INTERFACE_STYLE_UNSPECIFIED | both | Forces the app to used assigned theme instead of the system theme. |
88
- | tintColor | String \| Ti.UI.Color | — | ios | Sets the global tint color of the application. It is inherited by the child vie… |
89
- | userInterfaceStyle | Number | — | both | The style associated with the user interface. |
90
- | cutoutSize | CutoutSize | — | android | Returns the position and shape of the Android notch. Read more about the notch … |
91
- | statusBarHeight | Number | — | both | The total height of the status bar including safe area padding. |
92
-
93
- ### Constants (273)
94
- - **ANIMATION_CURVE_\***: ANIMATION_CURVE_LINEAR
95
- - **ANIMATION_CURVE_EASE_\***: ANIMATION_CURVE_EASE_IN, ANIMATION_CURVE_EASE_OUT
96
- - **ANIMATION_CURVE_EASE_IN_\***: ANIMATION_CURVE_EASE_IN_OUT
97
- - **ATTRIBUTE_\***: ATTRIBUTE_FONT, ATTRIBUTE_LIGATURE, ATTRIBUTE_KERN, ATTRIBUTE_SHADOW, ATTRIBUTE_LINK, ATTRIBUTE_OBLIQUENESS, ATTRIBUTE_EXPANSION
98
- - **ATTRIBUTE_BACKGROUND_\***: ATTRIBUTE_BACKGROUND_COLOR
99
- - **ATTRIBUTE_BASELINE_\***: ATTRIBUTE_BASELINE_OFFSET
100
- - **ATTRIBUTE_FOREGROUND_\***: ATTRIBUTE_FOREGROUND_COLOR
101
- - **ATTRIBUTE_LETTERPRESS_\***: ATTRIBUTE_LETTERPRESS_STYLE
102
- - **ATTRIBUTE_LINE_\***: ATTRIBUTE_LINE_BREAK
103
- - **ATTRIBUTE_LINE_BREAK_BY_\***: ATTRIBUTE_LINE_BREAK_BY_CLIPPING
104
- - **ATTRIBUTE_LINE_BREAK_BY_CHAR_\***: ATTRIBUTE_LINE_BREAK_BY_CHAR_WRAPPING
105
- - **ATTRIBUTE_LINE_BREAK_BY_TRUNCATING_\***: ATTRIBUTE_LINE_BREAK_BY_TRUNCATING_HEAD, ATTRIBUTE_LINE_BREAK_BY_TRUNCATING_MIDDLE, ATTRIBUTE_LINE_BREAK_BY_TRUNCATING_TAIL
106
- - **ATTRIBUTE_LINE_BREAK_BY_WORD_\***: ATTRIBUTE_LINE_BREAK_BY_WORD_WRAPPING
107
- - **ATTRIBUTE_PARAGRAPH_\***: ATTRIBUTE_PARAGRAPH_STYLE
108
- - **ATTRIBUTE_STRIKETHROUGH_\***: ATTRIBUTE_STRIKETHROUGH_STYLE, ATTRIBUTE_STRIKETHROUGH_COLOR
109
- - **ATTRIBUTE_STROKE_\***: ATTRIBUTE_STROKE_COLOR, ATTRIBUTE_STROKE_WIDTH
110
- - **ATTRIBUTE_SUBSCRIPT_\***: ATTRIBUTE_SUBSCRIPT_STYLE
111
- - **ATTRIBUTE_SUPERSCRIPT_\***: ATTRIBUTE_SUPERSCRIPT_STYLE
112
- - **ATTRIBUTE_TEXT_\***: ATTRIBUTE_TEXT_EFFECT
113
- - **ATTRIBUTE_UNDERLINE_\***: ATTRIBUTE_UNDERLINE_COLOR
114
- - **ATTRIBUTE_UNDERLINE_BY_\***: ATTRIBUTE_UNDERLINE_BY_WORD
115
- - **ATTRIBUTE_UNDERLINE_PATTERN_\***: ATTRIBUTE_UNDERLINE_PATTERN_SOLID, ATTRIBUTE_UNDERLINE_PATTERN_DOT, ATTRIBUTE_UNDERLINE_PATTERN_DASH
116
- - **ATTRIBUTE_UNDERLINE_PATTERN_DASH_\***: ATTRIBUTE_UNDERLINE_PATTERN_DASH_DOT
117
- - **ATTRIBUTE_UNDERLINE_PATTERN_DASH_DOT_\***: ATTRIBUTE_UNDERLINE_PATTERN_DASH_DOT_DOT
118
- - **ATTRIBUTE_UNDERLINE_STYLE_\***: ATTRIBUTE_UNDERLINE_STYLE_NONE, ATTRIBUTE_UNDERLINE_STYLE_SINGLE, ATTRIBUTE_UNDERLINE_STYLE_THICK, ATTRIBUTE_UNDERLINE_STYLE_DOUBLE
119
- - **ATTRIBUTE_UNDERLINES_\***: ATTRIBUTE_UNDERLINES_STYLE
120
- - **ATTRIBUTE_WRITING_\***: ATTRIBUTE_WRITING_DIRECTION
121
- - **ATTRIBUTE_WRITING_DIRECTION_\***: ATTRIBUTE_WRITING_DIRECTION_EMBEDDING, ATTRIBUTE_WRITING_DIRECTION_OVERRIDE, ATTRIBUTE_WRITING_DIRECTION_NATURAL
122
- - **ATTRIBUTE_WRITING_DIRECTION_LEFT_TO_\***: ATTRIBUTE_WRITING_DIRECTION_LEFT_TO_RIGHT
123
- - **ATTRIBUTE_WRITING_DIRECTION_RIGHT_TO_\***: ATTRIBUTE_WRITING_DIRECTION_RIGHT_TO_LEFT
124
- - **AUTOFILL_TYPE_\***: AUTOFILL_TYPE_USERNAME, AUTOFILL_TYPE_PASSWORD, AUTOFILL_TYPE_NAME, AUTOFILL_TYPE_NICKNAME, AUTOFILL_TYPE_LOCATION, AUTOFILL_TYPE_ADDRESS, AUTOFILL_TYPE_SUBLOCALITY, AUTOFILL_TYPE_PHONE, AUTOFILL_TYPE_EMAIL, AUTOFILL_TYPE_URL
125
- - **AUTOFILL_TYPE_ADDRESS_\***: AUTOFILL_TYPE_ADDRESS_LINE1, AUTOFILL_TYPE_ADDRESS_LINE2, AUTOFILL_TYPE_ADDRESS_CITY, AUTOFILL_TYPE_ADDRESS_STATE
126
- - **AUTOFILL_TYPE_ADDRESS_CITY_\***: AUTOFILL_TYPE_ADDRESS_CITY_STATE
127
- - **AUTOFILL_TYPE_CARD_\***: AUTOFILL_TYPE_CARD_NUMBER
128
- - **AUTOFILL_TYPE_CARD_EXPIRATION_\***: AUTOFILL_TYPE_CARD_EXPIRATION_DATE, AUTOFILL_TYPE_CARD_EXPIRATION_DAY, AUTOFILL_TYPE_CARD_EXPIRATION_MONTH, AUTOFILL_TYPE_CARD_EXPIRATION_YEAR
129
- - **AUTOFILL_TYPE_CARD_SECURITY_\***: AUTOFILL_TYPE_CARD_SECURITY_CODE
130
- - **AUTOFILL_TYPE_COUNTRY_\***: AUTOFILL_TYPE_COUNTRY_NAME
131
- - **AUTOFILL_TYPE_FAMILY_\***: AUTOFILL_TYPE_FAMILY_NAME
132
- - **AUTOFILL_TYPE_GIVEN_\***: AUTOFILL_TYPE_GIVEN_NAME
133
- - **AUTOFILL_TYPE_JOB_\***: AUTOFILL_TYPE_JOB_TITLE
134
- - **AUTOFILL_TYPE_MIDDLE_\***: AUTOFILL_TYPE_MIDDLE_NAME
135
- - **AUTOFILL_TYPE_NAME_\***: AUTOFILL_TYPE_NAME_PREFIX, AUTOFILL_TYPE_NAME_SUFFIX
136
- - **AUTOFILL_TYPE_NEW_\***: AUTOFILL_TYPE_NEW_PASSWORD
137
- - **AUTOFILL_TYPE_ONE_TIME_\***: AUTOFILL_TYPE_ONE_TIME_CODE
138
- - **AUTOFILL_TYPE_ORGANIZATION_\***: AUTOFILL_TYPE_ORGANIZATION_NAME
139
- - **AUTOFILL_TYPE_POSTAL_\***: AUTOFILL_TYPE_POSTAL_CODE
140
- - **AUTOLINK_\***: AUTOLINK_ALL, AUTOLINK_CALENDAR, AUTOLINK_URLS, AUTOLINK_NONE, AUTOLINK_MONEY
141
- - **AUTOLINK_EMAIL_\***: AUTOLINK_EMAIL_ADDRESSES
142
- - **AUTOLINK_FLIGHT_\***: AUTOLINK_FLIGHT_NUMBER
143
- - **AUTOLINK_LOOKUP_\***: AUTOLINK_LOOKUP_SUGGESTION
144
- - **AUTOLINK_MAP_\***: AUTOLINK_MAP_ADDRESSES
145
- - **AUTOLINK_PHONE_\***: AUTOLINK_PHONE_NUMBERS
146
- - **AUTOLINK_PHYSICAL_\***: AUTOLINK_PHYSICAL_VALUE
147
- - **AUTOLINK_SHIPMENT_TRACKING_\***: AUTOLINK_SHIPMENT_TRACKING_NUMBER
148
- - **BLEND_MODE_\***: BLEND_MODE_CLEAR, BLEND_MODE_COLOR, BLEND_MODE_COPY, BLEND_MODE_DARKEN, BLEND_MODE_DIFFERENCE, BLEND_MODE_EXCLUSION, BLEND_MODE_HUE, BLEND_MODE_LIGHTEN, BLEND_MODE_LUMINOSITY, BLEND_MODE_MULTIPLY, BLEND_MODE_NORMAL, BLEND_MODE_OVERLAY, BLEND_MODE_SATURATION, BLEND_MODE_SCREEN, BLEND_MODE_XOR
149
- - **BLEND_MODE_COLOR_\***: BLEND_MODE_COLOR_BURN, BLEND_MODE_COLOR_DODGE
150
- - **BLEND_MODE_DESTINATION_\***: BLEND_MODE_DESTINATION_ATOP, BLEND_MODE_DESTINATION_IN, BLEND_MODE_DESTINATION_OUT, BLEND_MODE_DESTINATION_OVER
151
- - **BLEND_MODE_HARD_\***: BLEND_MODE_HARD_LIGHT
152
- - **BLEND_MODE_PLUS_\***: BLEND_MODE_PLUS_DARKER, BLEND_MODE_PLUS_LIGHTER
153
- - **BLEND_MODE_SOFT_\***: BLEND_MODE_SOFT_LIGHT
154
- - **BLEND_MODE_SOURCE_\***: BLEND_MODE_SOURCE_ATOP, BLEND_MODE_SOURCE_IN, BLEND_MODE_SOURCE_OUT
155
- - **BREAK_\***: BREAK_SIMPLE, BREAK_BALANCED
156
- - **BREAK_HIGH_\***: BREAK_HIGH_QUALITY
157
- - **BUTTON_STYLE_\***: BUTTON_STYLE_FILLED, BUTTON_STYLE_OUTLINED, BUTTON_STYLE_TEXT
158
- - **BUTTON_STYLE_OPTION_\***: BUTTON_STYLE_OPTION_POSITIVE, BUTTON_STYLE_OPTION_NEGATIVE, BUTTON_STYLE_OPTION_NEUTRAL
159
- - **CLIPBOARD_OPTION_EXPIRATION_\***: CLIPBOARD_OPTION_EXPIRATION_DATE
160
- - **CLIPBOARD_OPTION_LOCAL_\***: CLIPBOARD_OPTION_LOCAL_ONLY
161
- - **DATE_PICKER_STYLE_\***: DATE_PICKER_STYLE_AUTOMATIC, DATE_PICKER_STYLE_WHEELS, DATE_PICKER_STYLE_COMPACT, DATE_PICKER_STYLE_INLINE
162
- - **EXTEND_EDGE_\***: EXTEND_EDGE_TOP, EXTEND_EDGE_BOTTOM, EXTEND_EDGE_LEFT, EXTEND_EDGE_RIGHT, EXTEND_EDGE_NONE, EXTEND_EDGE_ALL
163
- - **FACE_\***: FACE_DOWN, FACE_UP
164
- - **HIDDEN_BEHAVIOR_\***: HIDDEN_BEHAVIOR_GONE, HIDDEN_BEHAVIOR_INVISIBLE
165
- - **HINT_TYPE_\***: HINT_TYPE_STATIC, HINT_TYPE_ANIMATED
166
- - **HYPHEN_\***: HYPHEN_NONE, HYPHEN_NORMAL, HYPHEN_FULL
167
- - **HYPHEN_FULL_\***: HYPHEN_FULL_FAST
168
- - **HYPHEN_NORMAL_\***: HYPHEN_NORMAL_FAST
169
- - **INPUT_BORDERSTYLE_\***: INPUT_BORDERSTYLE_BEZEL, INPUT_BORDERSTYLE_LINE, INPUT_BORDERSTYLE_NONE, INPUT_BORDERSTYLE_ROUNDED, INPUT_BORDERSTYLE_UNDERLINED, INPUT_BORDERSTYLE_FILLED
170
- - **INPUT_BUTTONMODE_\***: INPUT_BUTTONMODE_ALWAYS, INPUT_BUTTONMODE_NEVER, INPUT_BUTTONMODE_ONBLUR, INPUT_BUTTONMODE_ONFOCUS
171
- - **INPUT_TYPE_CLASS_\***: INPUT_TYPE_CLASS_NUMBER, INPUT_TYPE_CLASS_TEXT
172
- - **KEYBOARD_APPEARANCE_\***: KEYBOARD_APPEARANCE_DEFAULT, KEYBOARD_APPEARANCE_DARK, KEYBOARD_APPEARANCE_LIGHT
173
- - **KEYBOARD_TYPE_\***: KEYBOARD_TYPE_ASCII, KEYBOARD_TYPE_DEFAULT, KEYBOARD_TYPE_EMAIL, KEYBOARD_TYPE_WEBSEARCH, KEYBOARD_TYPE_TWITTER, KEYBOARD_TYPE_URL
174
- - **KEYBOARD_TYPE_DECIMAL_\***: KEYBOARD_TYPE_DECIMAL_PAD
175
- - **KEYBOARD_TYPE_NAMEPHONE_\***: KEYBOARD_TYPE_NAMEPHONE_PAD
176
- - **KEYBOARD_TYPE_NUMBER_\***: KEYBOARD_TYPE_NUMBER_PAD
177
- - **KEYBOARD_TYPE_NUMBERS_\***: KEYBOARD_TYPE_NUMBERS_PUNCTUATION
178
- - **KEYBOARD_TYPE_PHONE_\***: KEYBOARD_TYPE_PHONE_PAD
179
- - **LANDSCAPE_\***: LANDSCAPE_LEFT, LANDSCAPE_RIGHT
180
- - **LIST_ACCESSORY_TYPE_\***: LIST_ACCESSORY_TYPE_NONE, LIST_ACCESSORY_TYPE_CHECKMARK, LIST_ACCESSORY_TYPE_DETAIL, LIST_ACCESSORY_TYPE_DISCLOSURE
181
- - **LIST_ITEM_TEMPLATE_\***: LIST_ITEM_TEMPLATE_DEFAULT, LIST_ITEM_TEMPLATE_SETTINGS, LIST_ITEM_TEMPLATE_CONTACTS, LIST_ITEM_TEMPLATE_SUBTITLE
182
- - **NOTIFICATION_DURATION_\***: NOTIFICATION_DURATION_LONG, NOTIFICATION_DURATION_SHORT
183
- - **OTHER_\***: FILL, PORTRAIT, SIZE, UNKNOWN
184
- - **PICKER_TYPE_\***: PICKER_TYPE_DATE, PICKER_TYPE_PLAIN, PICKER_TYPE_TIME
185
- - **PICKER_TYPE_COUNT_DOWN_\***: PICKER_TYPE_COUNT_DOWN_TIMER
186
- - **PICKER_TYPE_DATE_AND_\***: PICKER_TYPE_DATE_AND_TIME
187
- - **RETURNKEY_\***: RETURNKEY_CONTINUE, RETURNKEY_DEFAULT, RETURNKEY_DONE, RETURNKEY_GO, RETURNKEY_GOOGLE, RETURNKEY_JOIN, RETURNKEY_NEXT, RETURNKEY_ROUTE, RETURNKEY_SEARCH, RETURNKEY_SEND, RETURNKEY_YAHOO
188
- - **RETURNKEY_EMERGENCY_\***: RETURNKEY_EMERGENCY_CALL
189
- - **SELECTION_STYLE_\***: SELECTION_STYLE_NONE, SELECTION_STYLE_DEFAULT
190
- - **SEMANTIC_COLOR_TYPE_\***: SEMANTIC_COLOR_TYPE_DARK, SEMANTIC_COLOR_TYPE_LIGHT
191
- - **SWITCH_STYLE_\***: SWITCH_STYLE_CHECKBOX, SWITCH_STYLE_SLIDER, SWITCH_STYLE_CHIP
192
- - **SWITCH_STYLE_TOGGLE_\***: SWITCH_STYLE_TOGGLE_BUTTON
193
- - **TABLE_VIEW_SEPARATOR_STYLE_\***: TABLE_VIEW_SEPARATOR_STYLE_NONE
194
- - **TABLE_VIEW_SEPARATOR_STYLE_SINGLE_\***: TABLE_VIEW_SEPARATOR_STYLE_SINGLE_LINE
195
- - **TABS_STYLE_\***: TABS_STYLE_DEFAULT
196
- - **TABS_STYLE_BOTTOM_\***: TABS_STYLE_BOTTOM_NAVIGATION
197
- - **TEXT_ALIGNMENT_\***: TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_JUSTIFY, TEXT_ALIGNMENT_LEFT, TEXT_ALIGNMENT_RIGHT
198
- - **TEXT_AUTOCAPITALIZATION_\***: TEXT_AUTOCAPITALIZATION_ALL, TEXT_AUTOCAPITALIZATION_NONE, TEXT_AUTOCAPITALIZATION_SENTENCES, TEXT_AUTOCAPITALIZATION_WORDS
199
- - **TEXT_ELLIPSIZE_TRUNCATE_\***: TEXT_ELLIPSIZE_TRUNCATE_CLIP, TEXT_ELLIPSIZE_TRUNCATE_START, TEXT_ELLIPSIZE_TRUNCATE_MIDDLE, TEXT_ELLIPSIZE_TRUNCATE_END, TEXT_ELLIPSIZE_TRUNCATE_MARQUEE, TEXT_ELLIPSIZE_TRUNCATE_NONE
200
- - **TEXT_ELLIPSIZE_TRUNCATE_CHAR_\***: TEXT_ELLIPSIZE_TRUNCATE_CHAR_WRAP
201
- - **TEXT_ELLIPSIZE_TRUNCATE_WORD_\***: TEXT_ELLIPSIZE_TRUNCATE_WORD_WRAP
202
- - **TEXT_STYLE_\***: TEXT_STYLE_HEADLINE, TEXT_STYLE_SUBHEADLINE, TEXT_STYLE_BODY, TEXT_STYLE_FOOTNOTE, TEXT_STYLE_CAPTION1, TEXT_STYLE_CAPTION2, TEXT_STYLE_CALLOUT, TEXT_STYLE_TITLE1, TEXT_STYLE_TITLE2, TEXT_STYLE_TITLE3
203
- - **TEXT_STYLE_LARGE_\***: TEXT_STYLE_LARGE_TITLE
204
- - **TEXT_VERTICAL_ALIGNMENT_\***: TEXT_VERTICAL_ALIGNMENT_BOTTOM, TEXT_VERTICAL_ALIGNMENT_CENTER, TEXT_VERTICAL_ALIGNMENT_TOP
205
- - **UNIT_\***: UNIT_CM, UNIT_DIP, UNIT_IN, UNIT_MM, UNIT_PX
206
- - **UPSIDE_\***: UPSIDE_PORTRAIT
207
- - **URL_ERROR_\***: URL_ERROR_AUTHENTICATION, URL_ERROR_CONNECT, URL_ERROR_FILE, URL_ERROR_TIMEOUT, URL_ERROR_UNKNOWN
208
- - **URL_ERROR_BAD_\***: URL_ERROR_BAD_URL
209
- - **URL_ERROR_FILE_NOT_\***: URL_ERROR_FILE_NOT_FOUND
210
- - **URL_ERROR_HOST_\***: URL_ERROR_HOST_LOOKUP
211
- - **URL_ERROR_REDIRECT_\***: URL_ERROR_REDIRECT_LOOP
212
- - **URL_ERROR_SSL_\***: URL_ERROR_SSL_FAILED
213
- - **URL_ERROR_UNSUPPORTED_\***: URL_ERROR_UNSUPPORTED_SCHEME
214
- - **USER_INTERFACE_STYLE_\***: USER_INTERFACE_STYLE_UNSPECIFIED, USER_INTERFACE_STYLE_LIGHT, USER_INTERFACE_STYLE_DARK
215
-
216
-
217
- ### Methods (47)
218
- | Method | Returns | Platform | Description |
219
- |--------|---------|----------|-------------|
220
- | createMatrix2D(parameters) | Ti.UI.Matrix2D | both | Creates and returns an instance of <Titanium.UI.Matrix2D>. |
221
- | createMatrix3D(parameters) | Ti.UI.Matrix3D | both | Creates and returns an instance of <Titanium.UI.Matrix3D>. |
222
- | convertUnits(convertFromValue, convertToUnits) | Number | both | Converts one type of unit to another using the metrics of the main display. |
223
- | fetchSemanticColor(colorName) | void | both | Fetches the correct color to be used with a UI element dependent on the users c… |
224
- | createView(parameters) | Ti.UI.View | both | Creates and returns an instance of <Titanium.UI.View>. |
225
- | createActivityIndicator(parameters) | Ti.UI.ActivityIndicator | both | Creates and returns an instance of <Titanium.UI.ActivityIndicator>. |
226
- | createAlertDialog(parameters) | Ti.UI.AlertDialog | both | Creates and returns an instance of <Titanium.UI.AlertDialog>. |
227
- | createAnimation(parameters) | Ti.UI.Animation | both | Creates and returns an instance of <Titanium.UI.Animation>. |
228
- | createAttributedString(parameters) | Ti.UI.AttributedString | both | Creates and returns an instance of <Titanium.UI.AttributedString>. |
229
- | createButton(parameters) | Ti.UI.Button | both | Creates and returns an instance of <Titanium.UI.Button>. |
230
- | createButtonBar(parameters) | Ti.UI.ButtonBar | both | Creates and returns an instance of <Titanium.UI.ButtonBar>. |
231
- | createColor(parameters) | Ti.UI.Color | both | Creates and returns an instance of <Titanium.UI.Color>. |
232
- | createDashboardItem(parameters) | Ti.UI.DashboardItem | ios | Creates and returns an instance of <Titanium.UI.DashboardItem>. |
233
- | createDashboardView(parameters) | Ti.UI.DashboardView | ios | Creates and returns an instance of <Titanium.UI.DashboardView>. |
234
- | createEmailDialog(parameters) | Ti.UI.EmailDialog | both | Creates and returns an instance of <Titanium.UI.EmailDialog>. |
235
- | createImageView(parameters) | Ti.UI.ImageView | both | Creates and returns an instance of <Titanium.UI.ImageView>. |
236
- | createLabel(parameters) | Ti.UI.Label | both | Creates and returns an instance of <Titanium.UI.Label>. |
237
- | createListSection(parameters) | Ti.UI.ListSection | both | Creates and returns an instance of <Titanium.UI.ListSection>. |
238
- | createListView(parameters) | Ti.UI.ListView | both | Creates and returns an instance of <Titanium.UI.ListView>. |
239
- | createMaskedImage(parameters) | Ti.UI.MaskedImage | both | Creates and returns an instance of <Titanium.UI.MaskedImage>. |
240
- | createNavigationWindow(parameters) | Ti.UI.NavigationWindow | both | Creates and returns an instance of <Titanium.UI.NavigationWindow>. |
241
- | createNotification(parameters) | Ti.UI.Notification | android | Creates and returns an instance of <Titanium.UI.Notification>. |
242
- | createOptionBar(parameters) | Ti.UI.OptionBar | both | Creates and returns an instance of <Titanium.UI.OptionBar>. |
243
- | createOptionDialog(parameters) | Ti.UI.OptionDialog | both | Creates and returns an instance of <Titanium.UI.OptionDialog>. |
244
- | createPicker(parameters) | Ti.UI.Picker | both | Creates and returns an instance of <Titanium.UI.Picker>. |
245
- | createPickerColumn(parameters) | Ti.UI.PickerColumn | both | Creates and returns an instance of <Titanium.UI.PickerColumn>. |
246
- | createPickerRow(parameters) | Ti.UI.PickerRow | both | Creates and returns an instance of <Titanium.UI.PickerRow>. |
247
- | createProgressBar(parameters) | Ti.UI.ProgressBar | both | Creates and returns an instance of <Titanium.UI.ProgressBar>. |
248
- | createRefreshControl(parameters) | Ti.UI.RefreshControl | both | Creates and returns an instance of <Titanium.UI.RefreshControl>. |
249
- | createScrollView(parameters) | Ti.UI.ScrollView | both | Creates and returns an instance of <Titanium.UI.ScrollView>. |
250
- | createScrollableView(parameters) | Ti.UI.ScrollableView | both | Creates and returns an instance of <Titanium.UI.ScrollableView>. |
251
- | createSearchBar(parameters) | Ti.UI.SearchBar | both | Creates and returns an instance of <Titanium.UI.SearchBar>. |
252
- | createShortcut(parameters) | Ti.UI.Shortcut | both | Creates and returns an instance of <Titanium.UI.Shortcut>. |
253
- | createShortcutItem(parameters) | Ti.UI.ShortcutItem | both | Creates and returns an instance of <Titanium.UI.ShortcutItem>. |
254
- | createSlider(parameters) | Ti.UI.Slider | both | Creates and returns an instance of <Titanium.UI.Slider>. |
255
- | createSwitch(parameters) | Ti.UI.Switch | both | Creates and returns an instance of <Titanium.UI.Switch>. |
256
- | createTab(parameters) | Ti.UI.Tab | both | Creates and returns an instance of <Titanium.UI.Tab>. |
257
- | createTabGroup(parameters) | Ti.UI.TabGroup | both | Creates and returns an instance of <Titanium.UI.TabGroup>. |
258
- | createTabbedBar(parameters) | Ti.UI.TabbedBar | both | Creates and returns an instance of <Titanium.UI.TabbedBar>. |
259
- | createTableView(parameters) | Ti.UI.TableView | both | Creates and returns an instance of <Titanium.UI.TableView>. |
260
- | createTableViewRow(parameters) | Ti.UI.TableViewRow | both | Creates and returns an instance of <Titanium.UI.TableViewRow>. |
261
- | createTableViewSection(parameters) | Ti.UI.TableViewSection | both | Creates and returns an instance of <Titanium.UI.TableViewSection>. |
262
- | createTextArea(parameters) | Ti.UI.TextArea | both | Creates and returns an instance of <Titanium.UI.TextArea>. |
263
- | createTextField(parameters) | Ti.UI.TextField | both | Creates and returns an instance of <Titanium.UI.TextField>. |
264
- | createToolbar(parameters) | Ti.UI.Toolbar | both | Creates and returns an instance of <Titanium.UI.Toolbar>. |
265
- | createWebView(parameters) | Ti.UI.WebView | both | Creates and returns an instance of <Titanium.UI.WebView>. |
266
- | createWindow(parameters) | Ti.UI.Window | both | Creates and returns an instance of <Titanium.UI.Window>. |
267
-
268
- ### Events (1)
269
- | Event | Platform | Description |
270
- |-------|----------|-------------|
271
- | userinterfacestyle | both | Fired when the `userInterfaceStyle` changes. |
272
-
273
- ### Related Types
274
-
275
- #### CutoutSize
276
- > Dictionary object of parameters for the <Titanium.UI.cutoutSize>.
277
-
278
- | Property | Type | Description |
279
- |----------|------|-------------|
280
- | top | Number | The top position of the cutout. |
281
- | left | Number | The left position of the cutout. |
282
- | width | Number | The width of the cutout |
283
- | height | Number | The height of the cutout |
284
-
285
- #### Matrix2DCreationDict
286
- > Simple object passed to <Titanium.UI.createMatrix2D> to initialize a matrix.
287
-
288
- | Property | Type | Description |
289
- |----------|------|-------------|
290
- | scale | Number | Scale the matrix by the specified scaling factor. The same scaling factor is us… |
291
- | rotate | Number | Rotation angle, in degrees. See the [rotate](Titanium.UI.Matrix2D.rotate) metho… |
292
- | anchorPoint | Point | Point to rotate around, specified as a dictionary object with `x` and `y` prope… |
293
-
294
- #### Matrix3DCreationDict
295
- > Simple object passed to <Titanium.UI.createMatrix3D> to initialize a matrix.
296
-
297
- | Property | Type | Description |
298
- |----------|------|-------------|
299
- | scale | Number | Scale the matrix by the specified scaling factor. |
300
-
301
- ---
302
-
303
- ## Ti.API
304
- > The top-level API module, containing methods to output messages to the system log.
305
- > Extends Ti.Module
306
- > Platforms: both
307
- > Type: module
308
-
309
-
310
- ### Methods (7)
311
- | Method | Returns | Platform | Description |
312
- |--------|---------|----------|-------------|
313
- | debug(message) | void | both | Logs messages with a `debug` severity-level. |
314
- | error(message) | void | both | Logs messages with an `error` severity-level. |
315
- | info(message) | void | both | Logs messages with an `info` severity-level. |
316
- | log(level, message) | void | both | Logs messages with the specified severity-level. |
317
- | timestamp(message) | void | ios | Logs messages with a `timestamp` severity-level, prefixed with a timestamp floa… |
318
- | trace(message) | void | both | Logs messages with a `trace` severity-level. |
319
- | warn(message) | void | both | Logs messages with a `warn` severity-level. |
320
-
321
-
322
- ---
323
-
324
- ## Ti.Accelerometer
325
- > The top-level Accelerometer module, used to determine the device's physical position.
326
- > Extends Ti.Module
327
- > Platforms: both
328
- > Type: module
329
-
330
- An accelerometer is a hardware unit integrated into a mobile device, that detects when the
331
- device has moved, and returns its new orientation in a three-dimensional space. With its
332
- single `update` event, this module provides an interface to access the output positional data.
333
-
334
- An accelerometer needs to be switched on in order for it to report to the operating system,
335
- which consumes a lot of power that will deplete the battery over time. This is why it is
336
- recommended that the accelerometer is switched off when not in use.
337
-
338
- The accelerometer may be switched on and off by simply adding and removing the `update`
339
- event listener function. See the example for a demonstration.
340
-
341
-
342
-
343
- ### Events (1)
344
- | Event | Platform | Description |
345
- |-------|----------|-------------|
346
- | update | both | Fired when the accelerometer changes. |
347
-
348
- ---
349
-
350
- ## Ti.Blob
351
- > A container for binary data.
352
- > Extends Ti.Proxy
353
- > Platforms: both
354
-
355
- A `Blob` represents a chunk of binary information, often obtained through
356
- an [HTTPClient](Titanium.Network.HTTPClient) or by reading a [File](Titanium.Filesystem.File).
357
-
358
- Blobs are often used to store text or image data.
359
- The `Blob` object includes a number of properties and methods specific to image blobs.
360
-
361
- Android supports an [append](Titanium.Blob.append) method, but
362
- otherwise blobs are immutable.
363
-
364
- The <Titanium.Utils> module provides several utility methods for working with
365
- blobs, including methods for converting between blobs and Base64-encoded strings,
366
- and methods for generating SHA-1 and SHA-256 hashes and MD5 digests from blob data.
367
-
368
- The [Buffer](Titanium.Buffer) object can also contain binary data, and is
369
- more easily mutable. Extracting blob data to a buffer is somewhat roundabout:
370
-
371
- *(See full overview in titanium-docs)*
372
-
373
- ### Properties (unique: 11/14)
374
- | Property | Type | Default | Platform | Description |
375
- |----------|------|---------|----------|-------------|
376
- | file | Ti.Filesystem.File | — | both | File object represented by this blob, or `null` if this blob is not associated … |
377
- | length | Number | — | both | Length of this blob in bytes. |
378
- | text | String | — | both | UTF-8 string representation of the data in this blob. |
379
- | mimeType | String | — | both | Mime type of the data in this blob. |
380
- | height | Number | — | both | If this blob represents an image, this is the height of the image in pixels. |
381
- | uprightHeight | Number | — | both | If the blob references an image, this provides the height in pixels after facto… |
382
- | width | Number | — | both | If this blob represents an image, this is the width of the image in pixels. |
383
- | uprightWidth | Number | — | both | If the blob references an image, this provides the width in pixels after factor… |
384
- | nativePath | String | — | both | If this blob represents a [File](Titanium.Filesystem.File), this is the file UR… |
385
- | size | Number | — | both | Size of the blob in pixels (for image blobs) or bytes (for all other blobs). |
386
- | rotation | Number | — | android | EXIF rotation of the image if available. Can be `undefined` if no orientation w… |
387
-
388
-
389
- ### Methods (11)
390
- | Method | Returns | Platform | Description |
391
- |--------|---------|----------|-------------|
392
- | toString(—) | String | both | Returns a string representation of this blob. |
393
- | append(blob) | void | android | Appends the data from another blob to this blob. |
394
- | imageAsCropped(options) | Ti.Blob | both | Creates a new blob by cropping the underlying image to the specified dimensions. |
395
- | imageAsResized(width, height) | Ti.Blob | both | Creates a new blob by resizing and scaling the underlying image to the specifie… |
396
- | imageAsCompressed(quality) | Ti.Blob | both | Creates a new blob by compressing the underlying image to the specified quality. |
397
- | imageAsThumbnail(size, borderSize, cornerRadius) | Ti.Blob | both | Returns a thumbnail version of the underlying image, optionally with a border a… |
398
- | imageWithAlpha(—) | Ti.Blob | both | Returns a copy of the underlying image with an added alpha channel. |
399
- | imageWithRoundedCorner(cornerSize, borderSize) | Ti.Blob | both | Returns a copy of the underlying image with rounded corners added. |
400
- | imageWithTransparentBorder(size) | Ti.Blob | both | Returns a copy of the underlying image with an added transparent border. |
401
- | toArrayBuffer(—) | ArrayBuffer | both | Returns an `ArrayBuffer` representation of this blob. |
402
- | arrayBuffer(—) | Promise<ArrayBuffer> | both | Returns a `Promise` that resolves with the contents of the blob as binary data … |
403
-
404
-
405
- ### Related Types
406
-
407
- #### Dimension
408
- > A simple object consisting of the position and size measurements. Effectively combines <Size> and <Point> but ensures numeric x/y values.
409
-
410
- | Property | Type | Description |
411
- |----------|------|-------------|
412
- | height | Number | The height measurement. |
413
- | width | Number | The width measurement. |
414
- | x | Number | The x-axis coordinate of the position. When returned by <Titanium.UI.View.rect>… |
415
- | y | Number | The y-axis coordinate of the position. When returned by <Titanium.UI.View.rect>… |
416
-
417
- ---
418
-
419
- ## Ti.BlobStream
420
- > Wrapper around <Titanium.Blob> that implements the <Titanium.IOStream> interface.
421
- > Extends Ti.IOStream
422
- > Platforms: both
423
-
424
- Use the <Titanium.Stream.createStream> method to create a `BlobStream` instance from a
425
- `Blob`.
426
-
427
-
428
-
429
-
430
- ---
431
-
432
- ## Ti.Buffer
433
- > Buffer is a mutable, resizable container for raw data.
434
- > Extends Ti.Proxy
435
- > Platforms: both
436
-
437
- A `Buffer` works like a resizable array of byte values.
438
-
439
- Use the <Titanium.createBuffer> method to create a buffer.
440
-
441
- ### Properties (unique: 4/7)
442
- | Property | Type | Default | Platform | Description |
443
- |----------|------|---------|----------|-------------|
444
- | length | Number | 0 unless `value` is specified, in which case the length of the encoded data is used. | both | Length of the buffer in bytes. |
445
- | value | Number \| String | — | both | Data to be encoded. |
446
- | type | String | For string values, defaults to <Titanium.Codec.CHARSET_UTF8>. | both | The type of data encoding to use with `value`. |
447
- | byteOrder | Number | OS native byte order. | both | Byte order of this buffer. |
448
-
449
-
450
- ### Methods (9)
451
- | Method | Returns | Platform | Description |
452
- |--------|---------|----------|-------------|
453
- | append(sourceBuffer, sourceOffset, sourceLength) | Number | both | Appends `sourceBuffer` to the this buffer. |
454
- | insert(sourceBuffer, offset, sourceOffset, sourceLength) | Number | both | Inserts data from `sourceBuffer` into this buffer at `offset`. |
455
- | copy(sourceBuffer, offset, sourceOffset, sourceLength) | Number | both | Copies data from `sourceBuffer` into the current buffer at `offset`. |
456
- | clone(offset, length) | Ti.Buffer | both | Creates a complete or partial copy of this buffer. |
457
- | fill(fillByte, offset, length) | void | both | Fills this buffer with the specified byte value. |
458
- | clear(—) | void | both | Clears this buffer's contents but does not change the size of the buffer. |
459
- | release(—) | void | both | Releases the space allocated to the buffer, and sets its length to 0. |
460
- | toString(—) | String | both | Converts this buffer to a String. |
461
- | toBlob(—) | Ti.Blob | both | Converts this buffer to a <Titanium.Blob>. |
462
-
463
-
464
- ---
465
-
466
- ## Ti.BufferStream
467
- > Wrapper around <Titanium.Buffer> that implements the <Titanium.IOStream> interface.
468
- > Extends Ti.IOStream
469
- > Platforms: both
470
-
471
- Use the <Titanium.Stream.createStream> method to create a `BufferStream` instance from a
472
- `Buffer`.
473
-
474
-
475
-
476
-
477
- ---
478
-
479
- ## Ti.Codec
480
- > A module for translating between primitive types and raw byte streams.
481
- > Extends Ti.Module
482
- > Platforms: both
483
- > Type: module
484
-
485
- The `Codec` module can be used for encoding strings and numbers into [Buffer](Titanium.Buffer)
486
- objects, and decoding primitive types from buffers.
487
-
488
- ### Byte Order
489
-
490
- Multi-byte data can be stored in two different byte orders: big-endian or
491
- little-endian. In big-endian byte order, the most significant or highest-value
492
- byte is stored first. For example, the 4-byte integer 0xFEDCBA98 is made up of the
493
- bytes 0xFE, 0xDC, 0xBA and 0x98, from most-significant to least-significant.
494
-
495
- If we represent a buffer as an array of byte values, a big-endian encoding of
496
- 0xFEDCBA98 would look like this:
497
-
498
- ``` js
499
- [ 0xFE, 0xDC, 0xBA, 0x98 ]
500
-
501
- *(See full overview in titanium-docs)*
502
-
503
- ### Constants (14)
504
- - **BIG_\***: BIG_ENDIAN
505
- - **CHARSET_\***: CHARSET_ASCII, CHARSET_UTF8, CHARSET_UTF16, CHARSET_UTF16BE, CHARSET_UTF16LE
506
- - **CHARSET_ISO_LATIN_\***: CHARSET_ISO_LATIN_1
507
- - **LITTLE_\***: LITTLE_ENDIAN
508
- - **TYPE_\***: TYPE_BYTE, TYPE_SHORT, TYPE_INT, TYPE_FLOAT, TYPE_LONG, TYPE_DOUBLE
509
-
510
-
511
- ### Methods (5)
512
- | Method | Returns | Platform | Description |
513
- |--------|---------|----------|-------------|
514
- | getNativeByteOrder(—) | Number | both | Get the OS native byte order (either <Titanium.Codec.BIG_ENDIAN> or <Titanium.C… |
515
- | encodeNumber(options) | Number | both | Encodes a number and writes it to a buffer. |
516
- | decodeNumber(options) | Number | both | Decodes a number from the `source` buffer using the specified data type. |
517
- | encodeString(options) | Number | both | Encodes a string into a series of bytes in a buffer using the specified charact… |
518
- | decodeString(options) | String | both | Decodes the source buffer into a String using the supplied character set. |
519
-
520
-
521
- ### Related Types
522
-
523
- #### DecodeNumberDict
524
- > Named parameters for <Titanium.Codec.decodeNumber>.
525
-
526
- | Property | Type | Description |
527
- |----------|------|-------------|
528
- | source | Ti.Buffer | Buffer to decode. |
529
- | type | String | The encoding type to use. |
530
- | position | Number | Index in the `source` buffer of the first byte of data to decode. |
531
- | byteOrder | Number | byte order to decode with. |
532
-
533
- #### DecodeStringDict
534
- > Named parameters for <Titanium.Codec.decodeString>.
535
-
536
- | Property | Type | Description |
537
- |----------|------|-------------|
538
- | source | Ti.Buffer | Buffer to decode. |
539
- | position | Number | Index in the `source` buffer of the first byte of data to decode. |
540
- | length | Number | Number of bytes to decode. |
541
- | charset | String | Character set to use when encoding this string to bytes. |
542
-
543
- #### EncodeNumberDict
544
- > Named parameters for <Titanium.Codec.encodeNumber>.
545
-
546
- | Property | Type | Description |
547
- |----------|------|-------------|
548
- | source | Number | Number to encode. |
549
- | dest | Ti.Buffer | Destination buffer. |
550
- | type | String | Encoding type to use. |
551
- | position | Number | Index in the `dest` buffer of the first byte of encoded data. |
552
- | byteOrder | Number | Byte order to encode with. |
553
-
554
- ---
555
-
556
- ## Ti.Gesture
557
- > The Gesture module is responsible for high-level device gestures such as orientation changes and shake gestures.
558
- > Extends Ti.Module
559
- > Platforms: both
560
- > Type: module
561
-
562
- ### Properties (unique: 3/6)
563
- | Property | Type | Default | Platform | Description |
564
- |----------|------|---------|----------|-------------|
565
- | portrait | Boolean | — | both | Indicates if the device is currently held in portrait form. |
566
- | landscape | Boolean | — | both | Indicates if the device is currently held in landscape form. |
567
- | orientation | Number | — | both | Orientation of the device. |
568
-
569
-
570
- ### Methods (1)
571
- | Method | Returns | Platform | Description |
572
- |--------|---------|----------|-------------|
573
- | stopListener(—) | void | android | Stops the gesture listener. |
574
-
575
- ### Events (2)
576
- | Event | Platform | Description |
577
- |-------|----------|-------------|
578
- | orientationchange | both | Fired when the device orientation changes. |
579
- | shake | both | Fired when the device is shaken. |
580
-
581
- ---
582
-
583
- ## Ti.IOStream
584
- > IOStream is the interface that all stream types implement.
585
- > Extends Ti.Proxy
586
- > Platforms: both
587
-
588
- See the <Titanium.Stream> module for related utility methods that support asynchronous
589
- I/O.
590
-
591
-
592
- ### Methods (5)
593
- | Method | Returns | Platform | Description |
594
- |--------|---------|----------|-------------|
595
- | read(buffer, offset, length, resultsCallback) | Number | both | Reads data from this stream into a buffer. |
596
- | write(buffer, offset, length, resultsCallback) | Number | both | Writes data from a buffer to this stream. |
597
- | isWritable(—) | Boolean | both | Indicates whether this stream is writable. |
598
- | isReadable(—) | Boolean | both | Indicates whether this stream is readable. |
599
- | close(—) | void | both | Closes this stream. |
600
-
601
-
602
- ---
603
-
604
- ## Ti.Locale
605
- > The top level Locale module.
606
- > Extends Ti.Module
607
- > Platforms: both
608
- > Type: module
609
-
610
- The `Locale` module works with localization files to which are generated during compilation
611
- into the operating system specific localization formats. The `Locale` module provides
612
- locale-specific strings which can be referenced at runtime. Additionally, the module
613
- contains a few methods and properties for querying device locale information.
614
-
615
- The macro `L` can be used as an alias for the <Titanium.Locale.getString> method.
616
-
617
- ### Properties (unique: 3/6)
618
- | Property | Type | Default | Platform | Description |
619
- |----------|------|---------|----------|-------------|
620
- | currentCountry | String | — | both | Country of the app's current locale, as an ISO 2-letter code. |
621
- | currentLanguage | String | — | both | Language of the app's current locale, as an ISO 2-letter code. |
622
- | currentLocale | String | — | both | Current app locale, as a combination of ISO 2-letter language and country codes. |
623
-
624
-
625
- ### Methods (7)
626
- | Method | Returns | Platform | Description |
627
- |--------|---------|----------|-------------|
628
- | formatTelephoneNumber(number) | String | android | Formats a telephone number according to the current system locale. |
629
- | getCurrencyCode(locale) | String | both | Returns the ISO 3-letter currency code for the specified locale. |
630
- | getCurrencySymbol(currencyCode) | String | both | Returns the currency symbol for the specified currency code. |
631
- | setLanguage(language) | void | both | Sets the current language of the application. |
632
- | getLocaleCurrencySymbol(locale) | String | both | Returns the currency symbol for the specified locale. |
633
- | getString(key, hint) | String | both | Returns a string, localized according to the current system locale using the ap… |
634
- | parseDecimal(text, locale) | Number | both | Parses a number from the given string using the current or given locale. |
635
-
636
- ### Events (1)
637
- | Event | Platform | Description |
638
- |-------|----------|-------------|
639
- | change | both | Fired when the device locale changes. |
640
-
641
- ---
642
-
643
- ## Ti.Stream
644
- > Stream module containing stream utility methods.
645
- > Extends Ti.Module
646
- > Platforms: both
647
- > Type: module
648
-
649
- This module provides a set of methods for interacting with
650
- [IOStream](Titanium.IOStream) objects, including asynchronous versions of the
651
- `read` and `write` methods offered by all stream objects. These
652
- methods should be used in any place where reading from or writing
653
- to a stream might block.
654
-
655
- See also:
656
-
657
- * <Titanium.IOStream>
658
- * <Titanium.BlobStream>
659
- * <Titanium.BufferStream>
660
- * <Titanium.Filesystem.FileStream>
661
- * <Titanium.Network.Socket.TCP>
662
-
663
- ### Constants (3)
664
- - **MODE_\***: MODE_READ, MODE_WRITE, MODE_APPEND
665
-
666
-
667
- ### Methods (6)
668
- | Method | Returns | Platform | Description |
669
- |--------|---------|----------|-------------|
670
- | createStream(params) | Ti.IOStream | both | Creates stream from a `Buffer` or `Blob` object. |
671
- | read(sourceStream, buffer, offset, length, resultsCallback) | void | both | Asynchronously reads data from an [IOStream](Titanium.IOStream) into a buffer. |
672
- | readAll(sourceStream, buffer, resultsCallback) | void | both | Reads all data from the specified [IOStream](Titanium.IOStream). |
673
- | write(outputStream, buffer, offset, length, resultsCallback) | void | both | Asynchronously writes data from a buffer to an [IOStream](Titanium.IOStream). |
674
- | writeStream(inputStream, outputStream, maxChunkSize, resultsCallback) | void | both | Writes all data from an input stream to an output stream. |
675
- | pump(inputStream, handler, maxChunkSize, isAsync) | void | both | Reads data from input stream and passes it to a handler method. |
676
-
677
-
678
- ### Related Types
679
-
680
- #### CreateStreamArgs
681
- > Argument passed to [createStream](Titanium.Stream.createStream).
682
-
683
- | Property | Type | Description |
684
- |----------|------|-------------|
685
- | source | Ti.Blob \| Ti.Buffer | Object that the stream will read from or write to. |
686
- | mode | Number | Mode to open the stream in. |
687
-
688
- ---
689
-
690
- ## Ti.Utils
691
- > The top-level Utils module, containing a set of JavaScript methods that are often useful when building applications.
692
- > Extends Ti.Module
693
- > Platforms: both
694
- > Type: module
695
-
696
-
697
- ### Methods (5)
698
- | Method | Returns | Platform | Description |
699
- |--------|---------|----------|-------------|
700
- | base64decode(obj) | Ti.Blob | both | Returns the specified data decoded from Base64. |
701
- | base64encode(obj) | Ti.Blob | both | Returns the specified data encoded to Base64. |
702
- | md5HexDigest(obj) | String | both | Returns a MD5 digest of the specified data as a hex-based String. |
703
- | sha1(obj) | String | both | Returns a SHA-1 hash of the specified data as a hex-based String. |
704
- | sha256(obj) | String | both | Returns a SHA-256 hash of the specified data as a hex-based String. |
705
-
706
-
707
- ---
708
-
709
- ## Ti.Proxy
710
- > The base for all Titanium objects.
711
- > Extends Object
712
- > Platforms: both
713
-
714
- On platforms that use native code (Android and iOS), the `Proxy` type represents a
715
- JavaScript wrapper or _proxy_ around a native object. Setting or getting a property
716
- on a proxy object results in a method invocation on the native object. Likewise,
717
- calling a method on the proxy object results in a method invocation on the native
718
- object.
719
-
720
- Some Titanium objects are _createable_: new instances of these objects can be created using
721
- factory methods. For example, a [Window](Titanium.UI.Window) object can be created using the
722
-
723
- ### Properties (unique: 3/3)
724
- | Property | Type | Default | Platform | Description |
725
- |----------|------|---------|----------|-------------|
726
- | bubbleParent | Boolean | true | both | Indicates if the proxy will bubble an event to its parent. |
727
- | apiName | String | — | both | The name of the API that this proxy corresponds to. |
728
- | lifecycleContainer | Ti.UI.Window \| Ti.UI.TabGroup | — | android | The Window or TabGroup whose Activity lifecycle should be triggered on the prox… |
729
-
730
-
731
- ### Methods (4)
732
- | Method | Returns | Platform | Description |
733
- |--------|---------|----------|-------------|
734
- | addEventListener(name, callback) | void | both | Adds the specified callback as an event listener for the named event. |
735
- | removeEventListener(name, callback) | void | both | Removes the specified callback as an event listener for the named event. |
736
- | fireEvent(name, event) | void | both | Fires a synthesized event to any registered listeners. |
737
- | applyProperties(props) | void | both | Applies the properties to the proxy. |
738
-
739
-
740
- ### Related Types
741
-
742
- #### Dictionary
743
- > Plain JavaScript object.
744
-
745
- ---
746
-
747
- ## Ti.Module
748
- > Base type for all Titanium modules.
749
- > Extends Ti.Proxy
750
- > Platforms: both
751
- > Type: module
752
-
753
- A Titanium module is a non-createable Titanium object that is exposed through the
754
- global Titanium object.
755
-
756
- For example, the <Titanium.UI> module provides constants and factory methods related
757
- to UI objects, as well as a few UI-related properties that are not related to a
758
- specific object.
759
-
760
-
761
-
762
-
763
- ---
764
-