Table of Contents

Class RefreshStatus

Namespace
OpenShell
Assembly
OpenShell.Sdk.dll

Gateway-owned refresh state of one provider credential.

public sealed record RefreshStatus : IEquatable<RefreshStatus>
Inheritance
RefreshStatus
Implements
Inherited Members

Properties

CredentialKey

Credential key.

public string CredentialKey { get; init; }

Property Value

string

ExpiresAt

Credential expiration.

public DateTimeOffset? ExpiresAt { get; init; }

Property Value

DateTimeOffset?

FailureCode

Stable gateway-owned failure identifier, for example oauth_invalid_grant.

public string FailureCode { get; init; }

Property Value

string

LastError

Last error text.

public string LastError { get; init; }

Property Value

string

LastErrorAt

Time of the last error.

public DateTimeOffset? LastErrorAt { get; init; }

Property Value

DateTimeOffset?

LastRefreshAt

Last successful refresh.

public DateTimeOffset? LastRefreshAt { get; init; }

Property Value

DateTimeOffset?

NextRefreshAt

Next automatic refresh; null means none is scheduled. Use RecoveryAction to tell a parked refresh from an unset time.

public DateTimeOffset? NextRefreshAt { get; init; }

Property Value

DateTimeOffset?

Provider

Provider name.

public string Provider { get; init; }

Property Value

string

ProviderErrorSubtype

Bounded provider subtype refining FailureCode.

public string ProviderErrorSubtype { get; init; }

Property Value

string

ProviderId

Provider id.

public string ProviderId { get; init; }

Property Value

string

RecoveryAction

Required recovery workflow.

public RefreshRecoveryAction RecoveryAction { get; init; }

Property Value

RefreshRecoveryAction

Status

Status text.

public string Status { get; init; }

Property Value

string

Strategy

Strategy.

public RefreshStrategy Strategy { get; init; }

Property Value

RefreshStrategy