Search Results for

    Show / Hide Table of Contents

    Class CommunicatorConfiguration

    Configuration for the communicator.

    Inheritance
    object
    CommunicatorConfiguration
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Worldline.Acquiring.Sdk
    Assembly: Worldline.Acquiring.Sdk.dll
    Syntax
    public class CommunicatorConfiguration

    Constructors

    CommunicatorConfiguration()

    Declaration
    public CommunicatorConfiguration()

    CommunicatorConfiguration(IDictionary<string, string>)

    Declaration
    public CommunicatorConfiguration(IDictionary<string, string> properties)
    Parameters
    Type Name Description
    IDictionary<string, string> properties

    Fields

    DefaultMaxConnections

    The default number of maximum connections

    Declaration
    public const int DefaultMaxConnections = 10
    Field Value
    Type Description
    int

    Properties

    ApiEndpoint

    Gets or sets the Worldline Acquiring platform API endpoint URI.

    Declaration
    public Uri ApiEndpoint { get; set; }
    Property Value
    Type Description
    Uri

    AuthorizationId

    Gets or sets an id used for authorization. The meaning of this id is different for each authorization type. For instance, for OAuth2 this is the client id.

    Declaration
    public string AuthorizationId { get; set; }
    Property Value
    Type Description
    string

    AuthorizationSecret

    Gets or sets a secret used for authorization. The meaning of this secret is different for each authorization type. For instance, for OAuth2 this is the client secret.

    Declaration
    public string AuthorizationSecret { get; set; }
    Property Value
    Type Description
    string

    AuthorizationType

    Gets or sets the type of the authorization.

    Declaration
    public AuthorizationType AuthorizationType { get; set; }
    Property Value
    Type Description
    AuthorizationType

    ConnectTimeout

    Gets or sets the connect timeout

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

    HttpClientHandler

    Gets or sets a custom HttpClientHandler to be used by DefaultConnection.

    Declaration
    public HttpClientHandler HttpClientHandler { get; set; }
    Property Value
    Type Description
    HttpClientHandler

    Integrator

    Gets or sets the integrator.

    Declaration
    public string Integrator { get; set; }
    Property Value
    Type Description
    string

    MaxConnections

    Gets or sets the maximal number of connections

    Declaration
    public int MaxConnections { get; set; }
    Property Value
    Type Description
    int

    OAuth2ClientId

    Gets or sets the OAuth2 client id.

    This property is an alias for AuthorizationId.

    Declaration
    public string OAuth2ClientId { get; set; }
    Property Value
    Type Description
    string

    OAuth2ClientSecret

    Gets or sets the OAuth2 client secret.

    This property is an alias for AuthorizationSecret.

    Declaration
    public string OAuth2ClientSecret { get; set; }
    Property Value
    Type Description
    string

    OAuth2Scopes

    Gets or sets the OAuth2 scopes. Leave empty to let the SDK provide a set of defaults.

    Declaration
    public string OAuth2Scopes { get; set; }
    Property Value
    Type Description
    string

    OAuth2TokenUri

    Gets or sets the OAuth2 token URI.

    Declaration
    public string OAuth2TokenUri { get; set; }
    Property Value
    Type Description
    string

    Proxy

    Gets the proxy object

    Declaration
    public Proxy Proxy { get; }
    Property Value
    Type Description
    Proxy

    ProxyPassword

    Gets or sets the proxy password.

    Declaration
    public string ProxyPassword { get; set; }
    Property Value
    Type Description
    string

    ProxyUri

    Gets or sets the proxy URI.

    Declaration
    public Uri ProxyUri { get; set; }
    Property Value
    Type Description
    Uri

    ProxyUserName

    Gets or sets the proxy username.

    Declaration
    public string ProxyUserName { get; set; }
    Property Value
    Type Description
    string

    ShoppingCartExtension

    Gets or sets the shoppingcart extension.

    Declaration
    public ShoppingCartExtension ShoppingCartExtension { get; set; }
    Property Value
    Type Description
    ShoppingCartExtension

    SocketTimeout

    Gets or sets the socket timeout

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

    Methods

    WithApiEndpoint(Uri)

    Returns this with the API endpoint assigned.

    Declaration
    public CommunicatorConfiguration WithApiEndpoint(Uri apiEndpoint)
    Parameters
    Type Name Description
    Uri apiEndpoint

    API endpoint.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithAuthorizationId(string)

    Returns this with the authorization id assigned.

    Declaration
    public CommunicatorConfiguration WithAuthorizationId(string authorizationId)
    Parameters
    Type Name Description
    string authorizationId

    The authorization id

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithAuthorizationSecret(string)

    Returns this with the authorization secret assigned.

    Declaration
    public CommunicatorConfiguration WithAuthorizationSecret(string authorizationSecret)
    Parameters
    Type Name Description
    string authorizationSecret

    The authorization secret

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithAuthorizationType(AuthorizationType)

    Returns this with the type of the authorization assigned.

    Declaration
    public CommunicatorConfiguration WithAuthorizationType(AuthorizationType authorizationType)
    Parameters
    Type Name Description
    AuthorizationType authorizationType

    Authorization type.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithConnectTimeout(int)

    Returns this with the the connect timeout assigned.

    Declaration
    public CommunicatorConfiguration WithConnectTimeout(int connectTimeout)
    Parameters
    Type Name Description
    int connectTimeout

    The connect timeout.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithHttpClientHandler(HttpClientHandler)

    Returns this with a custom HttpClientHandler assigned.

    Declaration
    public CommunicatorConfiguration WithHttpClientHandler(HttpClientHandler httpClientHandler)
    Parameters
    Type Name Description
    HttpClientHandler httpClientHandler

    The custom HttpClientHandler.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithIntegrator(string)

    Returns this with the integrator assigned.

    Declaration
    public CommunicatorConfiguration WithIntegrator(string integrator)
    Parameters
    Type Name Description
    string integrator

    The integrator.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithMaxConnections(int)

    Returns this with the maximum number of connections assigned.

    Declaration
    public CommunicatorConfiguration WithMaxConnections(int maxConnections)
    Parameters
    Type Name Description
    int maxConnections

    The maximum number of connections.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithOAuth2ClientId(string)

    Returns this with the OAuth2 client id assigned.

    Declaration
    public CommunicatorConfiguration WithOAuth2ClientId(string oauth2ClientId)
    Parameters
    Type Name Description
    string oauth2ClientId

    The OAuth2 client id

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithOAuth2ClientSecret(string)

    Returns this with the OAuth2 client secret assigned.

    Declaration
    public CommunicatorConfiguration WithOAuth2ClientSecret(string oauth2ClientSecret)
    Parameters
    Type Name Description
    string oauth2ClientSecret

    The OAuth2 client secret

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithOAuth2Scopes(string)

    Returns this with the OAuth2 scopes assigned.

    Declaration
    public CommunicatorConfiguration WithOAuth2Scopes(string oauth2Scopes)
    Parameters
    Type Name Description
    string oauth2Scopes

    The OAuth2 scopes

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithOAuth2TokenUri(string)

    Returns this with the OAuth2 token URI assigned.

    Declaration
    public CommunicatorConfiguration WithOAuth2TokenUri(string oauth2TokenUri)
    Parameters
    Type Name Description
    string oauth2TokenUri

    The OAuth2 token URI

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithProxyPassword(string)

    Returns this with the proxy password assigned.

    Declaration
    public CommunicatorConfiguration WithProxyPassword(string proxyPassword)
    Parameters
    Type Name Description
    string proxyPassword

    The proxy password.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithProxyUri(Uri)

    Returns this with the proxy URI assigned.

    Declaration
    public CommunicatorConfiguration WithProxyUri(Uri proxyUri)
    Parameters
    Type Name Description
    Uri proxyUri

    The proxy URI.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithProxyUserName(string)

    Returns this with the proxy username assigned.

    Declaration
    public CommunicatorConfiguration WithProxyUserName(string proxyName)
    Parameters
    Type Name Description
    string proxyName

    The proxy username.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithShoppingCartExtension(ShoppingCartExtension)

    Returns this with the shopping cart extension assigned.

    Declaration
    public CommunicatorConfiguration WithShoppingCartExtension(ShoppingCartExtension shoppingCartExtension)
    Parameters
    Type Name Description
    ShoppingCartExtension shoppingCartExtension

    The shopping cart extension.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    WithSocketTimeout(int)

    Returns this with the the socket timeout assigned.

    Declaration
    public CommunicatorConfiguration WithSocketTimeout(int socketTimeout)
    Parameters
    Type Name Description
    int socketTimeout

    The socket timeout.

    Returns
    Type Description
    CommunicatorConfiguration

    This.

    In This Article
    Back to top Copyright (c) 2024 Worldline Financial Services (Europe) SA