NexmoClient.Builder (NexmoClient 4.1.3)

java.lang.Object
- com.nexmo.client.NexmoClient.NexmoClientConfig
- - com.nexmo.client.NexmoClient.Builder

Enclosing class:: NexmoClient

public static class NexmoClient.Builder
extends NexmoClient.NexmoClientConfig

Builds new NexmoClient.

Build NexmoClient using minimal setup:

 NexmoClient client = new NexmoClient.Builder().build(context);

Build NexmoClient with all settings:

  NexmoClient client = new NexmoClient.Builder()
      .restEnvironmentHost(restEndpoint)
      .environmentHost(endpoint)
      .endpointPath(endpointPath)
      .imageProcessingServiceUrl(ips)
      .logLevel(eLogLevel.NONE)
      .logKey(100)
      .statsInterval(1000)
      .iceServerUrls([urls])
      .useFirstIceCandidate([urls])
      .build(context);

After construction the NexmoClient instance ca be retrieved:

 NexmoClient.get();

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NexmoClient.Builder`	`autoMediaReoffer(boolean autoMediaReoffer)` Sets the boolean value to decide whatever or not to use auto media reoffer for network connection changes.
`NexmoClient`	`build(android.content.Context context)` Initializes `and return the instance`
`NexmoClient.Builder`	`endpointPath(java.lang.String endpointPath)` Sets Nexmo Conversation Websocket URL path suffix.
`NexmoClient.Builder`	`environmentHost(java.lang.String environmentHost)` Sets environment host URL.
`NexmoClient.Builder`	`environmentHostPinning(NexmoPinningConfig pin)` Sets HTTPS pin chain for ws environment Endpoint.
`NexmoClient.Builder`	`iceServerUrls(java.lang.String[] iceServerUrls)` Sets the default iceServers for RTCPeerConnection.
`NexmoClient.Builder`	`imageProcessingServiceUrl(java.lang.String imageProcessingServiceUrl)` Sets Nexmo IPS URL for image upload URL.
`NexmoClient.Builder`	`logKey(long logKey)` Sets log key.
`NexmoClient.Builder`	`logLevel(ILogger.eLogLevel logLevel)` Sets log level.
`NexmoClient.Builder`	`pushNotificationTTL(int pushNotificationTTL)` Sets TTL value in seconds for push notification for the specific device.
`NexmoClient.Builder`	`restEnvironmentHost(java.lang.String restEnvironmentHost)` Sets rest environment host URL.
`NexmoClient.Builder`	`restEnvironmentHostPinning(NexmoPinningConfig pin)` Sets HTTPS pin chain for Rest Environment Endpoint.
`NexmoClient.Builder`	`useFirstIceCandidate(boolean useFirstIceCandidate)` Sets the Boolean value to decide whatever or not to use first ice server for RTCPeerConnection.

Methods inherited from class com.nexmo.client.NexmoClient.NexmoClientConfig
getEndpointPath, getEnvironmentHost, getIceServerUrls, getImageProcessingServiceUrl, getLogKey, getLogLevel, getPushNotificationTTL, getRestEnvironmentHost, getRestEnvironmentHostPKHash, getStatsInterval, getWsHostPKHash, getWsRandomizationFactor, getWsReconnectionDelay, getWsReconnectionDelayMax, getWsTimeout, isAutoMediaReoffer, isUseFirstIceCandidate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public NexmoClient build(android.content.Context context)
```
    Initializes and return the instance
    
    Parameters:
    
    context - The Android Application context.
    
    Returns:
    
    NexmoClient.Builder
  - restEnvironmentHost
```
public NexmoClient.Builder restEnvironmentHost(java.lang.String restEnvironmentHost)
```
    Sets rest environment host URL. The default value is "https://api.nexmo.com/".
    
    Parameters:
    
    restEnvironmentHost - rest environment host URL.
    
    Returns:
    
    NexmoClient.Builder
  - restEnvironmentHostPinning
```
public NexmoClient.Builder restEnvironmentHostPinning(NexmoPinningConfig pin)
```
    Sets HTTPS pin chain for Rest Environment Endpoint. The default is no Pin and to use standard CA Trust model.
    
    Parameters:
    
    pin - NexmoPinningConfig
    
    Returns:
    
    NexmoClient.Builder
  - environmentHost
```
public NexmoClient.Builder environmentHost(java.lang.String environmentHost)
```
    Sets environment host URL. The default value is "https://ws.nexmo.com".
    
    Parameters:
    
    environmentHost - environment host URL.
    
    Returns:
    
    NexmoClient.Builder
  - environmentHostPinning
```
public NexmoClient.Builder environmentHostPinning(NexmoPinningConfig pin)
```
    Sets HTTPS pin chain for ws environment Endpoint. The default is no Pin and to use standard CA Trust model.
    
    Parameters:
    
    pin - NexmoPinningConfig
    
    Returns:
    
    NexmoClient.Builder
  - pushNotificationTTL
```
public NexmoClient.Builder pushNotificationTTL(int pushNotificationTTL)
```
    Sets TTL value in seconds for push notification for the specific device. TTL ranges from 0 to 300.
    
    Parameters:
    
    pushNotificationTTL - TTL for push notifications in seconds.
    
    Returns:
    
    NexmoClient.Builder
  - imageProcessingServiceUrl
```
public NexmoClient.Builder imageProcessingServiceUrl(java.lang.String imageProcessingServiceUrl)
```
    Sets Nexmo IPS URL for image upload URL. The default value is "https://api.nexmo.com/v1/image".
    
    Parameters:
    
    imageProcessingServiceUrl - image processing service URL.
    
    Returns:
    
    NexmoClient.Builder
  - endpointPath
```
public NexmoClient.Builder endpointPath(java.lang.String endpointPath)
```
    Sets Nexmo Conversation Websocket URL path suffix. The default value is "/rtc/".
    
    Parameters:
    
    endpointPath - Websocket URL path suffix.
    
    Returns:
    
    NexmoClient.Builder
  - logLevel
```
public NexmoClient.Builder logLevel(ILogger.eLogLevel logLevel)
```
    Sets log level. The default value is ILogger.eLogLevel#NONE.
    
    Parameters:
    
    logLevel - log level.
    
    Returns:
    
    NexmoClient.Builder
  - logKey
```
public NexmoClient.Builder logKey(long logKey)
```
    Sets log key. The default value is 0.
    
    Parameters:
    
    logKey - log key.
    
    Returns:
    
    NexmoClient.Builder
  - iceServerUrls
```
public NexmoClient.Builder iceServerUrls(java.lang.String[] iceServerUrls)
```
    Sets the default iceServers for RTCPeerConnection.
    
    Parameters:
    
    iceServerUrls - ice servers URLs.
    
    Returns:
    
    NexmoClient.Builder
  - useFirstIceCandidate
```
public NexmoClient.Builder useFirstIceCandidate(boolean useFirstIceCandidate)
```
    Sets the Boolean value to decide whatever or not to use first ice server for RTCPeerConnection. The default value is false.
    
    Parameters:
    
    useFirstIceCandidate - whatever or not to use first ice server for RTCPeerConnection.
    
    Returns:
    
    NexmoClient.Builder
  - autoMediaReoffer
```
public NexmoClient.Builder autoMediaReoffer(boolean autoMediaReoffer)
```
    Sets the boolean value to decide whatever or not to use auto media reoffer for network connection changes. The default value is false.
    
    Parameters:
    
    autoMediaReoffer - whatever or not to auto reoffer.
    
    Returns:
    
    NexmoClient.Builder

Class NexmoClient.Builder

Constructor Summary

Method Summary

Methods inherited from class com.nexmo.client.NexmoClient.NexmoClientConfig

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

restEnvironmentHost

restEnvironmentHostPinning

environmentHost

environmentHostPinning

pushNotificationTTL

imageProcessingServiceUrl

endpointPath

logLevel

logKey

iceServerUrls

useFirstIceCandidate

autoMediaReoffer