mirror of
https://github.com/purplecabbage/phonegap-plugins.git
synced 2026-01-14 00:47:54 -05:00
137 lines
4.9 KiB
Plaintext
137 lines
4.9 KiB
Plaintext
# Twitter plugin for Phonegap #
|
|
|
|
v1.1 - Fix for cordova 2.2.0+
|
|
|
|
This is inspired from the excellent iOS' plugin: https://github.com/phonegap/phonegap-plugins/tree/master/iPhone/Twitter
|
|
|
|
For the moment, only two (major) functions are binding:
|
|
1. isTwitterAvailable
|
|
2. composeTweet
|
|
|
|
## Adding the Plugin to your project ##
|
|
|
|
Using this plugin requires [Android PhoneGap](http://github.com/phonegap/phonegap-android).
|
|
|
|
1. To install the plugin, move www/twitter.js to your project's www folder and include a reference to it in your html file after phonegap.js.
|
|
|
|
<script type="text/javascript" charset="utf-8" src="phonegap.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="twitter.js"></script>
|
|
|
|
2. Create a directory within your project called "src/com/phonegap/plugins/twitter" and move Twitter.java into it.
|
|
|
|
3. In your res/xml/plugins.xml file add the following line:
|
|
|
|
<plugin name="Twitter" value="com.phonegap.plugins.twitter.Twitter"/>
|
|
|
|
## Using the plugin ##
|
|
|
|
The plugin creates the object `window.plugins.twitter`. To use, call one of the following, available methods:
|
|
|
|
/**
|
|
* Check if Twitter is installed
|
|
*
|
|
*/
|
|
isTwitterAvailable(success, failure)
|
|
|
|
Sample use:
|
|
|
|
window.plugins.twitter.isTwitterAvailable(
|
|
function(bool){
|
|
if(bool){
|
|
// Do something
|
|
|
|
} else {
|
|
alert("Twitter is not available");
|
|
}
|
|
},
|
|
function(){
|
|
alert("We have a problem with the plugin");
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Compose tweet and open the Twitter application
|
|
*/
|
|
composeTweet(success, failure, message) {
|
|
|
|
|
|
Sample use:
|
|
|
|
window.plugins.twitter.composeTweet(
|
|
function(){
|
|
},
|
|
function(){
|
|
alert("We have a problem with the plugin");
|
|
},
|
|
"Base of the tweet"
|
|
);
|
|
|
|
|
|
## LICENSE ##
|
|
|
|
PhoneGap is available under *either* the terms of the modified BSD license *or* the
|
|
MIT License (2008). As a recipient of PhonegGap, you may choose which
|
|
license to receive this code under (except as noted in per-module LICENSE
|
|
files). Some modules may not be the copyright of Nitobi. These
|
|
modules contain explicit declarations of copyright in both the LICENSE files in
|
|
the directories in which they reside and in the code itself. No external
|
|
contributions are allowed under licenses which are fundamentally incompatible
|
|
with the MIT or BSD licenses that PhoneGap is distributed under.
|
|
|
|
The text of the MIT and BSD licenses is reproduced below.
|
|
|
|
---
|
|
|
|
### The "New" BSD License
|
|
|
|
Copyright (c) 2005-2011, Nitobi Software Inc.
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
|
|
* Redistributions of source code must retain the above copyright notice, this
|
|
list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above copyright notice,
|
|
this list of conditions and the following disclaimer in the documentation
|
|
and/or other materials provided with the distribution.
|
|
* Neither the name of Phonegap/Nitobi nor the names of its contributors
|
|
may be used to endorse or promote products derived from this software
|
|
without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
|
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
---
|
|
|
|
### The MIT License
|
|
|
|
Copyright (c) <2012> <Objet Direct>
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
|