Git Product home page Git Product logo

xing-android-sdk's Introduction

XING Android SDK


Add all the power of the XING platform to your Android app using the XING Android SDK.

This library provides an Android implementation of the network layer infrastructure required to access the XING Web Services. Basically this SDK provides a standalone RequestExecutor, Module, Tasks and requests, which reflect the public XING API which can be found here.

Currently the following resources are available as Tasks in the XING Android SDK:

How to get Started

1. Add the SDK to your project

Add the SDK as a dependency:

Either through Gradle:

compile 'com.xing.android:sdk:0.9.0'

or by using Maven:

<dependency>
  <groupId>com.xing.android</groupId>
  <artifactId>sdk</artifactId>
  <version>0.9.0</version>
</dependency>

2. Add OAuth credentials to your project

Add your OAuth Consumer Key and OAuth Consumer Secret to your local.properties file.

The OAuth information can be obtained after registering a new app on https://dev.xing.com/applications

The file should then look something like this:

local.properties

	oauth_consumer_secret=xxxxxxxxxxxxxxxxxxxx
	oauth_consumer_key=yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
	sdk.dir=zzz

You are also free to provide this information in any other way. For example using Preferences or a helper class containing the OAuth credentials in CONSTANTS.

3. Build your first app

To build your first app with the XING Android SDK check out the Get started page

Contributing

If you have an idea how to improve the XING Android SDK, feel free to either suggest your idea using the issues, or send us a Pull Request. If you do the latter please make sure you observe the rules for contributing below.

  1. Fork this repository
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Make sure to cover your new feature with sufficient unit tests
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request
  7. Wait for us to review your feature, discuss internal and eventually accept your Pull Request
  8. Enjoy using your feature inside the XING Android SDK

Contact

If you have any problems or feedback, feel free to contact us:

Libraries used

License

Copyright (c) 2015 XING AG (http://xing.com/)

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.

xing-android-sdk's People

Contributors

ciprianu avatar david-varela avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.