Skip to content

API reference ​

Everything lives in the GamePassStorage namespace of the GamePassStorage package. These pages are written by hand from the public types; the signatures match the source.

PageTypes
WgsStoreThe store: opening, reading, writing, multi-blob containers, delete, restore, export/import, repair, orphans, diagnosis
Containers and stateWgsContainer, WgsEntryState, WgsSyncState, WgsOrphanedContainer, WgsManifestInfo, WgsBlobEntry, WgsBlobInfo, delete and export/import types
Results and status codesWgsOpenStatus, WgsOperationStatus, WgsOpenResult, WgsReadResult, WgsCommitResult, WgsChangeReport, WgsWritePlan, WgsDiagnosis, WgsWriteRefusedException
Write gates and assessmentsIWgsWriteGate, WgsWriteGates (including the process-aware gate), IWgsProcessLister, WgsWriteAssessment, WgsWriteConcern
Injected servicesWgsStoreOptions, IWgsFileSystem, IWgsClock, IWgsLog, IWgsBlobInspector, WgsBlobDescription
SnapshotsWgsSnapshot, WgsContainerState
Store discoveryWgsStoreDiscovery, WgsStoreLocation, WgsStoreDiscoveryOptions
Game adaptersIWgsGameAdapter, IWgsPayloadCodec, WgsContentDescription, GenericWgsAdapter, WgsGameAdapterRegistry, WgsAdapterLoader

For the meaning of the bytes behind these types, see the format reference. For task-oriented explanations, start with Getting started.

Released under the Apache-2.0 license. Not affiliated with Microsoft.