# Network Interface

## Network Interface

#### Required Phonegap plugins

cordova-plugin-networkinterface

## API Documentation

### Method Summary

#### getWiFiIPAddress

Get WIFI IP Address

**Params**

| Type     | Name            | Summary             | Required |
| -------- | --------------- | ------------------- | -------- |
| Function | callbackSuccess | on success callback | Optional |
| Function | callbackError   | on error callback   | Optional |

#### getCarrierIPAddress

Get Carrier IP Address

**Params**

| Type     | Name            | Summary             | Required |
| -------- | --------------- | ------------------- | -------- |
| Function | callbackSuccess | on success callback | Optional |
| Function | callbackError   | on error callback   | Optional |

#### getHttpProxyInformation

gets the relevant proxies for the passed URL

**Params**

| Type     | Name            | Summary                                                | Required |
| -------- | --------------- | ------------------------------------------------------ | -------- |
| String   | url             | url example: "[www.github.com](http://www.github.com)" | Required |
| Function | callbackSuccess | on success callback                                    | Optional |
| Function | callbackError   | on error callback                                      | Optional |

## Example Usage

```javascript
plugins.svyphonegapNetworkinterface.getWiFiIPAddress(getWifiIP, error)

function getWifiIP(data) {
	application.output("WIFI IP ADDRESS: " + data.ip);
}

function error() {
	application.output("Failed to get WIFI IP Address");
}
```