Interface IIDCache

The ID cache manages IDs.

Namespace: ComponentSpace.Saml2.Cache

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface IIDCache

Methods

AddAsync(String, DateTime)

Adds the ID with an associated expiration time to the cache.

Declaration

Task<bool> AddAsync(string id, DateTime expirationDateTime)

Parameters

Type	Name	Description
System.String	id	The ID.
System.DateTime	expirationDateTime	The expiration time.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the add operation and returns true if the ID already exists in the cache; otherwise false.

Exceptions

Type	Condition
SamlEnvironmentException	Thrown if the ID cannot be added to the cache.

RemoveAsync(String)

Removes the ID from the cache.

Declaration

Task RemoveAsync(string id)

Parameters

Type	Name	Description
System.String	id	The ID.

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the remove operation.

Exceptions

Type	Condition
SamlEnvironmentException	Thrown if the ID cannot be removed from the cache.