Skip to content

Commit

Permalink
docs: add missing types for events properties
Browse files Browse the repository at this point in the history
  • Loading branch information
drauggres authored and sgtcoolguy committed Dec 2, 2019
1 parent 0250df0 commit 76cd92a
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 1 deletion.
5 changes: 4 additions & 1 deletion apidoc/Titanium/Accelerometer/Accelerometer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,19 @@ events:
summary: |
Reference timestamp since the previous change. This is not a valid timestamp and should
simply be used to determine the number of milliseconds between events.
type: Number

- name: y
summary: Current `y` axis of the device.
type: Number

- name: x
summary: Current `x` axis of the device.
type: Number

- name: z
summary: Current `z` axis of the device.
type: Number

examples:
- title: Basic Accelerometer Event
Expand Down
1 change: 1 addition & 0 deletions apidoc/Titanium/Android/QuickSettingsService.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ events:
properties:
- name: itemIndex
summary: Index of the selected item from the single choice menu in the dialog.
type: Number

- name: tiledialogcancelled
summary: Dispatched when the alert dialog has been cancelled.
Expand Down
2 changes: 2 additions & 0 deletions apidoc/Titanium/Android/Service.yml
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ events:
For example, if you have an interval-based Service running every 10 seconds, iteration
3 would occur at about 30 seconds after you start the instance (assuming your service
code runs quickly).
type: Number

- name: resume
summary: |
Expand All @@ -289,6 +290,7 @@ events:
For example, if you have an interval-based Service running every 10 seconds, iteration
3 would occur at about 30 seconds after you start the instance (assuming your service
code runs quickly).
type: Number

- name: start
summary: Fired when the bound service instance starts.
Expand Down
4 changes: 4 additions & 0 deletions apidoc/Titanium/Media/AudioPlayer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ events:
constants: Titanium.Media.AUDIO_STATE_*
- name: description
summary: Text description of the state of playback.
type: Number

- name: complete
summary: Fired when the audio has finished playing.
Expand Down Expand Up @@ -271,6 +272,7 @@ events:
properties:
- name: progress
summary: Current progress, in milliseconds.
type: Number

- name: seek
summary: Fired once the [seekToTime](Titanium.Media.AudioPlayer.seek) method completes.
Expand All @@ -282,6 +284,8 @@ events:
If the new request completes without being interrupted by another seek
request or by any other operation this event will be invoked with
the `finished` parameter set to `true`.
type: Boolean
platforms: [iphone, ipad]
properties:
- name: STATE_BUFFERING
summary: Audio data is being buffered from the network.
Expand Down
1 change: 1 addition & 0 deletions apidoc/Titanium/Media/Sound.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ events:
constants: Titanium.Media.Sound.STATE_*
- name: description
summary: Text description of the state of playback.
type: String

- name: complete
summary: Fired when the audio has finished playing.
Expand Down
1 change: 1 addition & 0 deletions apidoc/Titanium/Network/BonjourBrowser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ events:
properties:
- name: services
summary: An array of BonjourService objects corresponding to currently available services. If you cache this value, including using it as table data, be aware that it could become out of date at any time due to the asynchronous nature of Bonjour service discovery.
type: Array
since: '3.0.0'

properties:
Expand Down
2 changes: 2 additions & 0 deletions apidoc/Titanium/Network/TCPSocket.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ events:
properties:
- name: from
summary: the reference for the socket that data was retrieved from
type: Number
- name: data
summary: a blob representing the data read, can be interpreted via toString
type: Titanium.Blob
- name: readError
summary: an error occured when reading
properties:
Expand Down
3 changes: 3 additions & 0 deletions apidoc/Titanium/UI/ImageView.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ events:
properties:
- name: index
summary: Index of the image frame being displayed.
type: Number

- name: load
summary: |
Expand Down Expand Up @@ -121,6 +122,8 @@ events:

- name: image
summary: URL of the image that failed to load.
type: String
optional: true

- name: pause
summary: Fired when the animation pauses.
Expand Down
1 change: 1 addition & 0 deletions apidoc/Titanium/UI/Slider.yml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ events:
summary: |
Dictionary with properties `width` and `height` of the size of the thumb.
Available with custom thumb image.
type: Dictionary
platforms: [android]

- name: thumbOffset
Expand Down
4 changes: 4 additions & 0 deletions apidoc/Titanium/UI/WebView.yml
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,7 @@ events:
This event does not fire when navigating remote web pages.
properties:
- name: url
type: String
summary: URL of the web document being loaded.

- name: navigationType
Expand Down Expand Up @@ -497,6 +498,7 @@ events:
summary: Fired when the web view content is loaded.
properties:
- name: url
type: String
summary: URL of the web document.

- name: onLoadResource
Expand Down Expand Up @@ -530,6 +532,7 @@ events:
properties:
- name: url
summary: The URL of the web document that is stopped.
type: String
deprecated:
since: "6.1.0"
notes: Use the cross-platform `blacklisturl` event instead.
Expand All @@ -541,6 +544,7 @@ events:
properties:
- name: url
summary: The URL of the web document that is stopped.
type: String

- name: message
summary: Fired when a script message is received from a webpage.
Expand Down

0 comments on commit 76cd92a

Please sign in to comment.