<commit_before>---
name: Titanium.App
summary: The top level App module. The App module is mainly used for accessing information about the application at runtime.
description: |
    The `App` module exposes a number of properties set in the `tiapp.xml` file. 
    Three of these properties, the application name, ID, and URL, must be specified in the 
    new project wizard when you create an application. 
    
    Most values can be changed by editing the `tiapp.xml` file after creating the project.
    However, the GUID property is automatically generated and should not be changed.

extends: Titanium.Module
since: "0.1"
methods:
  - name: getArguments
    summary: Return the arguments passed to the application on startup as a dictionary.
    platforms: [iphone, ipad]
    returns:
        type: Dictionary
events:
  - name: proximity
    summary: Fired when the iPhone proximity sensor changes state.
    description: |
        The iOS proximity sensor detects whether the device is being held up 
        to the user's ear, and shuts down the display.

        If [proximityDetection](Titanium.App.proximityDetection) is `true`,
        events are generated whenever the proximity sensor changes state.
    properties:
      - name: state
        summary: Proximity state value.
    platforms: [iphone, ipad]
  - name: resume
    summary: Fired when an iOS application will enter the foreground due to iOS 4's multitasking.
    description: |
        This does not include pauses due to notifications or calls. See
        [applicationWillEnterForeground](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIApplication_Class/Reference/Reference.html#//apple_ref/doc/uid/TP40006728-CH3-SW108) for
        the exact behavior that triggers this event.
    platforms: [iphone, ipad]
  - name: resumed
    summary: Fired when an iOS application will return to being the focus. 
    description: |
        This includes not
        only the events that trigger the `resume` event, but also pauses due to notifications 
        or calls. See
        [applicationDidBecomeActive](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/Reference/Reference.html#//apple_ref/doc/uid/TP40006786-CH3-SW10) for
        the exact behavior that triggers this event.
    platforms: [iphone, ipad]
  - name: pause
    summary: Fired when an iOS application will stop being the focus. 
    description: |
        This includes not only the user leaving the application, 
        but also pauses due to notifications or calls. See [applicationWillResignActive](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/Reference/Reference.html#//apple_ref/doc/uid/TP40006786-CH3-SW10) 
        for the exact behavior that triggers this event.
        
        Note that making calls to functions which modify the UI during this
        event may cause execution **up to** the UI call before the suspension,
        but then execute the **remainder** of the callback after the application is
        resumed (but before the `resume` event is triggered).
    platforms: [iphone, ipad]
properties:
  - name: copyright
    summary: Application's copyright statement, from `tiapp.xml`.
    type: String
    permission: read-only
  - name: description
    summary: Application's description, from `tiapp.xml`.
    type: String
    permission: read-only
  - name: guid
    summary: Application's globally unique id, from `tiapp.xml`
    description: This value is system generated and consistent through all versions.
    type: String
    permission: read-only
  - name: id
    summary: Application's app ID, from `tiapp.xml`. 
    description: |
        The application ID is a required property you must specify when creating a new project.
    type: String
    permission: read-only
  - name: idleTimerDisabled
    summary: Controls whether the phone screen will be locked on idle time. 
    description: Set to `true` to disable the timer.
    type: Boolean
    platforms: [iphone, ipad]
  - name: name
    summary: Application's name, from `tiapp.xml`.
    type: String
    permission: read-only
  - name: proximityDetection
    summary: Boolean to indicate whether proximity detection is enabled. 
    description: |
        Set to `true` to receive `proximity` events.

        See the [proximity](Titanium.App.proxmity) event for more information.
    type: Boolean
    platforms: [iphone, ipad]
    default: false
  - name: proximityState
    summary: State of the device's proximity sensor. 
    description: |
        Set to `true` if the proximity sensor is close to the user.
        
        If the `proximityDetection` is false, the value of this property is undefined.

        See the [proximity](Titanium.App.proxmity) event for more information.
    type: Boolean
    platforms: [iphone, ipad]
    permission: read-only
  - name: publisher
    summary: Application's publisher, from `tiapp.xml`.
    type: String
    permission: read-only
  - name: url
    summary: Application URL, from `tiapp.xml`.
    type: String
    permission: read-only
  - name: version
    summary: Application version, from `tiapp.xml`.
    type: String
    permission: read-only<commit_msg>TIDOC-14: APIDoc: Ti.App rewrite rev1<commit_after>---
name: Titanium.App
summary: The top level App module. The App module is mainly used for accessing information about the application at runtime.
description: |
    The `App` module exposes a number of properties set in the `tiapp.xml` file.  
    
    Three of these properties, the application name, ID, and URL, must be specified when the 
    application is created.  
    
    While most values may be changed by editing the `tiapp.xml` file after creating the project, 
    the GUID is automatically generated and should not be changed.

extends: Titanium.Module
since: "0.1"

methods:
  - name: getArguments
    summary: Returns the arguments passed to the application on startup.
    platforms: [iphone, ipad]
    returns:
        type: Dictionary

events:
  - name: proximity
    summary: Fired when the proximity sensor changes state.
    description: |
        The proximity sensor detects whether the device is being held up to the user's ear, 
        and shuts down the display.

        Proximity events are only fired when [proximityDetection](Titanium.App.proximityDetection) 
        is `true`.
    properties:
      - name: state
        summary: Proximity state value.
    platforms: [iphone, ipad]
    
  - name: resume
    summary: Fired when the application enters the foreground on a multitasked system.
    description: |
        Note that this event does not fire for pauses resulting from notifications or incoming phonecalls.  
        
        For iOS, see [applicationWillEnterForeground](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIApplication_Class/Reference/Reference.html#//apple_ref/doc/uid/TP40006728-CH3-SW108) 
        for the exact behavior that triggers this event.  
    platforms: [iphone, ipad]
    
  - name: resumed
    summary: Fired when the application returns to focus.
    description: |
        This event fires when the application enters the foreground with the `resume` event or 
        returns to focus after notifications and incoming phonecalls.  
        
        For iOS, see [applicationDidBecomeActive](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/Reference/Reference.html#//apple_ref/doc/uid/TP40006786-CH3-SW10) 
        for the exact behavior that triggers this event.  
    platforms: [iphone, ipad]
    
  - name: pause
    summary: Fired when the application ceases being the focus. 
    description: |
        This event fires when the user leaves the application or it is paused due to notifications 
        and incoming phonecalls.  
        
        For iOS, see [applicationWillResignActive](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/Reference/Reference.html#//apple_ref/doc/uid/TP40006786-CH3-SW10) 
        for the exact behavior that triggers this event.  
        
        Note that calls to functions that modify the UI during this event may be partially executed, 
        **up to** the UI call before the suspension. If this happens, the **remainder** of the code 
        will be executed after the application is resumed, but before the `resume` event is triggered.
    platforms: [iphone, ipad]
    
properties:
  - name: copyright
    summary: Application copyright statement, from `tiapp.xml`.
    type: String
    permission: read-only
    
  - name: description
    summary: Application description, from `tiapp.xml`.
    type: String
    permission: read-only
    
  - name: guid
    summary: Application globally-unique ID, from `tiapp.xml`.
    description: This value is system-generated and consistent through all versions.
    type: String
    permission: read-only
    
  - name: id
    summary: Application ID, from `tiapp.xml`. 
    description: |
        The application ID is a required property that must be specified when creating a new project.
    type: String
    permission: read-only
    
  - name: idleTimerDisabled
    summary: Determines whether the screen is locked when the device is idle. 
    description: Set to `true` to disable the timer.
    type: Boolean
    platforms: [iphone, ipad]
    
  - name: name
    summary: Application name, from `tiapp.xml`.
    type: String
    permission: read-only
    
  - name: proximityDetection
    summary: Determines whether proximity detection is enabled. 
    description: |
        Set to `true` to receive <Titanium.App.proximity> events.
    type: Boolean
    default: false
    platforms: [iphone, ipad]
    
  - name: proximityState
    summary: |
        Indicates the state of the device's proximity sensor, according to the 
        <Titanium.App.proximity> event.
    description: |
        This property is `true` when the proximity sensor is close to the user.  
        
        When <Titanium.App.proximityDetection> is disabled, the value of this property is undefined.
    type: Boolean
    permission: read-only
    platforms: [iphone, ipad]
    
  - name: publisher
    summary: Application publisher, from `tiapp.xml`.
    type: String
    permission: read-only
    
  - name: url
    summary: Application URL, from `tiapp.xml`.
    type: String
    permission: read-only
    
  - name: version
    summary: Application version, from `tiapp.xml`.
    type: String
    permission: read-only
{'fraction_non_alphanumeric': 0.06993795826283136, 'fraction_numerical': 0.007144200037601053, 'mean_word_length': 2.9786836200448765, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 20}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '785758', 'n_tokens_mistral': 2915, 'n_tokens_neox': 2809, 'n_words': 1133}