Expand description
§Custom Domains Canister API
This module defines the public API types and interfaces for the custom domains management canister.
All types implement CandidType for integration with candid interface.
Structs§
- Certificates
Page - Domain
Entry - Domain
Status - Domains
Page - A page of domain entries with pagination information (items exclude enc_cert and enc_priv_key).
- InitArg
- Input
Task - Issue
Certificate Output - List
Certificates Page Input - List
Domains Page Input - Input for paginated domain listing
- Listed
Domain Entry - Domain entry as returned by list_domains_page: includes domain name and all entry fields except enc_cert and enc_priv_key.
- Registered
Domain - Registration
Status Iter - An iterator over the variants of RegistrationStatus
- Scheduled
Task - Task
Result
Enums§
- Fetch
Task Error - GetDomain
Entry Error - GetDomain
Status Error - GetLast
Change Time Error - HasNext
Task Error - List
Certificates Page Error - List
Domains Page Error - Registration
Status - Submit
Task Error - Task
Fail Reason - Task
Kind - Task
Outcome - Task
Output - TryAdd
Task Error
Constants§
- CERTIFICATE_
VALIDITY_ FRACTION - CERT_
EXPIRATION_ ALERT_ THRESHOLD - DEFAULT_
PAGE_ LIMIT - EXPIRED_
DOMAIN_ EXPIRATION_ TIME - MAX_
PAGE_ LIMIT - MAX_
TASK_ FAILURES - MIN_
TASK_ RETRY_ DELAY - STALE_
DOMAINS_ CLEANUP_ INTERVAL - TASK_
TIMEOUT - UNREGISTERED_
DOMAIN_ EXPIRATION_ TIME