HTTP

Improve this doc

Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android.

Advantages over Javascript requests:

• Background threading - all requests are done in a background thread
• SSL Pinning

Repo: https://github.com/silkimen/cordova-plugin-advanced-http

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-advanced-http
   $ npm install --save @ionic-native/http
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS

Usage

import { HTTP } from '@ionic-native/http';

constructor(private http: HTTP) {}

...

this.http.get('http://ionic.io', {}, {})
  .then(data => {

    console.log(data.status);
    console.log(data.data); // data received by server
    console.log(data.headers);

  })
  .catch(error => {

    console.log(error.status);
    console.log(error.error); // error message as string
    console.log(error.headers);

  });

Instance Members

getBasicAuthHeader(username, password)

This returns an object representing a basic HTTP Authorization header of the form.

useBasicAuth(username, password)

This sets up all future requests to use Basic HTTP authentication with the given username and password.

getHeaders(host)

Get all headers defined for a given hostname.

setHeader(host, header, value)

Set a header for all future requests. Takes a hostname, a header and a value.

getDataSerializer()

Get the name of the data serializer which will be used for all future POST and PUT requests.

setDataSerializer(serializer)

Set the data serializer which will be used for all future POST and PUT requests. Takes a string representing the name of the serializer.

setCookie(url, cookie)

Add a custom cookie.

clearCookies()

Clear all cookies.

removeCookies(url, cb)

Remove cookies for given URL.

getCookieString(url)

Resolve cookie string for given URL.

getRequestTimeout()

Get global request timeout value in seconds.

setRequestTimeout(timeout)

Set global request timeout value in seconds.

enableSSLPinning(enable)

Enable or disable SSL Pinning. This defaults to false.

To use SSL pinning you must include at least one .cer SSL certificate in your app project. You can pin to your server certificate or to one of the issuing CA certificates. For ios include your certificate in the root level of your bundle (just add the .cer file to your project/target at the root level). For android include your certificate in your project’s platforms/android/assets folder. In both cases all .cer files found will be loaded automatically. If you only have a .pem certificate see this stackoverflow answer. You want to convert it to a DER encoded certificate with a .cer extension.

As an alternative, you can store your .cer files in the www/certificates folder.

acceptAllCerts(accept)

Accept all SSL certificates. Or disabled accepting all certificates. Defaults to false.

disableRedirect(disable)

Disable following redirects automatically.

post(url, body, headers)

Make a POST request

get(url, parameters, headers)

Make a GET request

put(url, body, headers)

Make a PUT request

patch(url, body, headers)

Make a PATCH request

delete(url, parameters, headers)

Make a DELETE request

head(url, parameters, headers)

Make a HEAD request

uploadFile(url, body, headers, filePath, name)

downloadFile(url, body, headers, filePath)

HTTPResponse