Class PVOutputClient
Implements
Inherited Members
Namespace: PVOutput.Net
Assembly: PVOutput.Net.dll
Syntax
public sealed class PVOutputClient : IPVOutputClient
Constructors
| Improve this Doc View SourcePVOutputClient(PVOutputClientOptions, ILogger<PVOutputClient>)
Creates a new PVOutputClient, with a ILogger attached.
Declaration
public PVOutputClient(PVOutputClientOptions options, ILogger<PVOutputClient> logger)
Parameters
Type | Name | Description |
---|---|---|
PVOutputClientOptions | options | Options to use for the client, containing the ApiKey and Id of the owned system. |
ILogger<PVOutputClient> | logger | The ILogger implementation, used for logging purposes. |
PVOutputClient(PVOutputClientOptions)
Creates a new PVOutputClient.
Declaration
public PVOutputClient(PVOutputClientOptions options)
Parameters
Type | Name | Description |
---|---|---|
PVOutputClientOptions | options | Options to use for the client, containing the ApiKey and Id of the owned system. |
PVOutputClient(string, int, ILogger<PVOutputClient>)
Creates a new PVOutputClient, with a ILogger attached.
Declaration
public PVOutputClient(string apiKey, int ownedSystemId, ILogger<PVOutputClient> logger)
Parameters
Type | Name | Description |
---|---|---|
string | apiKey | ApiKey to use with authenticating. |
int | ownedSystemId | Id of the currently owned system used for authenticating. |
ILogger<PVOutputClient> | logger | The ILogger implementation, used for logging purposes. |
PVOutputClient(string, int)
Creates a new PVOutputClient.
Declaration
public PVOutputClient(string apiKey, int ownedSystemId)
Parameters
Type | Name | Description |
---|---|---|
string | apiKey | ApiKey to use with authenticating. |
int | ownedSystemId | Id of the currently owned system used for authenticating. |
Properties
| Improve this Doc View SourceApiKey
ApiKey to use with authenticating.
Declaration
public string ApiKey { get; set; }
Property Value
Type | Description |
---|---|
string |
Extended
The extended service.
See the official API information.
Declaration
public IExtendedService Extended { get; }
Property Value
Type | Description |
---|---|
IExtendedService |
Favourite
The favourite service.
See the official API information.
Declaration
public IFavouriteService Favourite { get; }
Property Value
Type | Description |
---|---|
IFavouriteService |
Insolation
The insolation service.
See the official API information.
Declaration
public IInsolationService Insolation { get; }
Property Value
Type | Description |
---|---|
IInsolationService |
Missing
The missing service.
See the official API information.
Declaration
public IMissingService Missing { get; }
Property Value
Type | Description |
---|---|
IMissingService |
Notification
The notification service
See the official API information.
Declaration
public INotificationService Notification { get; }
Property Value
Type | Description |
---|---|
INotificationService |
Output
The output service.
See the official API information.
Declaration
public IOutputService Output { get; }
Property Value
Type | Description |
---|---|
IOutputService |
OwnedSystemId
Id of the currently owned system used for authenticating.
Declaration
public int OwnedSystemId { get; set; }
Property Value
Type | Description |
---|---|
int |
Search
The search service
See the official API information.
Declaration
public ISearchService Search { get; }
Property Value
Type | Description |
---|---|
ISearchService |
Statistics
The statistic service.
See the official API information.
Declaration
public IStatisticsService Statistics { get; }
Property Value
Type | Description |
---|---|
IStatisticsService |
Status
The status service.
See the official API information.
Declaration
public IStatusService Status { get; }
Property Value
Type | Description |
---|---|
IStatusService |
Supply
The supply service.
See the official API information.
Declaration
public ISupplyService Supply { get; }
Property Value
Type | Description |
---|---|
ISupplyService |
System
The system service.
See the official API information.
Declaration
public ISystemService System { get; }
Property Value
Type | Description |
---|---|
ISystemService |
Team
The team service.
See the official API information.
Declaration
public ITeamService Team { get; }
Property Value
Type | Description |
---|---|
ITeamService |
ThrowResponseExceptions
Indicates whether or not the client should throw exceptions when the api returns errors.
Declaration
public bool ThrowResponseExceptions { get; set; }
Property Value
Type | Description |
---|---|
bool |