.NET API
ApiKeyCreationResult
Namespace Tracon · Assembly
Tracon.Abstractions.dllThe result of a key creation operation.
public sealed record ApiKeyCreationResult : IEquatable<ApiKeyCreationResult>- Inheritance
- object ← ApiKeyCreationResult
- Implements
- IEquatable<ApiKeyCreationResult>
- Inherited Members
- object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Remarks
Section titled “Remarks”The raw key is returned ONLY here, at creation time.
Constructors
Section titled “Constructors”ApiKeyCreationResult()
Section titled “ ApiKeyCreationResult()”public ApiKeyCreationResult()Properties
Section titled “Properties”PlaintextKey
Section titled “ PlaintextKey”The raw key value. Cannot be produced again after this call; the consumer must show it immediately and not store it.
public required string PlaintextKey { get; init; }Property Value
Section titled “Property Value”Record
Section titled “ Record”The saved view, which carries no raw value.
public required ApiKeyRecord Record { get; init; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”Equals(object?)
Section titled “ Equals(object?)”public override bool Equals(object? obj)Parameters
Section titled “Parameters”obj object?
Returns
Section titled “Returns”Equals(ApiKeyCreationResult?)
Section titled “ Equals(ApiKeyCreationResult?)”public bool Equals(ApiKeyCreationResult? other)Parameters
Section titled “Parameters”other ApiKeyCreationResult?
Returns
Section titled “Returns”GetHashCode()
Section titled “ GetHashCode()”public override int GetHashCode()Returns
Section titled “Returns”ToString()
Section titled “ ToString()”Returns a description that carries no raw key.
public override string ToString()Returns
Section titled “Returns”The type name and the saved record; never the raw value.
Remarks
Section titled “Remarks”A record’s compiler-generated ToString prints every property, and
this one holds the only copy of the raw key that will ever exist.
Operators
Section titled “Operators”operator ==(ApiKeyCreationResult?, ApiKeyCreationResult?)
Section titled “ operator ==(ApiKeyCreationResult?, ApiKeyCreationResult?)”public static bool operator ==(ApiKeyCreationResult? left, ApiKeyCreationResult? right)Parameters
Section titled “Parameters”left ApiKeyCreationResult?
right ApiKeyCreationResult?
Returns
Section titled “Returns”operator !=(ApiKeyCreationResult?, ApiKeyCreationResult?)
Section titled “ operator !=(ApiKeyCreationResult?, ApiKeyCreationResult?)”public static bool operator !=(ApiKeyCreationResult? left, ApiKeyCreationResult? right)Parameters
Section titled “Parameters”left ApiKeyCreationResult?
right ApiKeyCreationResult?