Edit

GitHub Adapter

  • Article

The GitHub adapter is the storage adapter that points to the Common Data Model public standards schema documents on GitHub.

Note: This class is on the deprecation path.

public class GitHubAdapter extends NetworkAdapter

GitHubAdapter extends NetworkAdapter, StorageAdapterBase in Python.

Constructors

Name Description
GitHubAdapter() Initializes a new instance of the GitHubAdapter class.

Properties

Name Type Description
LocationHint string The hint given to the reader application about where the adapter implementation can be obtained (Nuget, NPM, etc.).

Methods

Name Description Return Type
CanRead() Returns true, since the GitHub adapter can read data. bool
CanWrite() Returns false, since the GitHub adapter can't write data to its source. bool
ReadAsync(string) See StorageAdapterBase.ReadAsync(...). Task<string>
WriteAsync(string, string) See StorageAdapterBase.WriteAsync(...). Throws a NotImplementedException because the GitHub adapter can't write to its source. Task
CreateAdapterPath(string) See StorageAdapterBase.CreateAdapterPath(...). string
CreateCorpusPath(string) See StorageAdapterBase.CreateCorpusPath(...). string
ClearCache() See StorageAdapterBase.ClearCache(). void
ComputeLastModifiedTimeAsync(string) See StorageAdapterBase.ComputeLastModifiedTimeAsync(...). Returns Time.Now(). Task<DateTimeOffset?>
FetchAllFilesAsync(string) See StorageAdapterBase.FetchAllFilesAsync(...). Returns null. Task<List<string>>
FetchConfig() See StorageAdapterBase.FetchConfig(). string
UpdateConfig(string) See StorageAdapterBase.UpdateConfig(...). void
CreateFileQueryCacheContext() See StorageAdapterBase.CreateFileQueryCacheContext(). IDisposable