For Babelfish Release 1.11.1.3

ClubsAPIClient Class

API Client to access information about an Orion Acct, club ownership, and club teams. An Orion Acct is the same as a Club. And a Club is the same as an Orion Acct

Definition

Namespace: Scopos.BabelFish.APIClients
Assembly: BabelFish (in BabelFish.dll) Version: 1.11.1.4+b1da393815f6638555a663d9a94167ecabea5695
C#
public class ClubsAPIClient : APIClient<ClubsAPIClient>
Inheritance
Object    APIClientClubsAPIClient    ClubsAPIClient

Constructors

Properties

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)

Methods

CallAPIAsyncT
(Inherited from APIClientT)
CreateCoachAssignmentAuthenticatedAsync 
DeleteCoachAssignmentAuthenticatedAsync 
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetClubDetailAuthenticatedAsync(GetClubDetailAuthenticatedRequest) Returns detailed information about an Orion account (aka a clubs account).
GetClubDetailAuthenticatedAsync(String, UserAuthentication) Returns detailed information about an Orion account (aka a clubs account), identified by the passed on owner-id (e.g. OrionAcct001234).
GetClubDetailPublicAsync(GetClubDetailPublicRequest) Returns detailed information about an Orion account (aka a clubs account).
GetClubDetailPublicAsync(String) Returns detailed information about an Orion account (aka a clubs account), identified by the passed on owner-id (e.g. OrionAcct001234).
GetClubListAuthenticatedAsync(GetClubListAuthenticatedRequest) GetClubList returns a list of clubs (aka Orion Accounts) the logged in user is associated with as an Admin / member / etc. Generally this ia a parameterless call, but may also include a Token value, with the list of clubs is too large to return in a single response.
GetClubListAuthenticatedAsync(UserAuthentication) GetClubList returns a list of clubs (aka Orion Accounts) the logged in user is associated with as an Admin / member / etc. Generally this ia a parameterless call.
GetClubListPublicAsync(Boolean) GetClubList returns a list of clubs (aka Orion Accounts) the logged in user is associated with as an Admin / member / etc. Generally this ia a parameterless call.
GetClubListPublicAsync(GetClubListPublicRequest) GetClubList returns a list of clubs (aka Orion Accounts) the logged in user is associated with as an Admin / member / etc. Generally this ia a parameterless call, but may also include a Token value, with the list of clubs is too large to return in a single response.
GetCoachAssignmentAuthenticatedAsync(GetCoachAssignmentAuthenticatedRequest) 
GetCoachAssignmentAuthenticatedAsync(Int32, UserAuthentication) 
GetCoachClubListAuthenticatedAsync 
GetCoachClubListPublicAsync(GetCoachClubListPublicRequest) 
GetCoachClubListPublicAsync(String) 
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryReadFromFileSystemAsync
(Inherited from APIClientT)
TryWriteToFileSystemAsyncT
(Inherited from APIClientT)

See Also