Class Protocol

Protocol (POX)

Inheritance

object

ValidatableRecordBase

Protocol

Implements

IObjectValidatable

IValidatableObject

IEquatable<ValidatableRecordBase>

IEquatable<Protocol>

Inherited Members

ValidatableRecordBase.Validate(ValidationContext)

ValidatableRecordBase.ObjectValidatable(IObjectValidatable)

ValidatableRecordBase.ToString()

ValidatableRecordBase.PrintMembers(StringBuilder)

ValidatableRecordBase.GetHashCode()

ValidatableRecordBase.Equals(object)

ValidatableRecordBase.Equals(ValidatableRecordBase)

ValidatableRecordBase.<Clone>$()

ValidatableRecordBase.EqualityContract

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: wan24.AutoDiscover.Models

Assembly: wan24AutoDiscoverShared.dll

Syntax

public record Protocol : ValidatableRecordBase, IObjectValidatable, IValidatableObject, IEquatable<ValidatableRecordBase>, IEquatable<Protocol>

Remarks

Constructor

Constructors

Protocol()

Protocol (POX)

Declaration

public Protocol()

Remarks

Constructor

Fields

AUTHREQUIRED_NODE_NAME

AuthRequired node name

Declaration

protected const string AUTHREQUIRED_NODE_NAME = "AuthRequired"

Field Value

Type	Description
string

LOGINNAME_NODE_NAME

LoginName node name

Declaration

protected const string LOGINNAME_NODE_NAME = "LoginName"

Field Value

Type	Description
string

OFF

OFF

Declaration

protected const string OFF = "off"

Field Value

Type	Description
string

ON

ON

Declaration

protected const string ON = "on"

Field Value

Type	Description
string

PORT_NODE_NAME

Port node name

Declaration

protected const string PORT_NODE_NAME = "Port"

Field Value

Type	Description
string

PROTOCOL_NODE_NAME

Protocol node name

Declaration

protected const string PROTOCOL_NODE_NAME = "Protocol"

Field Value

Type	Description
string

SERVER_NODE_NAME

Server node name

Declaration

protected const string SERVER_NODE_NAME = "Server"

Field Value

Type	Description
string

SPA_NODE_NAME

SPA node name

Declaration

protected const string SPA_NODE_NAME = "SPA"

Field Value

Type	Description
string

SSL_NODE_NAME

SSL node name

Declaration

protected const string SSL_NODE_NAME = "SSL"

Field Value

Type	Description
string

TYPE_NODE_NAME

Type node name

Declaration

protected const string TYPE_NODE_NAME = "Type"

Field Value

Type	Description
string

Properties

AuthRequired

Authentication required

Declaration

public bool AuthRequired { get; init; }

Property Value

Type	Description
bool

LoginName

Login name getter delegate

Declaration

public static Protocol.LoginName_Delegate LoginName { get; set; }

Property Value

Type	Description
Protocol.LoginName_Delegate

LoginNameIsEmailAlias

If the login name is the alias of the email address

Declaration

public bool LoginNameIsEmailAlias { get; init; }

Property Value

Type	Description
bool

LoginNameMapping

Login name mapping (key is the email address or alias, value the mapped login name)

Declaration

[RequiredIf("LoginNameMappingRequired", new object?[] { true })]
public IReadOnlyDictionary<string, string>? LoginNameMapping { get; init; }

Property Value

Type	Description
IReadOnlyDictionary<string, string>

LoginNameMappingRequired

If a successful login name mapping is required (if no mapping was possible, the email address will be used as login name)

Declaration

public bool LoginNameMappingRequired { get; init; }

Property Value

Type	Description
bool

Port

Port

Declaration

[Range(1, 65535)]
public int Port { get; init; }

Property Value

Type	Description
int

SPA

Secure password authentication

Declaration

public bool SPA { get; init; }

Property Value

Type	Description
bool

SSL

SSL

Declaration

public bool SSL { get; init; }

Property Value

Type	Description
bool

Server

Server

Declaration

[Host]
public required string Server { get; init; }

Property Value

Type	Description
string

Type

Type

Declaration

[Required]
[StringLength(255, MinimumLength = 1)]
public required string Type { get; init; }

Property Value

Type	Description
string

Methods

CreateXml(XmlWriter, ReadOnlyMemory<string>, DomainConfig)

Create XML

Declaration

public virtual void CreateXml(XmlWriter xml, ReadOnlyMemory<string> emailParts, DomainConfig domain)

Parameters

Type	Name	Description
XmlWriter	xml	XML
ReadOnlyMemory<string>	emailParts	Splitted email parts
DomainConfig	domain	Domain

DefaultLoginName(ReadOnlyMemory<string>, DomainConfig, Protocol)

Default login name resolver

Declaration

public static string DefaultLoginName(ReadOnlyMemory<string> emailParts, DomainConfig domain, Protocol protocol)

Parameters

Type	Name	Description
ReadOnlyMemory<string>	emailParts	Splitted email parts
DomainConfig	domain	Domain
Protocol	protocol	Protocol

Returns

Type	Description
string	Login name

Implements

wan24.ObjectValidation.IObjectValidatable

IValidatableObject

IEquatable<T>

IEquatable<T>