Ti.Bump Module

Description

A module supporting Bump(TM) functionality for your app. This allows devices to communicate when they are tapped together.

WARNING

You MUST copy the contents of the "Resources" in the bump module's zip to your project's "Resources" folder manually before running this demo!

Accessing the bump Module

To access this module from JavaScript, you would do the following:

Titanium.Bump = Ti.Bump = require("ti.bump");

Methods

Ti.Bump.connect

Opens up the bump dialog, asking the user to bump two devices together.

Arguments

Takes one argument, a dictionary with keys:

• apikey[string]: Your API key; you can get this from http://bu.mp/apiagree
• username[string]: Your Bump(TM) username
• message[string]: The message to display while waiting for connections
• view[object]: The view proxy which will contain the Bump(TM) connection window.

Fires the event "ready" after the dialog shows up, and "connected" after connecting to another device.

Ti.Bump.disconnect

Stop listening for connections.

Ti.Bump.sendMessage

Sends a message via Bump(TM). Only utilize this after the "connected" event fires, and before the "disconnected" event fires.

Arguments

Takes one argument, a string. If the message fails to send, the "error" event fires.

Events

ready

Event indicating that Bump(TM) is ready for connections.

error

Event indicating an error occurred. Has one property, "message", which is the error message.

connected

Event indicating that there is a connection to another device. Has one property, "username", which is the username of the other device.

disconnected

Event indicating that the connection ended. Has one property, "message", which is one of:

• ENDUSERQUIT: The user quit the service
• ENDLOSTNET: The user's device lost network
• ENDOTHERUSER_QUIT: The user on the other device quit the service
• ENDUSEROTHER_LOST: The connection to the other user was lost

error

Event indicating there was an error with the connection. Has one property, "message", which is one of:

• Not connected: Sent when a message send attempt is made before connect() is called.
• UNKNOWN: Unknown failure
• FAIL_NONE: No failure
• FAILNETWORKUNAVAILABLE: No network connection
• FAILINVALIDAUTHORIZATION: The authorization tokens provided when connecting are invalid
• FAILEXCEEDEDRATE_LIMIT: Exceeded transfer limit
• FAILEXPIREDKEY: The API key used to connect has expired
• FAILBADCONTACT: Improper contact was made.

cancel

Event indicating the user cancelled the connection. Has one property, "message", which always has the value "FAILUSERCANCELED".

data

A message was transmitted between devices over the connection. Has one property, "data", which is a blob of type "text/plain" that holds text.

Usage

See example.js

Author

Jeff Haynie jhaynie@appcelerator.com, Appcelerator Inc.

License

Copyright(c) 2010-2011 by Appcelerator, Inc. All Rights Reserved. Please see the LICENSE file included in the distribution for further details.