Class ZipClientConfiguration

Provides details to a ZipClient instance about how to access the Zip API.

Inheritance

Object

ZipClientConfiguration

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Yort.Zip.InStore

Assembly: Yort.Zip.InStore.dll

Syntax

public class ZipClientConfiguration

Constructors

ZipClientConfiguration(String, String, ZipEnvironment)

Full constructor.

Declaration

public ZipClientConfiguration(string clientId, string clientSecret, ZipEnvironment environment)

Parameters

Type	Name	Description
String	clientId	The client id used to request new authentication tokens. Can be null if you plan to retrieve it using the EnrolAsync(EnrolRequest) mechanism.
String	clientSecret	The client secret used to request new authentication tokens. Can be null if you plan to retrieve it using the EnrolAsync(EnrolRequest) mechanism.
ZipEnvironment	environment	The environment indicating the API instance to access. Required.

Properties

ClientId

Returns the client id value provided via the constructor.

Declaration

public string ClientId { get; }

Property Value

Type	Description
String

ClientSecret

Returns the client secret value provided via the constructor.

Declaration

public string ClientSecret { get; }

Property Value

Type	Description
String

DefaultOperator

Provides the default (POS) operator value to be sent on requests (that require an operator value) if the request value is not already set (null).

Declaration

public string DefaultOperator { get; set; }

Property Value

Type	Description
String

DefaultStoreId

Provides the default store id to be sent on requests (that require a store id) if the request value is not already set (null).

Declaration

public string DefaultStoreId { get; set; }

Property Value

Type	Description
String

DefaultTerminalId

Provides the default terminal id to be sent on requests (that require a terminal id) if the request value is not already set (null).

Declaration

public string DefaultTerminalId { get; set; }

Property Value

Type	Description
String

Environment

Returns the ZipEnvironment value provided via the constructor.

Declaration

public ZipEnvironment Environment { get; }

Property Value

Type	Description
ZipEnvironment