# Modules.PlayServices
Allows a Titanium application or module to use Google Play Services.
# Overview
Google Play Services is required by application developers to access Google service APIs such as Google Maps, Google Analytics, Firebase, etc.
# Getting Started
Add the module as a dependency to your application by adding a <module>
item to the
<modules>
element of your tiapp.xml
file:
<ti:app>
<!-- ... -->
<modules>
<module platform="android">ti.playservices</module>
</modules>
<!-- ... -->
</ti:app>
Or include the module as a dependency to a native module by adding a <module>
item to the
<modules>
element of your timodule.xml
file:
<ti:module>
<!-- ... -->
<modules>
<module platform="android">ti.playservices</module>
</modules>
<!-- ... -->
</ti:module>
Use require()
to access the module from JavaScript:
var PlayServices = require('ti.playservices');
The PlayServices
variable is a reference to the module. Make API calls using this reference:
var playServicesAvailable = PlayServices.isGooglePlayServicesAvailable();
# Properties
# apiName READONLY
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button
.
# bubbleParent
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# lifecycleContainer
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
# Methods
# addEventListener
Adds the specified callback as an event listener for the named event.
Parameters
Name | Type | Description |
---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
Name | Type | Description |
---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
Fires a synthesized event to any registered listeners.
Parameters
Name | Type | Description |
---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# getErrorString
Determines if the current device supports Touch ID.
Returns
- Type
- String
# isGooglePlayServicesAvailable
Verifies that Google Play services is installed and enabled on this device.
And that the version installed on this device is no older than the one required by this client.
Returns
- Type
- Number
# isUserResolvableError
Checks to see if device is configured for Touch ID authentication.
Returns
- Type
- Boolean
# makeGooglePlayServicesAvailable
Attempts to make Google Play services available on this device.
The callback
parameter is only available since 16.1.1.
Parameters
Name | Type | Description |
---|---|---|
callback | Callback<Modules.PlayServices.AvailableCallbackObject> | Callback fired with the result determining Google Play Services availability. |
Returns
- Type
- void
# removeEventListener
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback
parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
Name | Type | Description |
---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# Constants
# GOOGLE_PLAY_SERVICES_PACKAGE
Package name for Google Play services.
# GOOGLE_PLAY_SERVICES_VERSION_CODE
Google Play services client library version.
# RESULT_SERVICE_INVALID
The version of the Google Play services installed on this device is not authentic.
# RESULT_SERVICE_MISSING
Google Play services is missing on this device.
# RESULT_SERVICE_UPDATING
Google Play services is currently being updated on this device.
# RESULT_SERVICE_VERSION_UPDATE_REQUIRED
The installed version of Google Play services is out of date.