# Titanium.UI.iOS
Apple iOS specific UI capabilities. All properties, methods and events in this namespace will only work on Apple iOS devices.
# Properties
# appSupportsShakeToEdit
Determines whether the shake to edit system-wide capability is enabled.
# forceTouchSupported READONLY
Determines if the 3D-Touch capability "Force Touch" is supported (true
) or not (false
) by the device.
Returns true
if the device supports 3D-Touch (iPhone 6S / iPhone 6S Plus and later) or false
if not.
# statusBarBackgroundColor
Sets the global status bar background color for the application. Android does not support setting instances of Titanium.UI.Color
Default: Undefined (Uses the native defaults)
# Methods
# createAnchorAttachmentBehavior
Creates and returns an instance of Titanium.UI.iOS.AnchorAttachmentBehavior.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.AnchorAttachmentBehavior> | Properties to set on a new object, including any defined by Titanium.UI.iOS.AnchorAttachmentBehavior except those marked not-creation or read-only. |
Returns
# createAnimator
Creates and returns an instance of Titanium.UI.iOS.Animator.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.Animator> | Properties to set on a new object, including any defined by Titanium.UI.iOS.Animator except those marked not-creation or read-only. |
Returns
# createBlurView
Creates and returns an instance of Titanium.UI.iOS.BlurView.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.BlurView> | Properties to set on a new object, including any defined by Titanium.UI.iOS.BlurView except those marked not-creation or read-only. |
Returns
# createCollisionBehavior
Creates and returns an instance of Titanium.UI.iOS.CollisionBehavior.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.CollisionBehavior> | Properties to set on a new object, including any defined by Titanium.UI.iOS.CollisionBehavior except those marked not-creation or read-only. |
Returns
# createCoverFlowView
Creates and returns an instance of Titanium.UI.iOS.CoverFlowView.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.CoverFlowView> | Properties to set on a new object, including any defined by Titanium.UI.iOS.CoverFlowView except those marked not-creation or read-only. |
Returns
# createDocumentViewer
Creates and returns an instance of Titanium.UI.iOS.DocumentViewer.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.DocumentViewer> | Properties to set on a new object, including any defined by Titanium.UI.iOS.DocumentViewer except those marked not-creation or read-only. |
Returns
# createDynamicItemBehavior
Creates and returns an instance of Titanium.UI.iOS.DynamicItemBehavior.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.DynamicItemBehavior> | Properties to set on a new object, including any defined by Titanium.UI.iOS.DynamicItemBehavior except those marked not-creation or read-only. |
Returns
# createGravityBehavior
Creates and returns an instance of Titanium.UI.iOS.GravityBehavior.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.GravityBehavior> | Properties to set on a new object, including any defined by Titanium.UI.iOS.GravityBehavior except those marked not-creation or read-only. |
Returns
# createLivePhotoBadge
Creates a live photo badge to be used together with the Titanium.UI.iOS.LivePhotoView API.
Supported on iOS 9.1 and later.
Parameters
Name | Type | Description |
---|---|---|
type | Number | Constant defining the live photo badge behavior. |
Returns
- Type
- Titanium.Blob
# createLivePhotoView
Creates and returns an instance of Titanium.UI.iOS.LivePhotoView.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.LivePhotoView> | Properties to set on a new object, including any defined by Titanium.UI.iOS.LivePhotoView except those marked not-creation or read-only. |
Returns
# createMenuPopup
Creates and returns an instance of Titanium.UI.iOS.MenuPopup.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.MenuPopup> | Properties to set on a new object, including any defined by Titanium.UI.iOS.MenuPopup except those marked not-creation or read-only. |
Returns
# createNavigationWindow DEPRECATED
DEPRECATED SINCE 8.0.0
Use Titanium.UI.NavigationWindow instead.
Creates and returns an instance of Titanium.UI.iOS.NavigationWindow.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.NavigationWindow> | Properties to set on a new object, including any defined by Titanium.UI.iOS.NavigationWindow except those marked not-creation or read-only. |
Returns
# createPreviewAction
Creates and returns an instance of Titanium.UI.iOS.PreviewAction.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.PreviewAction> | Properties to set on a new object, including any defined by Titanium.UI.iOS.PreviewAction except those marked not-creation or read-only. |
Returns
# createPreviewActionGroup
Creates and returns an instance of Titanium.UI.iOS.PreviewActionGroup.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.PreviewActionGroup> | Properties to set on a new object, including any defined by Titanium.UI.iOS.PreviewActionGroup except those marked not-creation or read-only. |
Returns
# createPreviewContext
Creates and returns an instance of Titanium.UI.iOS.PreviewContext.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.PreviewContext> | Properties to set on a new object, including any defined by Titanium.UI.iOS.PreviewContext except those marked not-creation or read-only. |
Returns
# createPushBehavior
Creates and returns an instance of Titanium.UI.iOS.PushBehavior.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.PushBehavior> | Properties to set on a new object, including any defined by Titanium.UI.iOS.PushBehavior except those marked not-creation or read-only. |
Returns
# createSnapBehavior
Creates and returns an instance of Titanium.UI.iOS.SnapBehavior.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.SnapBehavior> | Properties to set on a new object, including any defined by Titanium.UI.iOS.SnapBehavior except those marked not-creation or read-only. |
Returns
# createSplitWindow
Creates and returns an instance of Titanium.UI.iOS.SplitWindow.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.SplitWindow> | Properties to set on a new object, including any defined by Titanium.UI.iOS.SplitWindow except those marked not-creation or read-only. |
Returns
# createStepper
Creates and returns an instance of Titanium.UI.iOS.Stepper.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.Stepper> | Properties to set on a new object, including any defined by Titanium.UI.iOS.Stepper except those marked not-creation or read-only. |
Returns
# createSystemButton
Creates and returns an instance of Titanium.UI.iOS.SystemButton.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.SystemButton> | Properties to set on a new object, including any defined by Titanium.UI.iOS.SystemButton except those marked not-creation or read-only. |
Returns
# createTabbedBar DEPRECATED
DEPRECATED SINCE 8.0.0
Use Titanium.UI.TabbedBar instead.
Creates and returns an instance of Titanium.UI.iOS.TabbedBar.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.TabbedBar> | Properties to set on a new object, including any defined by Titanium.UI.iOS.TabbedBar except those marked not-creation or read-only. |
Returns
# createToolbar DEPRECATED
DEPRECATED SINCE 6.2.0
Use the cross-platform Titanium.UI.Toolbar instead.
Creates and returns an instance of Titanium.UI.iOS.Toolbar.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.Toolbar> | Properties to set on a new object, including any defined by Titanium.UI.iOS.Toolbar except those marked not-creation or read-only. |
Returns
# createTransitionAnimation
Creates and returns an instance of Titanium.UI.iOS.TransitionAnimation.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.TransitionAnimation> | Properties to set on a new object, including any defined by Titanium.UI.iOS.TransitionAnimation except those marked not-creation or read-only. |
Returns
# createViewAttachmentBehavior
Creates and returns an instance of Titanium.UI.iOS.ViewAttachmentBehavior.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.ViewAttachmentBehavior> | Properties to set on a new object, including any defined by Titanium.UI.iOS.ViewAttachmentBehavior except those marked not-creation or read-only. |
Returns
# createWebViewConfiguration
Creates and returns an instance of Titanium.UI.iOS.WebViewConfiguration.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.WebViewConfiguration> | Properties to set on a new object, including any defined by Titanium.UI.iOS.WebViewConfiguration except those marked not-creation or read-only. |
Returns
# createWebViewDecisionHandler
Creates and returns an instance of Titanium.UI.iOS.WebViewDecisionHandler.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.WebViewDecisionHandler> | Properties to set on a new object, including any defined by Titanium.UI.iOS.WebViewDecisionHandler except those marked not-creation or read-only. |
Returns
# createWebViewProcessPool
Creates and returns an instance of Titanium.UI.iOS.WebViewProcessPool.
Parameters
Name | Type | Description |
---|---|---|
parameters | Dictionary<Titanium.UI.iOS.WebViewProcessPool> | Properties to set on a new object, including any defined by Titanium.UI.iOS.WebViewProcessPool except those marked not-creation or read-only. |
Returns
# systemImage
Get image from SF Symbols provided by Apple.
More details on SF Symbols can be found here. One can download SF Symbols app from here and use it to lookup the built-in SF Symbol name.
Parameters
Name | Type | Description |
---|---|---|
name | String | Name of SF Symbol. |
parameters | SystemImageParameters | Additional parameters to pass to the SF Symbol. Available in Titanium SDK 10.1.0 and later |
Returns
- Type
- Titanium.Blob
# Constants
# ACTION_POLICY_ALLOW
Allow the navigation to continue.
Use with invoke.
# AUDIOVISUAL_MEDIA_TYPE_ALL
All media types require a user gesture to begin playing.
Use with mediaTypesRequiringUserActionForPlayback
# AUDIOVISUAL_MEDIA_TYPE_AUDIO
Media types containing audio require a user gesture to begin playing.
Use with mediaTypesRequiringUserActionForPlayback
# AUDIOVISUAL_MEDIA_TYPE_NONE
No media types require a user gesture to begin playing.
Use with mediaTypesRequiringUserActionForPlayback
# AUDIOVISUAL_MEDIA_TYPE_VIDEO
Media types containing video require a user gesture to begin playing.
Use with mediaTypesRequiringUserActionForPlayback
# BLEND_MODE_CLEAR DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_CLEAR instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_COLOR DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_COLOR instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_COLOR_BURN DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_COLOR_BURN instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_COLOR_DODGE DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_COLOR_DODGE instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_COPY DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_COPY instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_DARKEN DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_DARKEN instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_DESTINATION_ATOP DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_DESTINATION_ATOP instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_DESTINATION_IN DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_DESTINATION_IN instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_DESTINATION_OUT DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_DESTINATION_OUT instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_DESTINATION_OVER DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_DESTINATION_OVER instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_DIFFERENCE DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_DIFFERENCE instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_EXCLUSION DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_EXCLUSION instead.
Image mode constant. Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_HARD_LIGHT DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_HARD_LIGHT instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_HUE DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_HUE instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_LIGHTEN DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_LIGHTEN instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_LUMINOSITY DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_LUMINOSITY instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_MULTIPLY DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_MULTIPLY instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_NORMAL DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_NORMAL instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_OVERLAY DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_OVERLAY instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_PLUS_DARKER DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_PLUS_DARKER instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_PLUS_LIGHTER DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_PLUS_LIGHTER instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_SATURATION DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_SATURATION instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_SCREEN DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_SCREEN instead.
Image mode constant. Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_SOFT_LIGHT DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_SOFT_LIGHT instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_SOURCE_ATOP DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_SOURCE_ATOP instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_SOURCE_IN DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_SOURCE_IN instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_SOURCE_OUT DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_SOURCE_OUT instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLEND_MODE_XOR DEPRECATED
DEPRECATED SINCE 7.3.0
Use BLEND_MODE_XOR instead.
Use with mode to specify a blend mode.
See Titanium.UI.MaskedImage for more information on blend modes.
# BLUR_EFFECT_STYLE_DARK
Use with effect to specify a blur effect.
Creates a blurring effect in the view. The area of the view is darker in hue than the underlying view.
# BLUR_EFFECT_STYLE_EXTRA_LIGHT
Use with effect to specify a blur effect.
Creates a blurring effect in the view. The area of the view is lighter in hue than the underlying view.
# BLUR_EFFECT_STYLE_LIGHT
Use with effect to specify a blur effect.
Creates a blurring effect in the view. The area of the view is the same approximate hue of the underlying view.
# BLUR_EFFECT_STYLE_PROMINENT
Use with effect to specify a blur effect.
Creates a blurring effect in the view. The area of the view is presented more prominent than the underlying view.
# BLUR_EFFECT_STYLE_REGULAR
Use with effect to specify a blur effect.
Creates a blurring effect in the view. The blurring effect is the default one specified in iOS 10.
# BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of the system chrome.
# BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL_DARK
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of an ultra-thin material and is always dark.
# BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL_LIGHT
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of the system chrome and is always light.
# BLUR_EFFECT_STYLE_SYSTEM_MATERIAL
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a material with normal thickness.
# BLUR_EFFECT_STYLE_SYSTEM_MATERIAL_DARK
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a thin material and is always dark.
# BLUR_EFFECT_STYLE_SYSTEM_MATERIAL_LIGHT
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a material with normal thickness and is always light.
# BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a material that is thicker than normal.
# BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL_DARK
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a material with normal thickness and is always dark.
# BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL_LIGHT
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a material that is thicker than normal and is always light.
# BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a thin material.
# BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL_DARK
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a material that is thicker than normal and is always dark.
# BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL_LIGHT
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a thin material and is always light.
# BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a material with normal thickness.
# BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL_DARK
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of the system chrome and is always dark.
# BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL_LIGHT
Use with effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of an ultra-thin material and is always light.
# CACHE_POLICY_RELOAD_IGNORING_LOCAL_CACHE_DATA
Specifies that the data for the URL load should be loaded from the originating source. No existing cache data should be used to satisfy a URL load request.
Use with cachePolicy.
# CACHE_POLICY_RETURN_CACHE_DATA_DONT_LOAD
Specifies that the existing cache data should be used to satisfy a request, regardless of its age or expiration date.
Use with cachePolicy. If there is no existing data in the cache corresponding to a URL load request, no attempt is made to load the data from the originating source, and the load is considered to have failed. This constant specifies a behavior that is similar to an offline mode.
# CACHE_POLICY_RETURN_CACHE_DATA_ELSE_LOAD
Specifies that the existing cached data should be used to satisfy the request, regardless of its age or expiration date.
Use with cachePolicy. If there is no existing data in the cache corresponding the request, the data is loaded from the originating source.
# CACHE_POLICY_USE_PROTOCOL_CACHE_POLICY
Specifies that the caching logic defined in the protocol implementation, if any, is used for a particular URL load request.
Use with cachePolicy. This is the default policy for URL load requests. If you are making HTTP or HTTPS byte-range requests, always use the CACHE_POLICY_RELOAD_IGNORING_LOCAL_CACHE_DATA policy.
# COLLISION_MODE_ALL
Use with collisionMode to specify collisions with both items and boundaries.
# COLLISION_MODE_BOUNDARY
Use with collisionMode to specify collisions with boundaries only.
# COLLISION_MODE_ITEM
Use with collisionMode to specify collisions with items only.
# CREDENTIAL_PERSISTENCE_FOR_SESSION
Credential should be stored only for this session.
Used with the persistence
argument of setBasicAuthentication to set the persistence level.
# CREDENTIAL_PERSISTENCE_NONE
Credential should not be stored.
Used with the persistence
argument of setBasicAuthentication to set the persistence level.
# CREDENTIAL_PERSISTENCE_PERMANENT
Credential should be stored in the keychain.
Used with the persistence
argument of setBasicAuthentication to set the persistence level.
# CREDENTIAL_PERSISTENCE_SYNCHRONIZABLE
Credential should be stored permanently in the keychain, and in addition should be distributed to other devices based on the owning AppleID.
Used with the persistence
argument of setBasicAuthentication to set the persistence level.
# DATE_PICKER_STYLE_AUTOMATIC DEPRECATED
DEPRECATED SINCE 10.0.1
Use DATE_PICKER_STYLE_AUTOMATIC instead.
Use with datePickerStyle to automatically pick the best style available for the current platform & mode.
Note: Prior to iOS 14, this property is only used on iOS Catalyst apps.
# DATE_PICKER_STYLE_COMPACT DEPRECATED
DEPRECATED SINCE 10.0.1
Use DATE_PICKER_STYLE_COMPACT instead.
Use with datePickerStyle to show the picker with a compact style. Editing occurs in an overlay.
Note: Prior to iOS 14, this property is only used on iOS Catalyst apps.
# DATE_PICKER_STYLE_INLINE DEPRECATED
DEPRECATED SINCE 10.0.1
Use DATE_PICKER_STYLE_INLINE instead.
Use with datePickerStyle to allow editing in place (as a calendar).
# DATE_PICKER_STYLE_WHEELS DEPRECATED
DEPRECATED SINCE 10.0.1
Use DATE_PICKER_STYLE_WHEELS instead.
Use with datePickerStyle to show the picker the wheels. Editing occurs inline.
# FEEDBACK_GENERATOR_IMPACT_STYLE_HEAVY
The heavy impact style used as the style
argument when creating a Titanium.UI.iOS.FeedbackGenerator with the
type FEEDBACK_GENERATOR_TYPE_IMPACT.
# FEEDBACK_GENERATOR_IMPACT_STYLE_LIGHT
The light impact style used as the style
argument when creating a Titanium.UI.iOS.FeedbackGenerator with the
type FEEDBACK_GENERATOR_TYPE_IMPACT.
# FEEDBACK_GENERATOR_IMPACT_STYLE_MEDIUM
The medium impact style used as the style
argument when creating a Titanium.UI.iOS.FeedbackGenerator with the
type FEEDBACK_GENERATOR_TYPE_IMPACT.
# FEEDBACK_GENERATOR_NOTIFICATION_TYPE_ERROR
The error notification type used as the argument in notificationOccurred.
# FEEDBACK_GENERATOR_NOTIFICATION_TYPE_SUCCESS
The success notification type used as the argument in notificationOccurred.
# FEEDBACK_GENERATOR_NOTIFICATION_TYPE_WARNING
The warning notification type used as the argument in notificationOccurred.
# FEEDBACK_GENERATOR_TYPE_IMPACT
The feedback type to be used when specifying an impact in Titanium.UI.iOS.FeedbackGenerator.
# FEEDBACK_GENERATOR_TYPE_NOTIFICATION
The feedback type to be used when specifying a received notification in Titanium.UI.iOS.FeedbackGenerator.
# FEEDBACK_GENERATOR_TYPE_SELECTION
The feedback type to be used when specifying a selection in Titanium.UI.iOS.FeedbackGenerator.
# INJECTION_TIME_DOCUMENT_END
Inject the script after the document finishes loading, but before other subresources finish loading.
Used to set the injectionTime
argument of addUserScript.
# INJECTION_TIME_DOCUMENT_START
Inject the script after the document element is created, but before any other content is loaded.
Used to set the injectionTime
argument of addUserScript.
# KEYBOARD_DISMISS_MODE_INTERACTIVE
Use with keyboardDismissMode to control keyboard dismiss mode.
The keyboard follows the dragging touch offscreen, and can be pulled upward again to cancel the dismiss.
# KEYBOARD_DISMISS_MODE_NONE
Use with keyboardDismissMode to control keyboard dismiss mode.
The keyboard does not get dismissed with a drag.
# KEYBOARD_DISMISS_MODE_ON_DRAG
Use with keyboardDismissMode to control keyboard dismiss mode.
The keyboard is dismissed when a drag begins.
# LARGE_TITLE_DISPLAY_MODE_ALWAYS
Always use a larger title when this item is top most.
Use with largeTitleDisplayMode.
# LARGE_TITLE_DISPLAY_MODE_AUTOMATIC
Automatically use the large out-of-line title based on the state of the p revious item in the navigation bar.
Use with largeTitleDisplayMode. An item with this
constant will show or hide the large title based on the request of the
previous navigation item. If the first item pushed is set to Automatic,
then it will show the large title if the navigation bar has the property
largeTitleEnabled set to true
.
# LARGE_TITLE_DISPLAY_MODE_NEVER
Never use a larger title when this item is top most.
Use with largeTitleDisplayMode.
# LIVEPHOTO_BADGE_OPTIONS_LIVE_OFF
To indicate that the Live Photo aspect is turned off and it will be treated as a still (e.g. for sharing).
Use with createLivePhotoBadge to specify the badge behavior.
# LIVEPHOTO_BADGE_OPTIONS_OVER_CONTENT
Include treatments so this image can be shown directly over the content of the Live Photo.
Use with createLivePhotoBadge to specify the badge behavior.
# LIVEPHOTO_PLAYBACK_STYLE_FULL
Plays back the entire motion and sound content of the Live Photo, including transition effects at the start and end.
This style matches the effect seen when pressing on a photo in the Photos app.
# LIVEPHOTO_PLAYBACK_STYLE_HINT
Plays back only a brief section of the motion content of the Live Photo, without sound.
This style matches the effect seen in various iOS interface elements for hinting to the user when an asset contains Live Photo content.
# MENU_POPUP_ARROW_DIRECTION_DEFAULT
An arrow that is automatically aligned.
# MENU_POPUP_ARROW_DIRECTION_DOWN
An arrow that points downward.
# MENU_POPUP_ARROW_DIRECTION_LEFT
An arrow that points toward the left.
# MENU_POPUP_ARROW_DIRECTION_RIGHT
An arrow that points toward the right.
# MODAL_PRESENTATION_CURRENT_CONTEXT
View presented with the same style as its parent window.
Used with the open and close methods.
One of the group of modal window presentation style constants MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN, MODAL_PRESENTATION_OVER_CURRENT_CONTEXT, MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.
# MODAL_PRESENTATION_FORMSHEET
Window width and height are smaller than those of the screen and the view is centered on the screen.
If the system is in a landscape orientation and the keyboard is visible, the position of the view is adjusted upward so that the view remains visible. All uncovered areas are dimmed and do not respond to touch to prevent the user from interacting with them.
Used with the open and close methods.
One of the group of modal window presentation style constants MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN, MODAL_PRESENTATION_OVER_CURRENT_CONTEXT, MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.
# MODAL_PRESENTATION_FULLSCREEN
Window covers the screen.
Used with the open and close methods.
One of the group of modal window presentation style constants MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN, MODAL_PRESENTATION_OVER_CURRENT_CONTEXT, MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.
# MODAL_PRESENTATION_OVER_CURRENT_CONTEXT
View presented over its parent window.
Used with the open and close methods.
One of the group of modal window presentation style constants MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN, MODAL_PRESENTATION_OVER_CURRENT_CONTEXT, MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.
# MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN
Presented view covers the screen.
The views beneath the presented content are not removed from the view hierarchy when the presentation finishes. So if the presented view controller does not fill the screen with opaque content, the underlying content shows through.
Used with the open and close methods.
One of the group of modal window presentation style constants MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN, MODAL_PRESENTATION_OVER_CURRENT_CONTEXT, MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.
# MODAL_PRESENTATION_PAGESHEET
Window height is the height of the screen and width is equal to screen width in a portrait orientation.
Any uncovered areas are dimmed and do not respond to touch, to prevent the user from interacting with them. In portrait orientations, this option is essentially the same as MODAL_PRESENTATION_FULLSCREEN.
Used with the open and close methods.
One of the group of modal window presentation style constants MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN, MODAL_PRESENTATION_OVER_CURRENT_CONTEXT, MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.
# MODAL_TRANSITION_STYLE_COVER_VERTICAL
When the window is presented, its view slides up from the bottom of the screen. On dismissal, the view slides back down (default.)
Used with the open and close methods.
One of the group of modal window transition style constants MODAL_TRANSITION_STYLE_COVER_VERTICAL, MODAL_TRANSITION_STYLE_CROSS_DISSOLVE, MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL, and MODAL_TRANSITION_STYLE_PARTIAL_CURL.
# MODAL_TRANSITION_STYLE_CROSS_DISSOLVE
When the window is presented, the current view fades out while the new view fades in at the same time. On dismissal, a similar type of cross-fade is used to return to the original view.
Used with the open and close methods.
One of the group of modal window transition style constants MODAL_TRANSITION_STYLE_COVER_VERTICAL, MODAL_TRANSITION_STYLE_CROSS_DISSOLVE, MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL, and MODAL_TRANSITION_STYLE_PARTIAL_CURL.
# MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL
When the window is presented, the current view initiates a horizontal 3D flip from right-to-left, resulting in the revealing of the new view as if it were on the back of the previous view. On dismissal, the flip occurs from left-to-right, returning to the original view.
Used with the open and close methods.
One of the group of modal window transition style constants MODAL_TRANSITION_STYLE_COVER_VERTICAL, MODAL_TRANSITION_STYLE_CROSS_DISSOLVE, MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL, and MODAL_TRANSITION_STYLE_PARTIAL_CURL.
# MODAL_TRANSITION_STYLE_PARTIAL_CURL
When the window is presented, one corner of the current view curls up to reveal the modal view underneath. On dismissal, the curled up page unfurls itself back on top of the modal view.
A modal view presented using this transition is itself prevented from presenting any additional modal views. This transition style is supported only if the window is presenting a MODAL_PRESENTATION_FULLSCREEN modal presentation style.
Used with the open and close methods.
One of the group of modal window transition style constants MODAL_TRANSITION_STYLE_COVER_VERTICAL, MODAL_TRANSITION_STYLE_CROSS_DISSOLVE, MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL, and MODAL_TRANSITION_STYLE_PARTIAL_CURL.
# PREVIEW_ACTION_STYLE_DEFAULT
The normal style for preview actions.
Used in conjunction with style / style property.
# PREVIEW_ACTION_STYLE_DESTRUCTIVE
The destructive style for preview actions.
Used in conjunction with style / style property.
# PREVIEW_ACTION_STYLE_SELECTED
The selected style for preview actions.
Used in conjunction with style / style property.
# PUSH_MODE_CONTINUOUS
Use with pushMode to specifiy a continuous force.
# PUSH_MODE_INSTANTANEOUS
Use with pushMode to specifiy an instantaneous force.
# ROW_ACTION_STYLE_DEFAULT
The default style for RowActionType.
Used in conjunction with editActions property and editaction event.
# ROW_ACTION_STYLE_DESTRUCTIVE
The destructive style for RowActionType.
Used in conjunction with editActions property and editaction event.
# ROW_ACTION_STYLE_NORMAL
The normal style for RowActionType.
Used in conjunction with editActions property and editaction event.
# SCROLL_DECELERATION_RATE_FAST
Use with decelerationRate to control deceleration rate.
# SCROLL_DECELERATION_RATE_NORMAL
Use with decelerationRate to control deceleration rate.
# SEARCH_BAR_STYLE_MINIMAL
Use with style to change the search bar style.
The search bar has no background, and the search field is translucent.
# SEARCH_BAR_STYLE_PROMINENT
Use with style to change the search bar style.
The search bar has a translucent background, and the search field is opaque.
# SELECTION_GRANULARITY_CHARACTER
Selection endpoints can be placed at any character boundary.
Use with selectionGranularity.
# SELECTION_GRANULARITY_DYNAMIC
Selection granularity varies automatically depending on the selection.
Use with selectionGranularity.
# SHORTCUT_ICON_TYPE_ADD
Number that represents the icon used for the application shortcut
An icon for a quick action that adds an item.
# SHORTCUT_ICON_TYPE_ALARM
Number that represents the icon used for the application shortcut
An icon for a quick action that offers creation of an alarm.
# SHORTCUT_ICON_TYPE_AUDIO
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of audio.
# SHORTCUT_ICON_TYPE_BOOKMARK
Number that represents the icon used for the application shortcut
An icon for a quick action that offers creation of a bookmark.
# SHORTCUT_ICON_TYPE_CAPTURE_PHOTO
Number that represents the icon used for the application shortcut
An icon for a quick action that offers photo capture.
# SHORTCUT_ICON_TYPE_CAPTURE_VIDEO
Number that represents the icon used for the application shortcut
An icon for a quick action that offers video capture.
# SHORTCUT_ICON_TYPE_CLOUD
Number that represents the icon used for the application shortcut
An icon for a quick action that offers cloud access.
# SHORTCUT_ICON_TYPE_COMPOSE
Number that represents the icon used for the application shortcut
An icon for a quick action that lets a user compose new content.
# SHORTCUT_ICON_TYPE_CONFIRMATION
Number that represents the icon used for the application shortcut
An icon for a quick action that indicates confirmation.
# SHORTCUT_ICON_TYPE_CONTACT
Number that represents the icon used for the application shortcut
An icon for a quick action that chooses a generic contact.
# SHORTCUT_ICON_TYPE_DATE
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of a calendar.
# SHORTCUT_ICON_TYPE_FAVORITE
Number that represents the icon used for the application shortcut
An icon for a quick action that lets a user designate a favorite item.
# SHORTCUT_ICON_TYPE_HOME
Number that represents the icon used for the application shortcut
An icon for a quick action that indicates home.
# SHORTCUT_ICON_TYPE_INVITATION
Number that represents the icon used for the application shortcut
An icon for a quick action that indicates an invitation.
# SHORTCUT_ICON_TYPE_LOCATION
Number that represents the icon used for the application shortcut
Will cause a magnifying glass icon to be displayed at that location in the index. This should generally only be used as the first title in the index.
# SHORTCUT_ICON_TYPE_LOVE
Number that represents the icon used for the application shortcut
An icon for a quick action that lets a user designate a loved item.
# SHORTCUT_ICON_TYPE_MAIL
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of mail.
# SHORTCUT_ICON_TYPE_MARK_LOCATION
Number that represents the icon used for the application shortcut
An icon for a quick action that lets a user mark a location.
# SHORTCUT_ICON_TYPE_MESSAGE
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of messaging.
# SHORTCUT_ICON_TYPE_PAUSE
Number that represents the icon used for the application shortcut
An icon for a quick action that pauses media playback.
# SHORTCUT_ICON_TYPE_PLAY
Number that represents the icon used for the application shortcut
An icon for a quick action that plays media.
# SHORTCUT_ICON_TYPE_PROHIBIT
Number that represents the icon used for the application shortcut
An icon for a quick action that disallows something.
# SHORTCUT_ICON_TYPE_SEARCH
Number that represents the icon used for the application shortcut
An icon for a quick action that accesses the user's current location.
# SHORTCUT_ICON_TYPE_SHARE
Number that represents the icon used for the application shortcut
An icon for a quick action that offers content sharing.
# SHORTCUT_ICON_TYPE_SHUFFLE
Number that represents the icon used for the application shortcut
An icon for a quick action that offers shuffle mode.
# SHORTCUT_ICON_TYPE_TASK
Number that represents the icon used for the application shortcut
An icon for a quick action that offers task creation.
# SHORTCUT_ICON_TYPE_TASK_COMPLETED
Number that represents the icon used for the application shortcut
An icon for a quick action that offers task completion.
# SHORTCUT_ICON_TYPE_TIME
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of a clock or timer.
# SHORTCUT_ICON_TYPE_UPDATE
Number that represents the icon used for the application shortcut
An icon for a quick action that offers updating.
# TABLEVIEW_INDEX_SEARCH
String that represents the magnifying glass on the table view index bar
Will cause a magnifying glass icon to be displayed at that location in the index. This should generally only be used as the first title in the index.
# WEBVIEW_NAVIGATIONTYPE_BACK_FORWARD DEPRECATED
DEPRECATED SINCE 8.2.0
Not used with Titanium SDK 8.0.0 and later by replacing UIWebView with WKWebView.
User tapped the back or forward button.
Used with the beforeload event.
Corresponds to iOS UIWebView
UIWebViewNavigationTypeBackForward
.
# WEBVIEW_NAVIGATIONTYPE_FORM_RESUBMITTED DEPRECATED
DEPRECATED SINCE 8.2.0
Not used with Titanium SDK 8.0.0 and later by replacing UIWebView with WKWebView.
User resubmitted a form.
Used with the beforeload event.
Corresponds to iOS UIWebView
UIWebViewNavigationTypeFormResubmitted
.
# WEBVIEW_NAVIGATIONTYPE_FORM_SUBMITTED DEPRECATED
DEPRECATED SINCE 8.2.0
Not used with Titanium SDK 8.0.0 and later by replacing UIWebView with WKWebView.
User submitted a form.
Used with the beforeload event.
Corresponds to iOS UIWebView
UIWebViewNavigationTypeFormSubmitted
.
# WEBVIEW_NAVIGATIONTYPE_LINK_CLICKED DEPRECATED
DEPRECATED SINCE 8.2.0
Not used with Titanium SDK 8.0.0 and later by replacing UIWebView with WKWebView.
User tapped a link.
Used with the beforeload event.
Corresponds to iOS UIWebView
UIWebViewNavigationTypeLinkClicked
.
# WEBVIEW_NAVIGATIONTYPE_OTHER DEPRECATED
DEPRECATED SINCE 8.2.0
Not used with Titanium SDK 8.0.0 and later by replacing UIWebView with WKWebView.
Some other action occurred.
Used with the beforeload event.
Corresponds to iOS UIWebView
UIWebViewNavigationTypeOther
.
# WEBVIEW_NAVIGATIONTYPE_RELOAD DEPRECATED
DEPRECATED SINCE 8.2.0
Not used with Titanium SDK 8.0.0 and later by replacing UIWebView with WKWebView.
User tapped the reload button.
Used with the beforeload event.
Corresponds to iOS UIWebView
UIWebViewNavigationTypeReload
.