com.kakao.network

Interface NetworkService

public interface NetworkService

Network interface for all other modules throughout the SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NetworkService.Factory Factory class for getting instances of NetworkService implementations.

Method Summary

Modifier and Type	Method and Description
<T> T	request(IRequest request, com.kakao.network.response.ResponseStringConverter<T> converter) Sends a network request synchronously.
<T,E extends Exception> T	request(IRequest request, com.kakao.network.response.ResponseStringConverter<T> converter, com.kakao.network.response.CustomErrorConverter<E> errorConverter) Sends a network request with custom error converter.
<T,E extends Exception> Future<T>	request(IRequest request, com.kakao.network.response.ResponseStringConverter<T> converter, com.kakao.network.response.CustomErrorConverter<E> errorConverter, ResponseCallback<T> callback) Sends a network request asynchronously with custom error converter.
<T> Future<T>	request(IRequest request, com.kakao.network.response.ResponseStringConverter<T> converter, ResponseCallback<T> callback) Sends a network request asynchronously.
<T> List<T>	requestList(IRequest request, com.kakao.network.response.ResponseStringConverter<T> converter) Sends a network request that expects an array response.
<T> Future<List<T>>	requestList(IRequest request, com.kakao.network.response.ResponseStringConverter<T> converter, ResponseCallback<List<T>> callback) Asynchronous version of requestList(IRequest, ResponseStringConverter).

Method Detail

request

<T> T request(IRequest request,
              com.kakao.network.response.ResponseStringConverter<T> converter)
       throws IOException,
              com.kakao.network.response.ResponseBody.ResponseBodyException,
              com.kakao.network.response.ApiResponseStatusError

Sends a network request synchronously. This should be called only on non-UI thread.

Type Parameters:

T - Response Type

Parameters:

request - IRequest object that represents API requests

converter - String converter for Response Type T

Returns:

Response object of type T

Throws:

IOException - when network fails

ResponseBody.ResponseBodyException - when there is an error in the response body

com.kakao.network.response.ApiResponseStatusError - when an error is returned from the API server

request

<T,E extends Exception> T request(IRequest request,
                                  com.kakao.network.response.ResponseStringConverter<T> converter,
                                  com.kakao.network.response.CustomErrorConverter<E> errorConverter)
                           throws IOException,
                                  com.kakao.network.response.ResponseBody.ResponseBodyException,
                                  E extends Exception

Sends a network request with custom error converter. Servers might have different error formats. For example, Kakao API server and OAuth server have different error formats. Each module should know the custom error format and provide CustomErrorConverter isntance if necessary.

Type Parameters:

T - Response Type

E - Custom Error type

Parameters:

request - IRequest object that represents API requests

converter - String converter for Response Type T

errorConverter - ResponseBody Converter for Custom Error Type E

Returns:

Response of type T

Throws:

IOException

com.kakao.network.response.ResponseBody.ResponseBodyException

E extends Exception

request

<T,E extends Exception> Future<T> request(IRequest request,
                                          com.kakao.network.response.ResponseStringConverter<T> converter,
                                          com.kakao.network.response.CustomErrorConverter<E> errorConverter,
                                          ResponseCallback<T> callback)

Sends a network request asynchronously with custom error converter. See request(IRequest, ResponseStringConverter, CustomErrorConverter) for further detail.

Type Parameters:

T - Response Type

E - Custom Error type

Parameters:

request - IRequest object that represents API requests

converter - String converter for Response Type T

errorConverter - ResponseBody Converter for Custom Error Type E

callback - ResponseCallback object that will handle either success/failure of API requests

Returns:

Future containing T

request

<T> Future<T> request(IRequest request,
                      com.kakao.network.response.ResponseStringConverter<T> converter,
                      ResponseCallback<T> callback)

Sends a network request asynchronously. All exceptions are caught and passed to callback.

Type Parameters:

T - Response Type

Parameters:

request - IRequest object that represents API requests

converter - Converter object that will convert ResponseBody into a give Generic type.

callback - Callback that will handle either success/failure of API requests

Returns:

Future containing the desired API response

requestList

<T> List<T> requestList(IRequest request,
                        com.kakao.network.response.ResponseStringConverter<T> converter)
                 throws IOException

Sends a network request that expects an array response.

Type Parameters:

T - Response Type

Parameters:

request - IRequest object that represents API requests

converter - String converter for Response Type T

Returns:

Desired API response as List

Throws:

IOException - when network fails

requestList

<T> Future<List<T>> requestList(IRequest request,
                                com.kakao.network.response.ResponseStringConverter<T> converter,
                                ResponseCallback<List<T>> callback)

Asynchronous version of requestList(IRequest, ResponseStringConverter).

Type Parameters:

T - Response Type

Parameters:

request - IRequest object that represents API requests

converter - String converter for Response Type T

callback - ResponseCallback object that will handle either success/failure of API requests

Returns:

Future containing the desired API response