Class Configuration

Namespace

Vonage

Assembly

Vonage.dll

Represents the SDK Configuration.

public sealed class Configuration

Inheritance

object

Configuration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApiKey

Retrieves the Api secret.

public string ApiKey { get; }

Property Value

string

ApiSecret

Retrieves the Api secret.

public string ApiSecret { get; }

Property Value

string

ApplicationId

Retrieves the Application Id.

public string ApplicationId { get; }

Property Value

string

ApplicationKey

Retrieves the Application Key.

public string ApplicationKey { get; }

Property Value

string

Client

Retrieves a configured HttpClient.

public HttpClient Client { get; }

Property Value

HttpClient

ClientHandler

Exposes an HttpMessageHandler.

public HttpMessageHandler ClientHandler { get; set; }

Property Value

HttpMessageHandler

Instance

Retrieves the unique instance (Singleton).

public static Configuration Instance { get; }

Property Value

Configuration

Proxy

Retrieves the proxy URL applied to the default HttpMessageHandler, sourced from the vonage:Proxy setting. Returns None when no proxy is configured.

public Maybe<string> Proxy { get; }

Property Value

Maybe<string>

RequestTimeout

The timeout (in seconds) applied to every request. If not provided, the default timeout will be applied.

public Maybe<TimeSpan> RequestTimeout { get; }

Property Value

Maybe<TimeSpan>

SecuritySecret

Retrieves the Security Secret.

public string SecuritySecret { get; }

Property Value

string

Settings

Exposes the configuration's content.

public IConfiguration Settings { get; }

Property Value

IConfiguration

SigningMethod

Retrieves the SigningMethod.

public string SigningMethod { get; }

Property Value

string

UserAgent

Retrieves the User Agent.

public string UserAgent { get; }

Property Value

string

VonageUrls

Provide urls to all Vonage APIs.

public VonageUrls VonageUrls { get; }

Property Value

VonageUrls

Methods

BuildCredentials()

Builds a Credentials from the current Configuration.

public Credentials BuildCredentials()

Returns

Credentials

The Credentials.

BuildHttpClientForNexmo()

Build an HttpClient for the Nexmo API.

public HttpClient BuildHttpClientForNexmo()

Returns

HttpClient

The HttpClient.

BuildHttpClientForOidc()

Build an HttpClient for OIDC requests.

public HttpClient BuildHttpClientForOidc()

Returns

HttpClient

The HttpClient.

BuildHttpClientForRegion(Region)

Build an HttpClient for a specific region.

public HttpClient BuildHttpClientForRegion(VonageUrls.Region region)

Parameters

region VonageUrls.Region

The selected region.

Returns

HttpClient

The HttpClient.

BuildHttpClientForVideo()

Build an HttpClient for the Video API.

public HttpClient BuildHttpClientForVideo()

Returns

HttpClient

The HttpClient.

FromConfiguration(IConfiguration)

Builds a Configuration from an IConfiguration.

public static Configuration FromConfiguration(IConfiguration configuration)

Parameters

configuration IConfiguration

The configuration properties.

Returns

Configuration

The Configuration.