Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alirezaafkar/JsonRequester
An Android library for sending fast and clean json request, using volley
https://github.com/alirezaafkar/JsonRequester
Last synced: 8 days ago
JSON representation
An Android library for sending fast and clean json request, using volley
- Host: GitHub
- URL: https://github.com/alirezaafkar/JsonRequester
- Owner: alirezaafkar
- Created: 2015-12-12T11:25:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-08T08:48:52.000Z (about 7 years ago)
- Last Synced: 2024-07-24T05:44:58.093Z (4 months ago)
- Language: Java
- Homepage:
- Size: 181 KB
- Stars: 28
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-android - JsonRequester - An Android library for sending fast and clean json request, using volley. (Uncategorized / Uncategorized)
README
# JsonRequester
An Android library for sending fast and clean JSON request, using Volley
##Getting started
### Dependency
```
dependencies {
compile 'com.android.volley:volley:1.0.0'
compile 'com.alirezaafkar:json-requester:1.1.4'
}
```
### Usage
Initialize `Requester` in your `Application` class in the `onCreate()` method.
```java
@Override
public void onCreate() {
super.onCreate();
Map header = new HashMap<>();
header.put("charset", "utf-8");
String baseUrl = "http://example.com/api/";
new Requester.Config(getApplicationContext()).baseUrl(baseUrl).header(header);
}
```
### Create a requester
```java
JsonObjectRequester mRequester;
mRequester = new RequestBuilder(this)
.requestCode(REQUEST_CODE)
.contentType(ContentType.TYPE_JSON) //or ContentType.TYPE_FORM
.showError(true) //Show error with toast on Network or Server error
.shouldCache(true)
.priority(Request.Priority.NORMAL)
.allowNullResponse(true)
.tag(REQUEST_TAG)
.addToHeader("token", user_token)
.buildObjectRequester(listener); //or .buildArrayRequester(listener);
```
### Create a listener
```java
private class JsonObjectListener extends Response.SimpleObjectResponse {
@Override
public void onResponse(int requestCode, @Nullable JSONObject jsonObject) {
//Ok
}
@Override
public void onErrorResponse(int requestCode, VolleyError volleyError, @Nullable JSONObject errorObject) {
//Error (Not server or network error)
}
@Override
public void onFinishResponse(int requestCode, VolleyError volleyError, String message) {
//Network or Server error
}
@Override
public void onRequestStart(int requestCode) {
//Show loading or disable button
}
@Override
public void onRequestFinish(int requestCode) {
//Hide loading or enable button
}
}
```
### Request
```java
mRequester.request(Methods.GET, url);
mRequester.request(Methods.POST, url, body); // application/x-www-form-urlencoded
mRequester.request(Methods.POST, url, json); // application/json
```
### Callbacks
Set callback to null on destroy
### Activity
```java
@Override
protected void onDestroy() {
super.onDestroy();
if (isFinishing()) {
mRequester.setCallback(null);
}
}
```
### Fragment
```java
@Override
public void onDetach() {
super.onDetach();
if (isRemoving() || getActivity().isFinishing()) {
mRequester.setCallback(null);
}
}
```
### Nested Fragment
```java
if (getParentFragment().isRemoving() ||
isRemoving() || getActivity().isFinishing()) {
mRequester.setCallback(null);
}
```
###Override strings
```xml
Parsing error
Server error
Check your connection
No Connection
Timeout error
```
#Licence
Copyright 2015 Alireza Afkar
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.