C# Class ParkitectNexus.Data.Web.API.ParkitectNexusAPI

Represents the ParkitectNexus API.
Inheritance: IParkitectNexusAPI
Afficher le fichier Open project: ParkitectNexus/ParkitectNexusClient

Méthodes publiques

Méthode Description
GetAsset ( string id ) : Task

Gets the asset with the specified identifier.

GetRequiredModIdentifiers ( ) : Task

Gets the identifiers of the required mods.

GetSubscriptions ( string authKey ) : Task

Gets the subscriptions of the authenticated user.

GetUserInfo ( string authKey ) : Task

Gets user info of the authenticated user.

ParkitectNexusAPI ( IWebsite website, INexusWebClientFactory webClientFactory, ILogger log ) : System

Initializes a new instance of the ParkitectNexusAPI class.

RegisterDownload ( string id ) : void

Registers a download for the asset with the specified identifier.

Method Details

GetAsset() public méthode

Gets the asset with the specified identifier.
public GetAsset ( string id ) : Task
id string The identifier.
Résultat Task

GetRequiredModIdentifiers() public méthode

Gets the identifiers of the required mods.
public GetRequiredModIdentifiers ( ) : Task
Résultat Task

GetSubscriptions() public méthode

Gets the subscriptions of the authenticated user.
public GetSubscriptions ( string authKey ) : Task
authKey string The authentication key.
Résultat Task

GetUserInfo() public méthode

Gets user info of the authenticated user.
public GetUserInfo ( string authKey ) : Task
authKey string The authentication key.
Résultat Task

ParkitectNexusAPI() public méthode

Initializes a new instance of the ParkitectNexusAPI class.
website or webClientFactory is null.
public ParkitectNexusAPI ( IWebsite website, INexusWebClientFactory webClientFactory, ILogger log ) : System
website IWebsite The website.
webClientFactory INexusWebClientFactory The web client factory.
log ILogger
Résultat System

RegisterDownload() public méthode

Registers a download for the asset with the specified identifier.
public RegisterDownload ( string id ) : void
id string The identifier.
Résultat void