Class DomainAccessSugar
Inheritance
Namespace: Xrpl.Sugar
Assembly: Xrpl.dll
Syntax
public static class DomainAccessSugarMethods
| Edit this page View SourceEvaluateDomainAccess(IReadOnlyList<LOCredential>, DateTime, uint)
Evaluates domain access from the credential entries found for the account. Null entries mean the account does not hold the corresponding credential. A credential is expired only when the close time is strictly greater than its Expiration, matching rippled's credentials::checkExpired.
Declaration
public static DomainAccessResult EvaluateDomainAccess(IReadOnlyList<LOCredential> credentials, DateTime closeTime, uint ledgerIndex)Parameters
| Type | Name | Description |
|---|---|---|
| IReadOnlyList<LOCredential> | credentials | Credential entries matching the domain's accepted pairs; null where not held. |
| DateTime | closeTime | Close time of the ledger the check is performed against. |
| uint | ledgerIndex | Index of the ledger the check is performed against. |
Returns
| Type | Description |
|---|---|
| DomainAccessResult |
GetDomainAccess(IXrplClient, string, string, CancellationToken)
Checks whether an account has access to a permissioned domain.
Performs one ledger_entry lookup for the domain plus up to 10 parallel
ledger_entry credential lookups, all pinned to the same validated ledger.
Declaration
public static Task<DomainAccessResult> GetDomainAccess(this IXrplClient client, string account, string domainId, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| IXrplClient | client | Client. |
| string | account | The account whose domain access is checked. |
| string | domainId | The ledger entry ID of the PermissionedDomain, as hexadecimal. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<DomainAccessResult> |
Exceptions
| Type | Condition |
|---|---|
| RippleException | The entry at |