Show / Hide Table of Contents

Class ClientConfiguration

Provides configuration options for the REST client used by the SDK. Used internally to store API key and other configuration.

Inheritance
System.Object
ClientConfiguration
Namespace: EasyPost
Assembly: EasyPost.dll
Syntax
public class ClientConfiguration : IDisposable

Constructors

| Improve this Doc View Source

ClientConfiguration(String)

Initializes a new instance of the ClientConfiguration class.

Declaration
public ClientConfiguration(string apiKey)
Parameters
Type Name Description
System.String apiKey

The API key to use for the client.

Properties

| Improve this Doc View Source

ApiBase

The API base URI.

Declaration
public string ApiBase { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

CustomHttpClient

A custom HttpClient to use for requests.

Declaration
public HttpClient? CustomHttpClient { get; set; }
Property Value
Type Description
System.Nullable<HttpClient>
| Improve this Doc View Source

Hooks

A set of Hooks to use for requests.

Declaration
public Hooks Hooks { get; set; }
Property Value
Type Description
Hooks
| Improve this Doc View Source

Timeout

The timeout to use for requests.

Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type Description
TimeSpan

Methods

| Improve this Doc View Source

Dispose()

Dispose of this object.

Declaration
public void Dispose()
| Improve this Doc View Source

Dispose(Boolean)

Dispose of this object.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Whether this object is being disposed.

| Improve this Doc View Source

Equals(Nullable<Object>)

Provides configuration options for the REST client used by the SDK. Used internally to store API key and other configuration.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
System.Nullable<System.Object> obj
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Finalize()

Finalizes an instance of the ClientConfiguration class.

Declaration
protected void Finalize()
| Improve this Doc View Source

GetHashCode()

Provides configuration options for the REST client used by the SDK. Used internally to store API key and other configuration.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX