Vonage Client Library

A library to support using the Vonage APIs on Android. Features:

• Force a cellular network request for use with Vonage Number Verification and Vonage Verify Silent Authentication

Installation

build.gradle -> dependencies add

implementation 'com.vonage:client-library:1.0.0'

Usage

Force a Cellular Network Request

import com.vonage.clientlibrary.VGCellularRequestClient
import com.vonage.clientlibrary.VGCellularRequestParameters

VGCellularRequestClient.initializeSdk(this.applicationContext)

val params = VGCellularRequestClientParameters(
    url = "http://www.vonage.com",
    headers = mapOf("x-my-header" to "My Value") ,
    queryParameters = mapOf("query-param" to "value"),
    maxRedirectCount = 10
)

val response = VGCellularRequestClient.getInstance().startCellularGetRequest(params, false)
if (response.optString("error") != "") {
    // error
} else {
    val status = response.optInt("http_status")
    val jsonReponse = response.getJSONObject("response_body") // Body of response parsed to JSON (NULL if not JSON)
    val rawReponse = response.optString("response_raw_body") // RAW string of response body (Only populated if not JSON)
    if (status == 200) {
        // 200 OK
    } else {
        // error
    }
}

• maxRedirectCount in VGCellularRequestParameters is an optional and defaults to 10.
• debug parameter for startCellularRequest is optional and defaults to false.

Responses

• Success - When the data connectivity has been achieved, and a response has been received from the url endpoint:

{
    "http_status": string, // HTTP status related to the url
    "response_body" : { // Optional depending on the HTTP status
        ... // The response body of the opened url
    },
    "debug" : {
        "device_info": string, 
        "url_trace" : string
    }
}

• Error - When data connectivity is not available and/or an internal SDK error occurred:

{
    "error" : string,
    "error_description": string,
    "debug" : {
        "device_info": string, 
        "url_trace" : string
    }
}

Potential error codes: sdk_no_data_connectivity, sdk_connection_error, sdk_redirect_error, sdk_error.