Interface for identity applications. More...

Inheritance diagram for Paiwise.IIdentityApplication:

Public Member Functions
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	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...

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
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...

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...

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

Detailed Description

Interface for identity applications.

Definition at line 12 of file IIdentityApplication.cs.

Member Function Documentation

◆ AddPotentialClaims()

void Paiwise.IIdentityApplication.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.

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.

Implemented in Paiwise.IdentityApplication.

◆ ClaimInvalid()

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

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.

Implemented in Paiwise.IdentityApplication.

◆ ClaimValid()

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

An identity authenticator service validates a claim.

Parameters

Claim	Claim validated.
Service	Service validating claim.

Implemented in Paiwise.IdentityApplication.

◆ InvalidateAllClaims()

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

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.)

Implemented in Paiwise.IdentityApplication.

◆ InvalidateAllPhotos()

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

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.)

Implemented in Paiwise.IdentityApplication.

◆ PhotoInvalid()

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

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.

Implemented in Paiwise.IdentityApplication.

◆ PhotoValid()

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

An identity authenticator service validates a photo.

Parameters

Photo	Photo validated.
Service	Service validating photo.

Implemented in Paiwise.IdentityApplication.

◆ ReportError()

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

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.

Implemented in Paiwise.IdentityApplication.

◆ ValidateAllClaims()

void Paiwise.IIdentityApplication.ValidateAllClaims ( )

Validates all claims.

Implemented in Paiwise.IdentityApplication.

◆ ValidateAllPhotos()

void Paiwise.IIdentityApplication.ValidateAllPhotos ( )

Validates all photos

Implemented in Paiwise.IdentityApplication.

Property Documentation

◆ Account

IAccount Paiwise.IIdentityApplication.Account

get

Account over which the application was made.

Implemented in Paiwise.IdentityApplication.

Definition at line 23 of file IIdentityApplication.cs.

◆ Claims

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

get

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

Implemented in Paiwise.IdentityApplication.

Definition at line 33 of file IIdentityApplication.cs.

◆ Documents

IEnumerable<XmlDocument> Paiwise.IIdentityApplication.Documents

get

Associated XML document attachments provided.

Implemented in Paiwise.IdentityApplication.

Definition at line 48 of file IIdentityApplication.cs.

◆ Errors

ValidationError [] Paiwise.IIdentityApplication.Errors

get

Any errors reported during validation.

Implemented in Paiwise.IdentityApplication.

Definition at line 133 of file IIdentityApplication.cs.

◆ HasErrors

bool Paiwise.IIdentityApplication.HasErrors

get

If errors are reported.

Implemented in Paiwise.IdentityApplication.

Definition at line 138 of file IIdentityApplication.cs.

◆ HasServices

bool Paiwise.IIdentityApplication.HasServices

get

If services have returned feedback on the application.

Implemented in Paiwise.IdentityApplication.

Definition at line 153 of file IIdentityApplication.cs.

◆ HasValidatedClaims

bool Paiwise.IIdentityApplication.HasValidatedClaims

get

If the application has validated claims.

Implemented in Paiwise.IdentityApplication.

Definition at line 169 of file IIdentityApplication.cs.

◆ HasValidatedPhotos

bool Paiwise.IIdentityApplication.HasValidatedPhotos

get

If the application has validated photos.

Implemented in Paiwise.IdentityApplication.

Definition at line 174 of file IIdentityApplication.cs.

◆ InvalidatedClaims

InvalidClaim [] Paiwise.IIdentityApplication.InvalidatedClaims

get

Invalidated claims.

Implemented in Paiwise.IdentityApplication.

Definition at line 108 of file IIdentityApplication.cs.

◆ InvalidatedPhotos

InvalidPhoto [] Paiwise.IIdentityApplication.InvalidatedPhotos

get

Invalidated photos.

Implemented in Paiwise.IdentityApplication.

Definition at line 123 of file IIdentityApplication.cs.

◆ IsValid

bool? Paiwise.IIdentityApplication.IsValid

get

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

Implemented in Paiwise.IdentityApplication.

Definition at line 164 of file IIdentityApplication.cs.

◆ NrErrors

int Paiwise.IIdentityApplication.NrErrors

get

Number of errors reported.

Implemented in Paiwise.IdentityApplication.

Definition at line 143 of file IIdentityApplication.cs.

◆ NrPhotos

int Paiwise.IIdentityApplication.NrPhotos

get

Number of photos provided.

Implemented in Paiwise.IdentityApplication.

Definition at line 43 of file IIdentityApplication.cs.

◆ NrServices

int Paiwise.IIdentityApplication.NrServices

get

Number of services returning feedback on the the application.

Implemented in Paiwise.IdentityApplication.

Definition at line 158 of file IIdentityApplication.cs.

◆ PersonalInformation

PersonalInformation Paiwise.IIdentityApplication.PersonalInformation

get

Personal information extracted from Claims.

Implemented in Paiwise.IdentityApplication.

Definition at line 28 of file IIdentityApplication.cs.

◆ Photos

IEnumerable<IPhoto> Paiwise.IIdentityApplication.Photos

get

Photos provided.

Implemented in Paiwise.IdentityApplication.

Definition at line 38 of file IIdentityApplication.cs.

◆ Preview

bool Paiwise.IIdentityApplication.Preview

get

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

Implemented in Paiwise.IdentityApplication.

Definition at line 18 of file IIdentityApplication.cs.

◆ Services

object [] Paiwise.IIdentityApplication.Services

get

Services involved in returning feedback on the application.

Implemented in Paiwise.IdentityApplication.

Definition at line 148 of file IIdentityApplication.cs.

◆ Tags

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

get

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

Implemented in Paiwise.IdentityApplication.

Definition at line 179 of file IIdentityApplication.cs.

◆ UnvalidatedClaims

string [] Paiwise.IIdentityApplication.UnvalidatedClaims

get

Unvalidated claims.

Implemented in Paiwise.IdentityApplication.

Definition at line 113 of file IIdentityApplication.cs.

◆ UnvalidatedPhotos

IPhoto [] Paiwise.IIdentityApplication.UnvalidatedPhotos

get

Unvalidated photos.

Implemented in Paiwise.IdentityApplication.

Definition at line 128 of file IIdentityApplication.cs.

◆ ValidatedClaims

ValidClaim [] Paiwise.IIdentityApplication.ValidatedClaims

get

Validated claims.

Implemented in Paiwise.IdentityApplication.

Definition at line 103 of file IIdentityApplication.cs.

◆ ValidatedPhotos

ValidPhoto [] Paiwise.IIdentityApplication.ValidatedPhotos

get

Validated photos.

Implemented in Paiwise.IdentityApplication.

Definition at line 118 of file IIdentityApplication.cs.

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddPotentialClaims()

◆ ClaimInvalid()

◆ ClaimValid()

◆ InvalidateAllClaims()

◆ InvalidateAllPhotos()

◆ PhotoInvalid()

◆ PhotoValid()

◆ ReportError()

◆ ValidateAllClaims()

◆ ValidateAllPhotos()

Property Documentation

◆ Account

◆ Claims

◆ Documents

◆ Errors

◆ HasErrors

◆ HasServices

◆ HasValidatedClaims

◆ HasValidatedPhotos

◆ InvalidatedClaims

◆ InvalidatedPhotos

◆ IsValid

◆ NrErrors

◆ NrPhotos

◆ NrServices

◆ PersonalInformation

◆ Photos

◆ Preview

◆ Services

◆ Tags

◆ UnvalidatedClaims

◆ UnvalidatedPhotos

◆ ValidatedClaims

◆ ValidatedPhotos