Contains information about a legal identity application, including its current state. More...

Inheritance diagram for Paiwise.IdentityApplicationState:

Public Member Functions
	IdentityApplicationState (IdentityApplication Application, IdentityState State)
	Contains information about a legal identity application, including its current state. More...

void	ClaimValid (string Claim, object Service)
	An identity authenticator service validates a claim. More...

void	ClaimInvalid (string Claim, string Reason, string ReasonLanguage, string ReasonCode, object Service)
	An identity authenticator service invalidates a claim. More...

void	PhotoValid (IPhoto Photo, object Service)
	An identity authenticator service validates a photo. More...

void	PhotoInvalid (IPhoto Photo, string Reason, string ReasonLanguage, string ReasonCode, object Service)
	An identity authenticator service invalidates a photo. More...

void	ReportError (string Error, string ErrorLanguage, string ErrorCode, ValidationErrorType ErrorType, object Service, params KeyValuePair< string, object >[] Tags)
	Reports an error encountered during validation. More...

void	LogResults ()
	Logs the results of the validation process to the event log. More...

string	GetClientErrorMessageXml (out string Language, string DefaultMessage, string DefaultMessageCode, string DefaultLanguage)
	Gets the XML of the client error message. More...

string	GetIdentityReviewXml ()
	Gets information about the review as XML. More...

void	ValidateAllClaims ()
	Validates all claims. More...

void	ValidateAllPhotos ()
	Validates all photos More...

void	InvalidateAllClaims (string Reason, string ReasonLanguage, string ReasonCode)
	Invalidates all claims. More...

void	InvalidateAllPhotos (string Reason, string ReasonLanguage, string ReasonCode)
	Invalidates all photos More...

bool	TryGetValue< T > (string Claim, object Value, object Service, out T TypedValue)
	Tries to get a typed claim value from an untyped claim value. More...

void	AddPotentialClaims (string Claim, object Value, bool InformUser, object Service)
	Adds potential claims to the application that can be used in a subsequent applcation. Can be used by preview applications to suggest claims that could be added to the application automatically, to simplify user experience. More...

Properties
IdentityState	State `[get]`
	Current state of the legal identity application. More...

bool	Preview `[get]`
	If the application is a preview of an application. Previewed applications should not be persisted. More...

IAccount	Account `[get]`
	Account over which the application was made. More...

PersonalInformation	PersonalInformation `[get]`
	Personal information extracted from Claims. More...

KeyValuePair< string, object >[]	Claims `[get]`
	Full set of claims made regarding the identity, as meta-data tags. More...

IEnumerable< IPhoto >	Photos `[get]`
	Photos provided. More...

int	NrPhotos `[get]`
	Number of photos provided. More...

IEnumerable< XmlDocument >	Documents `[get]`
	Associated XML document attachments provided. More...

ValidClaim[]	ValidatedClaims `[get]`
	Validated claims. More...

InvalidClaim[]	InvalidatedClaims `[get]`
	Invalidated claims. More...

string[]	UnvalidatedClaims `[get]`
	Unvalidated claims. More...

ValidPhoto[]	ValidatedPhotos `[get]`
	Validated photos. More...

InvalidPhoto[]	InvalidatedPhotos `[get]`
	Invalidated photos. More...

IPhoto[]	UnvalidatedPhotos `[get]`
	Unvalidated photos. More...

PotentialClaim[]	PotentialClaims `[get]`
	Potential claims More...

ValidationError[]	Errors `[get]`
	Any errors reported during validation. More...

bool	HasErrors `[get]`
	If errors are reported. More...

int	NrErrors `[get]`
	Number of errors reported. More...

object[]	Services `[get]`
	Services involved in returning feedback on the application. More...

bool	HasServices `[get]`
	If services have returned feedback on the application. More...

int	NrServices `[get]`
	Number of services returning feedback on the the application. More...

bool?	IsValid `[get]`
	If the application has been validated (true), invalidated (false), or not yet validated (null). More...

bool	HasValidatedClaims `[get]`
	If the application has validated claims. More...

bool	HasValidatedPhotos `[get]`
	If the application has validated photos. More...

bool	HasPotentialClaims `[get]`
	If the application has potential claims. More...

KeyValuePair< string, object >[]	Tags `[get]`
	Tags annotating the application, as reported by the different services. More...

IValidationError	FirstError `[get]`
	First error encountered during validation. More...

Detailed Description

Contains information about a legal identity application, including its current state.

Definition at line 9 of file IdentityApplicationState.cs.

Constructor & Destructor Documentation

◆ IdentityApplicationState()

Paiwise.IdentityApplicationState.IdentityApplicationState	(	IdentityApplication	Application,
		IdentityState	State
	)

Contains information about a legal identity application, including its current state.

Parameters

Application	Application to duplicate.
State	Current state.

Definition at line 19 of file IdentityApplicationState.cs.

Member Function Documentation

◆ AddPotentialClaims()

void Paiwise.IdentityApplication.AddPotentialClaims	(	string	Claim,
		object	Value,
		bool	InformUser,
		object	Service
	)

inherited

Adds potential claims to the application that can be used in a subsequent applcation. Can be used by preview applications to suggest claims that could be added to the application automatically, to simplify user experience.

Parameters

Claim	The claim that could be added.
Value	The value of the claim.
InformUser	If the user can be informed by this potential claim, without risk of leaking sensitive personal information.
Service	The service adding the potential claim.

Implements Paiwise.IIdentityApplication.

Definition at line 974 of file IdentityApplication.cs.

◆ ClaimInvalid()

void Paiwise.IdentityApplication.ClaimInvalid	(	string	Claim,
		string	Reason,
		string	ReasonLanguage,
		string	ReasonCode,
		object	Service
	)

inherited

An identity authenticator service invalidates a claim.

Parameters

Claim	Claim invalidated.
Reason	Reason for invalidating claim.
ReasonLanguage	ISO code of language used for Reason .
ReasonCode	A machine-readable code for the reason for invalidating the claim. (Each service can define its own reason codes.)
Service	Service invalidating claim.

Implements Paiwise.IIdentityApplication.

Definition at line 195 of file IdentityApplication.cs.

◆ ClaimValid()

void Paiwise.IdentityApplication.ClaimValid	(	string	Claim,
		object	Service
	)

inherited

An identity authenticator service validates a claim.

Parameters

Claim	Claim validated.
Service	Service validating claim.

Implements Paiwise.IIdentityApplication.

Definition at line 169 of file IdentityApplication.cs.

◆ GetClientErrorMessageXml()

string Paiwise.IdentityApplication.GetClientErrorMessageXml	(	out string	Language,
		string	DefaultMessage,
		string	DefaultMessageCode,
		string	DefaultLanguage
	)

inherited

Gets the XML of the client error message.

Parameters

Language	Language used for main message.
DefaultMessage	Default message, in case there is no error message available.
DefaultMessageCode	Default message code, if there is no error message available.
DefaultLanguage	Default language code, if there is no error message available.

Returns: XML message that can be sent to the client.

Definition at line 701 of file IdentityApplication.cs.

◆ GetIdentityReviewXml()

string Paiwise.IdentityApplication.GetIdentityReviewXml ( )

inherited

Gets information about the review as XML.

Returns: XML document that can be added as an attachment to the identity.

Definition at line 733 of file IdentityApplication.cs.

◆ InvalidateAllClaims()

void Paiwise.IdentityApplication.InvalidateAllClaims	(	string	Reason,
		string	ReasonLanguage,
		string	ReasonCode
	)

inherited

Invalidates all claims.

Parameters

Reason	Reason for invalidating claim.
ReasonLanguage	ISO code of language used for Reason .
ReasonCode	A machine-readable code for the reason for invalidating the claim. (Each service can define its own reason codes.)

Implements Paiwise.IIdentityApplication.

Definition at line 916 of file IdentityApplication.cs.

◆ InvalidateAllPhotos()

void Paiwise.IdentityApplication.InvalidateAllPhotos	(	string	Reason,
		string	ReasonLanguage,
		string	ReasonCode
	)

inherited

Invalidates all photos

Parameters

Reason	Reason for invalidating claim.
ReasonLanguage	ISO code of language used for Reason .
ReasonCode	A machine-readable code for the reason for invalidating the claim. (Each service can define its own reason codes.)

Implements Paiwise.IIdentityApplication.

Definition at line 931 of file IdentityApplication.cs.

◆ LogResults()

void Paiwise.IdentityApplication.LogResults ( )

inherited

Logs the results of the validation process to the event log.

Definition at line 629 of file IdentityApplication.cs.

◆ PhotoInvalid()

void Paiwise.IdentityApplication.PhotoInvalid	(	IPhoto	Photo,
		string	Reason,
		string	ReasonLanguage,
		string	ReasonCode,
		object	Service
	)

inherited

An identity authenticator service invalidates a photo.

Parameters

Photo	Photo invalidated.
Reason	Reason for invalidating photo.
ReasonLanguage	ISO code of language used for Reason .
ReasonCode	A machine-readable code for the reason for invalidating the photo. (Each service can define its own reason codes.)
Service	Service validating photo.

Implements Paiwise.IIdentityApplication.

Definition at line 242 of file IdentityApplication.cs.

◆ PhotoValid()

void Paiwise.IdentityApplication.PhotoValid	(	IPhoto	Photo,
		object	Service
	)

inherited

An identity authenticator service validates a photo.

Parameters

Photo	Photo validated.
Service	Service validating photo.

Implements Paiwise.IIdentityApplication.

Definition at line 218 of file IdentityApplication.cs.

◆ ReportError()

void Paiwise.IdentityApplication.ReportError	(	string	Error,
		string	ErrorLanguage,
		string	ErrorCode,
		ValidationErrorType	ErrorType,
		object	Service,
		params KeyValuePair< string, object >[]	Tags
	)

inherited

Reports an error encountered during validation.

Parameters

Error	Error message.
ErrorLanguage	ISO code of language of Error .
ErrorCode	A machine-readable code for the error.
ErrorType	Type of error.
Service	Service validating photo.
Tags	Tags associated with error.

Implements Paiwise.IIdentityApplication.

Definition at line 267 of file IdentityApplication.cs.

◆ TryGetValue< T >()

bool Paiwise.IdentityApplication.TryGetValue< T >	(	string	Claim,
		object	Value,
		object	Service,
		out T	TypedValue
	)

inherited

Tries to get a typed claim value from an untyped claim value.

Template Parameters

T	Expected type.

Parameters

Claim	Claim identifier.
Value	Untyped value.
Service	Service requesting the value.
TypedValue	Typed value, if successful.

Returns: If able to get the typed value.

Definition at line 947 of file IdentityApplication.cs.

◆ ValidateAllClaims()

void Paiwise.IdentityApplication.ValidateAllClaims ( )

inherited

Validates all claims.

Implements Paiwise.IIdentityApplication.

Definition at line 894 of file IdentityApplication.cs.

◆ ValidateAllPhotos()

void Paiwise.IdentityApplication.ValidateAllPhotos ( )

inherited

Validates all photos

Implements Paiwise.IIdentityApplication.

Definition at line 903 of file IdentityApplication.cs.

Property Documentation

◆ Account

IAccount Paiwise.IdentityApplication.Account

getinherited

Account over which the application was made.

Implements Paiwise.IIdentityApplication.

Definition at line 137 of file IdentityApplication.cs.

◆ Claims

KeyValuePair<string, object> [] Paiwise.IdentityApplication.Claims

getinherited

Full set of claims made regarding the identity, as meta-data tags.

Implements Paiwise.IIdentityApplication.

Definition at line 147 of file IdentityApplication.cs.

◆ Documents

IEnumerable<XmlDocument> Paiwise.IdentityApplication.Documents

getinherited

Associated XML document attachments provided.

Implements Paiwise.IIdentityApplication.

Definition at line 162 of file IdentityApplication.cs.

◆ Errors

ValidationError [] Paiwise.IdentityApplication.Errors

getinherited

Any errors reported during validation.

Implements Paiwise.IIdentityApplication.

Definition at line 395 of file IdentityApplication.cs.

◆ FirstError

IValidationError Paiwise.IdentityApplication.FirstError

getinherited

First error encountered during validation.

Definition at line 673 of file IdentityApplication.cs.

◆ HasErrors

bool Paiwise.IdentityApplication.HasErrors

getinherited

If errors are reported.

Implements Paiwise.IIdentityApplication.

Definition at line 409 of file IdentityApplication.cs.

◆ HasPotentialClaims

bool Paiwise.IdentityApplication.HasPotentialClaims

getinherited

If the application has potential claims.

Definition at line 541 of file IdentityApplication.cs.

◆ HasServices

bool Paiwise.IdentityApplication.HasServices

getinherited

If services have returned feedback on the application.

Implements Paiwise.IIdentityApplication.

Definition at line 451 of file IdentityApplication.cs.

◆ HasValidatedClaims

bool Paiwise.IdentityApplication.HasValidatedClaims

getinherited

If the application has validated claims.

Implements Paiwise.IIdentityApplication.

Definition at line 513 of file IdentityApplication.cs.

◆ HasValidatedPhotos

bool Paiwise.IdentityApplication.HasValidatedPhotos

getinherited

If the application has validated photos.

Implements Paiwise.IIdentityApplication.

Definition at line 527 of file IdentityApplication.cs.

◆ InvalidatedClaims

InvalidClaim [] Paiwise.IdentityApplication.InvalidatedClaims

getinherited

Invalidated claims.

Implements Paiwise.IIdentityApplication.

Definition at line 299 of file IdentityApplication.cs.

◆ InvalidatedPhotos

InvalidPhoto [] Paiwise.IdentityApplication.InvalidatedPhotos

getinherited

Invalidated photos.

Implements Paiwise.IIdentityApplication.

Definition at line 347 of file IdentityApplication.cs.

◆ IsValid

bool? Paiwise.IdentityApplication.IsValid

getinherited

If the application has been validated (true), invalidated (false), or not yet validated (null).

Implements Paiwise.IIdentityApplication.

Definition at line 480 of file IdentityApplication.cs.

◆ NrErrors

int Paiwise.IdentityApplication.NrErrors

getinherited

Number of errors reported.

Implements Paiwise.IIdentityApplication.

Definition at line 423 of file IdentityApplication.cs.

◆ NrPhotos

int Paiwise.IdentityApplication.NrPhotos

getinherited

Number of photos provided.

Implements Paiwise.IIdentityApplication.

Definition at line 157 of file IdentityApplication.cs.

◆ NrServices

int Paiwise.IdentityApplication.NrServices

getinherited

Number of services returning feedback on the the application.

Implements Paiwise.IIdentityApplication.

Definition at line 465 of file IdentityApplication.cs.

◆ PersonalInformation

PersonalInformation Paiwise.IdentityApplication.PersonalInformation

getinherited

Personal information extracted from Claims.

Implements Paiwise.IIdentityApplication.

Definition at line 142 of file IdentityApplication.cs.

◆ Photos

IEnumerable<IPhoto> Paiwise.IdentityApplication.Photos

getinherited

Photos provided.

Implements Paiwise.IIdentityApplication.

Definition at line 152 of file IdentityApplication.cs.

◆ PotentialClaims

PotentialClaim [] Paiwise.IdentityApplication.PotentialClaims

getinherited

Potential claims

Definition at line 379 of file IdentityApplication.cs.

◆ Preview

bool Paiwise.IdentityApplication.Preview

getinherited

If the application is a preview of an application. Previewed applications should not be persisted.

Implements Paiwise.IIdentityApplication.

Definition at line 132 of file IdentityApplication.cs.

◆ Services

object [] Paiwise.IdentityApplication.Services

getinherited

Services involved in returning feedback on the application.

Implements Paiwise.IIdentityApplication.

Definition at line 437 of file IdentityApplication.cs.

◆ State

IdentityState Paiwise.IdentityApplicationState.State

get

Current state of the legal identity application.

Implements Paiwise.IIdentityApplicationState.

Definition at line 28 of file IdentityApplicationState.cs.

◆ Tags

KeyValuePair<string, object> [] Paiwise.IdentityApplication.Tags

getinherited

Tags annotating the application, as reported by the different services.

Implements Paiwise.IIdentityApplication.

Definition at line 555 of file IdentityApplication.cs.

◆ UnvalidatedClaims

string [] Paiwise.IdentityApplication.UnvalidatedClaims

getinherited

Unvalidated claims.

Implements Paiwise.IIdentityApplication.

Definition at line 315 of file IdentityApplication.cs.

◆ UnvalidatedPhotos

IPhoto [] Paiwise.IdentityApplication.UnvalidatedPhotos

getinherited

Unvalidated photos.

Implements Paiwise.IIdentityApplication.

Definition at line 363 of file IdentityApplication.cs.

◆ ValidatedClaims

ValidClaim [] Paiwise.IdentityApplication.ValidatedClaims

getinherited

Validated claims.

Implements Paiwise.IIdentityApplication.

Definition at line 283 of file IdentityApplication.cs.

◆ ValidatedPhotos

ValidPhoto [] Paiwise.IdentityApplication.ValidatedPhotos

getinherited

Validated photos.

Implements Paiwise.IIdentityApplication.

Definition at line 331 of file IdentityApplication.cs.

The documentation for this class was generated from the following file:

C:/My Projects/IoTBroker/Waher.Payments/IdentityApplicationState.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ IdentityApplicationState()

Member Function Documentation

◆ AddPotentialClaims()

◆ ClaimInvalid()

◆ ClaimValid()

◆ GetClientErrorMessageXml()

◆ GetIdentityReviewXml()

◆ InvalidateAllClaims()

◆ InvalidateAllPhotos()

◆ LogResults()

◆ PhotoInvalid()

◆ PhotoValid()

◆ ReportError()

◆ TryGetValue< T >()

◆ ValidateAllClaims()

◆ ValidateAllPhotos()

Property Documentation

◆ Account

◆ Claims

◆ Documents

◆ Errors

◆ FirstError

◆ HasErrors

◆ HasPotentialClaims

◆ HasServices

◆ HasValidatedClaims

◆ HasValidatedPhotos

◆ InvalidatedClaims

◆ InvalidatedPhotos

◆ IsValid

◆ NrErrors

◆ NrPhotos

◆ NrServices

◆ PersonalInformation

◆ Photos

◆ PotentialClaims

◆ Preview

◆ Services

◆ State

◆ Tags

◆ UnvalidatedClaims

◆ UnvalidatedPhotos

◆ ValidatedClaims

◆ ValidatedPhotos