Interface IReadableConfiguration
Represents a readable-only configuration contract.
Namespace: mailslurp.Client
Assembly: mailslurp.dll
Syntax
public interface IReadableConfiguration
Properties
View SourceAccessToken
Gets the access token.
Declaration
string AccessToken { get; }
Property Value
Type | Description |
---|---|
string | Access token. |
ApiKey
Gets the API key.
Declaration
IDictionary<string, string> ApiKey { get; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> | API key. |
ApiKeyPrefix
Gets the API key prefix.
Declaration
IDictionary<string, string> ApiKeyPrefix { get; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> | API key prefix. |
BasePath
Gets the base path.
Declaration
string BasePath { get; }
Property Value
Type | Description |
---|---|
string | Base path. |
ClientCertificates
Gets certificate collection to be sent with requests.
Declaration
X509CertificateCollection ClientCertificates { get; }
Property Value
Type | Description |
---|---|
X509CertificateCollection | X509 Certificate collection. |
DateTimeFormat
Gets the date time format.
Declaration
string DateTimeFormat { get; }
Property Value
Type | Description |
---|---|
string | Date time format. |
DefaultHeader
Gets the default header.
Declaration
[Obsolete("Use DefaultHeaders instead.")]
IDictionary<string, string> DefaultHeader { get; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> | Default header. |
DefaultHeaders
Gets the default headers.
Declaration
IDictionary<string, string> DefaultHeaders { get; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> | Default headers. |
OperationServers
Get the servers associated with the operation.
Declaration
IReadOnlyDictionary<string, List<IReadOnlyDictionary<string, object>>> OperationServers { get; }
Property Value
Type | Description |
---|---|
IReadOnlyDictionary<string, System.Collections.Generic.List<T><IReadOnlyDictionary<string, object>>> | Operation servers. |
Password
Gets the password.
Declaration
string Password { get; }
Property Value
Type | Description |
---|---|
string | Password. |
Proxy
Gets the proxy.
Declaration
WebProxy Proxy { get; }
Property Value
Type | Description |
---|---|
System.Net.WebProxy | Proxy. |
TempFolderPath
Gets the temp folder path.
Declaration
string TempFolderPath { get; }
Property Value
Type | Description |
---|---|
string | Temp folder path. |
Timeout
Gets the HTTP connection timeout (in milliseconds)
Declaration
int Timeout { get; }
Property Value
Type | Description |
---|---|
int | HTTP connection timeout. |
UserAgent
Gets the user agent.
Declaration
string UserAgent { get; }
Property Value
Type | Description |
---|---|
string | User agent. |
Username
Gets the username.
Declaration
string Username { get; }
Property Value
Type | Description |
---|---|
string | Username. |
Methods
View SourceGetApiKeyWithPrefix(string)
Gets the API key with prefix.
Declaration
string GetApiKeyWithPrefix(string apiKeyIdentifier)
Parameters
Type | Name | Description |
---|---|---|
string | apiKeyIdentifier | API key identifier (authentication scheme). |
Returns
Type | Description |
---|---|
string | API key with prefix. |
GetOperationServerUrl(string, int)
Gets the Operation server url at the provided index.
Declaration
string GetOperationServerUrl(string operation, int index)
Parameters
Type | Name | Description |
---|---|---|
string | operation | Operation server name. |
int | index | Index of the operation server settings. |
Returns
Type | Description |
---|---|
string |