public class DefinitionAPIClient : APIClient<DefinitionAPIClient>| DefinitionAPIClient | Instantiate client |
| DefinitionAPIClient(APIStage) |
| ApiStage |
ApiStage may be used to test in different development stages, e.g. production, beta, alpha.
(Inherited from APIClientT) |
| IgnoreFileSystemCache |
Indicates if the local file system cache should be ignored and always pass through to making the
call to the Rest API.
The option to ignore file system cache can either be set at the API Client level, or on a per request level. Cached responses are only valid for HttpMethod GET calls.
To enable cache for anAPI call two things must happen. First, the concrete APIClient needs
to enable file system cache by setting .IgnoreFileSystemCache to false. Second the client's
LocalStoreDirectory must be set.
(Inherited from APIClientT) |
| IgnoreInMemoryCache |
Indicates if the local response cache should be ignored and always
make the request to the Local File System and then to the Rest API.
The default value is true. Which means if an API Client wants to use local
cached values, it must be enabled (set to false) within the concrete API Client.
The option to ignore in memory cache can either be set at the API Client level, or on a per request level. Cached responses are only valid for HttpMethod GET calls.
To enable cache for a API call two things needs to happen. First the concrete
APIClient needs to enabled caching response by setting .IgnoreInMemoryCache to false.
Second, each response object must enable it by overridding GetCacheValueExpiryTime
to a value in the future.
(Inherited from APIClientT) |
| LocalDefinitionDirectory |
| CallAPIAsyncT | (Inherited from APIClientT) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetAttributeDefinitionAsync | Makes a request to return an ATTRIBUTE Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetCourseOfFireDefinitionAsync | Makes a request to return an COURSE OF FIRE Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetDefinitionAsyncT | Makes a request to return a Definition file. |
| GetDefinitionListPublicAsync(DefinitionType) | |
| GetDefinitionListPublicAsync(GetDefinitionListPublicRequest) | |
| GetDefinitionListPublicAsync(DefinitionType, String) | Retreives a list of SparseDefinitions in order or relavancy to the provided searchTerm. Maximum 20 items are returned. |
| GetDefinitionVersionPublicAsync(GetDefinitionVersionPublicRequest) | |
| GetDefinitionVersionPublicAsync(DefinitionType, SetName) | |
| GetEventAndStageStyleMappingDefinitionAsync | Makes a request to return an EVENT AND STAGE STYLE MAPPING Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetEventStyleDefinitionAsync | Makes a request to return an EVENT STYLE Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetRankingRuleDefinitionAsync | Makes a request to return an RANKING RULE Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetResultListFormatDefinitionAsync | Makes a request to return an RESULT LIST FORMAT Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetScoreFormatCollectionDefinitionAsync | Makes a request to return an SCORE FORMAT COLLECTION Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetStageStyleDefinitionAsync | Makes a request to return an STAGE STYLE Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetTargetCollectionDefinitionAsync | Makes a request to return an TARGET COLLECTION Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetTargetDefinitionAsync | Makes a request to return an TARGET Definition given its SetName. Will try and use local file system cache and memory cache. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryReadFromFileSystemAsync |
Attempts to read the Definition file from the local file system.
Because this method is async, and we can't have 'out' variables on async methods, this method instead returns a tuple.
.Item1 is a boolean indicating if it was successful.
.Item2 is the ResponseIntermediateObject (if successful) containing the definition file.
(Overrides APIClientTTryReadFromFileSystemAsync(Request)) |
| TryWriteToFileSystemAsyncT(ResponseT) | (Inherited from APIClientT) |
| TryWriteToFileSystemAsyncT(ResponseT) | (Overrides APIClientTTryWriteToFileSystemAsyncT(ResponseT)) |