Adds Default Documentation package for markdown documentation files.
This commit is contained in:
parent
60b259b33d
commit
c5a161adbf
GPG key ID:
3690B4E7364525D3
|
|
@ -38,6 +38,10 @@
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
|
<PackageReference Include="DefaultDocumentation" Version="0.8.2">
|
||||||
|
<PrivateAssets>all</PrivateAssets>
|
||||||
|
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
||||||
|
</PackageReference>
|
||||||
<PackageReference Include="System.Net.Http" Version="4.3.4" />
|
<PackageReference Include="System.Net.Http" Version="4.3.4" />
|
||||||
<PackageReference Include="System.Net.Http.Json" Version="7.0.0" />
|
<PackageReference Include="System.Net.Http.Json" Version="7.0.0" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.Artist.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.Artist.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Artist Property
|
||||||
|
|
||||||
|
The card art's artist.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Artist { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.CardUrl.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.CardUrl.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.CardUrl Property
|
||||||
|
|
||||||
|
The URL which leads to the original card URL data.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? CardUrl { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.ConvertedRetreatCost.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.ConvertedRetreatCost.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.ConvertedRetreatCost Property
|
||||||
|
|
||||||
|
The total number of energies needed to retreat.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Nullable<int> ConvertedRetreatCost { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.EvolvesFrom.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.EvolvesFrom.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.EvolvesFrom Property
|
||||||
|
|
||||||
|
If the card evolves from another card, this field will denote the name of the pre-evolution.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? EvolvesFrom { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
16
docs/JpnCardsPokemon.Sdk.Api.Card.Hp.md
Normal file
16
docs/JpnCardsPokemon.Sdk.Api.Card.Hp.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Hp Property
|
||||||
|
|
||||||
|
The amount of HP the card has.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int Hp { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
If the card does not have HP, the value will be -1.
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.Id.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.Id.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Id Property
|
||||||
|
|
||||||
|
The internal identification number that the card is given. Used to query for this single card.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int Id { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
17
docs/JpnCardsPokemon.Sdk.Api.Card.ImageUrl.md
Normal file
17
docs/JpnCardsPokemon.Sdk.Api.Card.ImageUrl.md
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.ImageUrl Property
|
||||||
|
|
||||||
|
The url pointing to the card's image.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? ImageUrl { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
If there is no card image, then this will instead point to
|
||||||
|
https://assets.tcgcollector.com/build/images/default-card-image.789f6232.png.
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.Name.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.Name.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Name Property
|
||||||
|
|
||||||
|
The name of the card.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Name { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.Number.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.Number.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Number Property
|
||||||
|
|
||||||
|
The sequential number of the card (applicable to Secret Rares).
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int Number { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
16
docs/JpnCardsPokemon.Sdk.Api.Card.Prices.md
Normal file
16
docs/JpnCardsPokemon.Sdk.Api.Card.Prices.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Prices Property
|
||||||
|
|
||||||
|
A list of known prices for this card.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Collections.Generic.IEnumerable<JpnCardsPokemon.Sdk.Api.CardPrice>? Prices { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
May contain entries from different sellers, versions and conditions.
|
||||||
14
docs/JpnCardsPokemon.Sdk.Api.Card.PrintedNumber.md
Normal file
14
docs/JpnCardsPokemon.Sdk.Api.Card.PrintedNumber.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.PrintedNumber Property
|
||||||
|
|
||||||
|
The number printed on the card. Will be the same as [Number](JpnCardsPokemon.Sdk.Api.Card.Number.md 'JpnCardsPokemon.Sdk.Api.Card.Number') almost always. Is relevant for
|
||||||
|
promotional cards, such as SWSH001.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? PrintedNumber { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.Rarity.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.Rarity.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Rarity Property
|
||||||
|
|
||||||
|
The rarity of the card.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Rarity { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.RetreatCosts.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.RetreatCosts.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.RetreatCosts Property
|
||||||
|
|
||||||
|
List of the energies required to retreat.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string[]? RetreatCosts { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.Rules.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.Rules.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Rules Property
|
||||||
|
|
||||||
|
Describes rules the card is bound to. Mainly for cards with a rule box and certain Trainers.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string[]? Rules { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')
|
||||||
16
docs/JpnCardsPokemon.Sdk.Api.Card.Set.md
Normal file
16
docs/JpnCardsPokemon.Sdk.Api.Card.Set.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Set Property
|
||||||
|
|
||||||
|
Reduced information about the set the card belongs to.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public JpnCardsPokemon.Sdk.Api.Set? Set { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
May contain basic information only. It´s recommended to fetch the fully [Set](JpnCardsPokemon.Sdk.Api.Card.Set.md 'JpnCardsPokemon.Sdk.Api.Card.Set') separately.
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Card.Subtypes.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Card.Subtypes.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Subtypes Property
|
||||||
|
|
||||||
|
The subsets that the card falls into. For example 'Single Strike Pokemon', 'Pokemon VMAX', etc.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string[]? Subtypes { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')
|
||||||
16
docs/JpnCardsPokemon.Sdk.Api.Card.Supertype.md
Normal file
16
docs/JpnCardsPokemon.Sdk.Api.Card.Supertype.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Supertype Property
|
||||||
|
|
||||||
|
The supertype the card is.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Supertype { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
Only possibilities are 'Pokemon', 'Trainer' or 'Energy'.
|
||||||
16
docs/JpnCardsPokemon.Sdk.Api.Card.Types.md
Normal file
16
docs/JpnCardsPokemon.Sdk.Api.Card.Types.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Types Property
|
||||||
|
|
||||||
|
The energy type of types the card is.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string[]? Types { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
Almost always will be a single value.
|
||||||
14
docs/JpnCardsPokemon.Sdk.Api.Card.Uuid.md
Normal file
14
docs/JpnCardsPokemon.Sdk.Api.Card.Uuid.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')
|
||||||
|
|
||||||
|
## Card.Uuid Property
|
||||||
|
|
||||||
|
A stable id for earch card. Output is an eight digit integer which is unique for each card. While the cards'
|
||||||
|
[Id](JpnCardsPokemon.Sdk.Api.Card.Id.md 'JpnCardsPokemon.Sdk.Api.Card.Id') may change over time, the uuid should always remain stable and constant.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int Uuid { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
34
docs/JpnCardsPokemon.Sdk.Api.Card.md
Normal file
34
docs/JpnCardsPokemon.Sdk.Api.Card.md
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api')
|
||||||
|
|
||||||
|
## Card Class
|
||||||
|
|
||||||
|
Represents a card object from the web api.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class Card
|
||||||
|
```
|
||||||
|
|
||||||
|
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Card
|
||||||
|
|
||||||
|
| Properties | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [Artist](JpnCardsPokemon.Sdk.Api.Card.Artist.md 'JpnCardsPokemon.Sdk.Api.Card.Artist') | The card art's artist. |
|
||||||
|
| [CardUrl](JpnCardsPokemon.Sdk.Api.Card.CardUrl.md 'JpnCardsPokemon.Sdk.Api.Card.CardUrl') | The URL which leads to the original card URL data. |
|
||||||
|
| [ConvertedRetreatCost](JpnCardsPokemon.Sdk.Api.Card.ConvertedRetreatCost.md 'JpnCardsPokemon.Sdk.Api.Card.ConvertedRetreatCost') | The total number of energies needed to retreat. |
|
||||||
|
| [EvolvesFrom](JpnCardsPokemon.Sdk.Api.Card.EvolvesFrom.md 'JpnCardsPokemon.Sdk.Api.Card.EvolvesFrom') | If the card evolves from another card, this field will denote the name of the pre-evolution. |
|
||||||
|
| [Hp](JpnCardsPokemon.Sdk.Api.Card.Hp.md 'JpnCardsPokemon.Sdk.Api.Card.Hp') | The amount of HP the card has. |
|
||||||
|
| [Id](JpnCardsPokemon.Sdk.Api.Card.Id.md 'JpnCardsPokemon.Sdk.Api.Card.Id') | The internal identification number that the card is given. Used to query for this single card. |
|
||||||
|
| [ImageUrl](JpnCardsPokemon.Sdk.Api.Card.ImageUrl.md 'JpnCardsPokemon.Sdk.Api.Card.ImageUrl') | The url pointing to the card's image. |
|
||||||
|
| [Name](JpnCardsPokemon.Sdk.Api.Card.Name.md 'JpnCardsPokemon.Sdk.Api.Card.Name') | The name of the card. |
|
||||||
|
| [Number](JpnCardsPokemon.Sdk.Api.Card.Number.md 'JpnCardsPokemon.Sdk.Api.Card.Number') | The sequential number of the card (applicable to Secret Rares). |
|
||||||
|
| [Prices](JpnCardsPokemon.Sdk.Api.Card.Prices.md 'JpnCardsPokemon.Sdk.Api.Card.Prices') | A list of known prices for this card. |
|
||||||
|
| [PrintedNumber](JpnCardsPokemon.Sdk.Api.Card.PrintedNumber.md 'JpnCardsPokemon.Sdk.Api.Card.PrintedNumber') | The number printed on the card. Will be the same as [Number](JpnCardsPokemon.Sdk.Api.Card.Number.md 'JpnCardsPokemon.Sdk.Api.Card.Number') almost always. Is relevant for<br/>promotional cards, such as SWSH001. |
|
||||||
|
| [Rarity](JpnCardsPokemon.Sdk.Api.Card.Rarity.md 'JpnCardsPokemon.Sdk.Api.Card.Rarity') | The rarity of the card. |
|
||||||
|
| [RetreatCosts](JpnCardsPokemon.Sdk.Api.Card.RetreatCosts.md 'JpnCardsPokemon.Sdk.Api.Card.RetreatCosts') | List of the energies required to retreat. |
|
||||||
|
| [Rules](JpnCardsPokemon.Sdk.Api.Card.Rules.md 'JpnCardsPokemon.Sdk.Api.Card.Rules') | Describes rules the card is bound to. Mainly for cards with a rule box and certain Trainers. |
|
||||||
|
| [Set](JpnCardsPokemon.Sdk.Api.Card.Set.md 'JpnCardsPokemon.Sdk.Api.Card.Set') | Reduced information about the set the card belongs to. |
|
||||||
|
| [Subtypes](JpnCardsPokemon.Sdk.Api.Card.Subtypes.md 'JpnCardsPokemon.Sdk.Api.Card.Subtypes') | The subsets that the card falls into. For example 'Single Strike Pokemon', 'Pokemon VMAX', etc. |
|
||||||
|
| [Supertype](JpnCardsPokemon.Sdk.Api.Card.Supertype.md 'JpnCardsPokemon.Sdk.Api.Card.Supertype') | The supertype the card is. |
|
||||||
|
| [Types](JpnCardsPokemon.Sdk.Api.Card.Types.md 'JpnCardsPokemon.Sdk.Api.Card.Types') | The energy type of types the card is. |
|
||||||
|
| [Uuid](JpnCardsPokemon.Sdk.Api.Card.Uuid.md 'JpnCardsPokemon.Sdk.Api.Card.Uuid') | A stable id for earch card. Output is an eight digit integer which is unique for each card. While the cards'<br/>[Id](JpnCardsPokemon.Sdk.Api.Card.Id.md 'JpnCardsPokemon.Sdk.Api.Card.Id') may change over time, the uuid should always remain stable and constant. |
|
||||||
14
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Condition.md
Normal file
14
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Condition.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice')
|
||||||
|
|
||||||
|
## CardPrice.Condition Property
|
||||||
|
|
||||||
|
Specifies the card condition. Often will be a rating in format of 'A+', 'A', etc. but also can be 'NM' or other
|
||||||
|
similar descriptive strings.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Condition { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
16
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Currency.md
Normal file
16
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Currency.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice')
|
||||||
|
|
||||||
|
## CardPrice.Currency Property
|
||||||
|
|
||||||
|
The currency used for the [Price](JpnCardsPokemon.Sdk.Api.CardPrice.Price.md 'JpnCardsPokemon.Sdk.Api.CardPrice.Price').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Currency { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
Almost always will be 'JYP' for Japanese Yen.
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.CardPrice.ListingUrl.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.CardPrice.ListingUrl.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice')
|
||||||
|
|
||||||
|
## CardPrice.ListingUrl Property
|
||||||
|
|
||||||
|
An URL to the listing.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? ListingUrl { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Price.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Price.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice')
|
||||||
|
|
||||||
|
## CardPrice.Price Property
|
||||||
|
|
||||||
|
The actual price for the specified version and condition.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public decimal Price { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Decimal](https://docs.microsoft.com/en-us/dotnet/api/System.Decimal 'System.Decimal')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Seller.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Seller.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice')
|
||||||
|
|
||||||
|
## CardPrice.Seller Property
|
||||||
|
|
||||||
|
Name of the seller who is listing the card.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Seller { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.CardPrice.UpdatedDate.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.CardPrice.UpdatedDate.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice')
|
||||||
|
|
||||||
|
## CardPrice.UpdatedDate Property
|
||||||
|
|
||||||
|
Date when the price information was updated last.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Nullable<System.DateTime> UpdatedDate { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.DateTime](https://docs.microsoft.com/en-us/dotnet/api/System.DateTime 'System.DateTime')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')
|
||||||
14
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Version.md
Normal file
14
docs/JpnCardsPokemon.Sdk.Api.CardPrice.Version.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice')
|
||||||
|
|
||||||
|
## CardPrice.Version Property
|
||||||
|
|
||||||
|
Specifies the card version. Almost always will be 'Regular' but may contain other versions like 'Reverse Holo',
|
||||||
|
etc.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Version { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
22
docs/JpnCardsPokemon.Sdk.Api.CardPrice.md
Normal file
22
docs/JpnCardsPokemon.Sdk.Api.CardPrice.md
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api')
|
||||||
|
|
||||||
|
## CardPrice Class
|
||||||
|
|
||||||
|
Contains information about card price.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class CardPrice
|
||||||
|
```
|
||||||
|
|
||||||
|
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 CardPrice
|
||||||
|
|
||||||
|
| Properties | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [Condition](JpnCardsPokemon.Sdk.Api.CardPrice.Condition.md 'JpnCardsPokemon.Sdk.Api.CardPrice.Condition') | Specifies the card condition. Often will be a rating in format of 'A+', 'A', etc. but also can be 'NM' or other<br/>similar descriptive strings. |
|
||||||
|
| [Currency](JpnCardsPokemon.Sdk.Api.CardPrice.Currency.md 'JpnCardsPokemon.Sdk.Api.CardPrice.Currency') | The currency used for the [Price](JpnCardsPokemon.Sdk.Api.CardPrice.Price.md 'JpnCardsPokemon.Sdk.Api.CardPrice.Price'). |
|
||||||
|
| [ListingUrl](JpnCardsPokemon.Sdk.Api.CardPrice.ListingUrl.md 'JpnCardsPokemon.Sdk.Api.CardPrice.ListingUrl') | An URL to the listing. |
|
||||||
|
| [Price](JpnCardsPokemon.Sdk.Api.CardPrice.Price.md 'JpnCardsPokemon.Sdk.Api.CardPrice.Price') | The actual price for the specified version and condition. |
|
||||||
|
| [Seller](JpnCardsPokemon.Sdk.Api.CardPrice.Seller.md 'JpnCardsPokemon.Sdk.Api.CardPrice.Seller') | Name of the seller who is listing the card. |
|
||||||
|
| [UpdatedDate](JpnCardsPokemon.Sdk.Api.CardPrice.UpdatedDate.md 'JpnCardsPokemon.Sdk.Api.CardPrice.UpdatedDate') | Date when the price information was updated last. |
|
||||||
|
| [Version](JpnCardsPokemon.Sdk.Api.CardPrice.Version.md 'JpnCardsPokemon.Sdk.Api.CardPrice.Version') | Specifies the card version. Almost always will be 'Regular' but may contain other versions like 'Reverse Holo',<br/>etc. |
|
||||||
14
docs/JpnCardsPokemon.Sdk.Api.Set.Id.md
Normal file
14
docs/JpnCardsPokemon.Sdk.Api.Set.Id.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.Id Property
|
||||||
|
|
||||||
|
The internal identification number that the set is given. Used to query for information about this single set or
|
||||||
|
for all cards in this single set.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int Id { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Set.ImageUrl.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Set.ImageUrl.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.ImageUrl Property
|
||||||
|
|
||||||
|
A URL to the official set's image.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? ImageUrl { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Set.Language.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Set.Language.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.Language Property
|
||||||
|
|
||||||
|
The language that the cards in the set are printed in.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Language { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Set.Name.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Set.Name.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.Name Property
|
||||||
|
|
||||||
|
The name of the set.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Name { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
14
docs/JpnCardsPokemon.Sdk.Api.Set.PrintedCardCount.md
Normal file
14
docs/JpnCardsPokemon.Sdk.Api.Set.PrintedCardCount.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.PrintedCardCount Property
|
||||||
|
|
||||||
|
The number of cards in the set that is printed on the card. This differs from the set's
|
||||||
|
[TotalCardCount](JpnCardsPokemon.Sdk.Api.Set.TotalCardCount.md 'JpnCardsPokemon.Sdk.Api.Set.TotalCardCount') in sets with Secret Rare cards.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int PrintedCardCount { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Set.SetCode.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Set.SetCode.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.SetCode Property
|
||||||
|
|
||||||
|
The shorthand code for the set.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? SetCode { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Set.SourceUrl.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Set.SourceUrl.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.SourceUrl Property
|
||||||
|
|
||||||
|
The URL to a page which has more information about the set.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? SourceUrl { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Set.TotalCardCount.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Set.TotalCardCount.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.TotalCardCount Property
|
||||||
|
|
||||||
|
The total number of cards in the set.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int TotalCardCount { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
14
docs/JpnCardsPokemon.Sdk.Api.Set.Uuid.md
Normal file
14
docs/JpnCardsPokemon.Sdk.Api.Set.Uuid.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.Uuid Property
|
||||||
|
|
||||||
|
A stable id for earch card. Output is an eight digit integer which is unique for each card. While the cards'
|
||||||
|
[Id](JpnCardsPokemon.Sdk.Api.Set.Id.md 'JpnCardsPokemon.Sdk.Api.Set.Id') may change over time, the uuid should always remain stable and constant.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int Uuid { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
13
docs/JpnCardsPokemon.Sdk.Api.Set.Year.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Api.Set.Year.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api').[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')
|
||||||
|
|
||||||
|
## Set.Year Property
|
||||||
|
|
||||||
|
The year the set was released.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int Year { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
25
docs/JpnCardsPokemon.Sdk.Api.Set.md
Normal file
25
docs/JpnCardsPokemon.Sdk.Api.Set.md
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api')
|
||||||
|
|
||||||
|
## Set Class
|
||||||
|
|
||||||
|
Represents a set object from the web api.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class Set
|
||||||
|
```
|
||||||
|
|
||||||
|
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Set
|
||||||
|
|
||||||
|
| Properties | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [Id](JpnCardsPokemon.Sdk.Api.Set.Id.md 'JpnCardsPokemon.Sdk.Api.Set.Id') | The internal identification number that the set is given. Used to query for information about this single set or<br/>for all cards in this single set. |
|
||||||
|
| [ImageUrl](JpnCardsPokemon.Sdk.Api.Set.ImageUrl.md 'JpnCardsPokemon.Sdk.Api.Set.ImageUrl') | A URL to the official set's image. |
|
||||||
|
| [Language](JpnCardsPokemon.Sdk.Api.Set.Language.md 'JpnCardsPokemon.Sdk.Api.Set.Language') | The language that the cards in the set are printed in. |
|
||||||
|
| [Name](JpnCardsPokemon.Sdk.Api.Set.Name.md 'JpnCardsPokemon.Sdk.Api.Set.Name') | The name of the set. |
|
||||||
|
| [PrintedCardCount](JpnCardsPokemon.Sdk.Api.Set.PrintedCardCount.md 'JpnCardsPokemon.Sdk.Api.Set.PrintedCardCount') | The number of cards in the set that is printed on the card. This differs from the set's<br/>[TotalCardCount](JpnCardsPokemon.Sdk.Api.Set.TotalCardCount.md 'JpnCardsPokemon.Sdk.Api.Set.TotalCardCount') in sets with Secret Rare cards. |
|
||||||
|
| [SetCode](JpnCardsPokemon.Sdk.Api.Set.SetCode.md 'JpnCardsPokemon.Sdk.Api.Set.SetCode') | The shorthand code for the set. |
|
||||||
|
| [SourceUrl](JpnCardsPokemon.Sdk.Api.Set.SourceUrl.md 'JpnCardsPokemon.Sdk.Api.Set.SourceUrl') | The URL to a page which has more information about the set. |
|
||||||
|
| [TotalCardCount](JpnCardsPokemon.Sdk.Api.Set.TotalCardCount.md 'JpnCardsPokemon.Sdk.Api.Set.TotalCardCount') | The total number of cards in the set. |
|
||||||
|
| [Uuid](JpnCardsPokemon.Sdk.Api.Set.Uuid.md 'JpnCardsPokemon.Sdk.Api.Set.Uuid') | A stable id for earch card. Output is an eight digit integer which is unique for each card. While the cards'<br/>[Id](JpnCardsPokemon.Sdk.Api.Set.Id.md 'JpnCardsPokemon.Sdk.Api.Set.Id') may change over time, the uuid should always remain stable and constant. |
|
||||||
|
| [Year](JpnCardsPokemon.Sdk.Api.Set.Year.md 'JpnCardsPokemon.Sdk.Api.Set.Year') | The year the set was released. |
|
||||||
9
docs/JpnCardsPokemon.Sdk.Api.md
Normal file
9
docs/JpnCardsPokemon.Sdk.Api.md
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
|
||||||
|
## JpnCardsPokemon.Sdk.Api Namespace
|
||||||
|
|
||||||
|
| Classes | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card') | Represents a card object from the web api. |
|
||||||
|
| [CardPrice](JpnCardsPokemon.Sdk.Api.CardPrice.md 'JpnCardsPokemon.Sdk.Api.CardPrice') | Contains information about card price. |
|
||||||
|
| [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set') | Represents a set object from the web api. |
|
||||||
10
docs/JpnCardsPokemon.Sdk.Client.ApiClient.ApiClient().md
Normal file
10
docs/JpnCardsPokemon.Sdk.Client.ApiClient.ApiClient().md
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client').[ApiClient](JpnCardsPokemon.Sdk.Client.ApiClient.md 'JpnCardsPokemon.Sdk.Client.ApiClient')
|
||||||
|
|
||||||
|
## ApiClient() Constructor
|
||||||
|
|
||||||
|
Creates a new instance of the ApiClient.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public ApiClient();
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client').[ApiClient](JpnCardsPokemon.Sdk.Client.ApiClient.md 'JpnCardsPokemon.Sdk.Client.ApiClient')
|
||||||
|
|
||||||
|
## ApiClient(HttpClient) Constructor
|
||||||
|
|
||||||
|
Creates a new instance of the ApiClient.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public ApiClient(System.Net.Http.HttpClient client);
|
||||||
|
```
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<a name='JpnCardsPokemon.Sdk.Client.ApiClient.ApiClient(System.Net.Http.HttpClient).client'></a>
|
||||||
|
|
||||||
|
`client` [System.Net.Http.HttpClient](https://docs.microsoft.com/en-us/dotnet/api/System.Net.Http.HttpClient 'System.Net.Http.HttpClient')
|
||||||
|
|
||||||
|
Can pass a http client to use.
|
||||||
|
|
@ -0,0 +1,24 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client').[ApiClient](JpnCardsPokemon.Sdk.Client.ApiClient.md 'JpnCardsPokemon.Sdk.Client.ApiClient')
|
||||||
|
|
||||||
|
## ApiClient.FetchCardsAsync(IQueryFilterBuilder) Method
|
||||||
|
|
||||||
|
Fetches [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card') from a search query.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<JpnCardsPokemon.Sdk.Api.Card>?> FetchCardsAsync(JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder filterBuilder);
|
||||||
|
```
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<a name='JpnCardsPokemon.Sdk.Client.ApiClient.FetchCardsAsync(JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder).filterBuilder'></a>
|
||||||
|
|
||||||
|
`filterBuilder` [IQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder')
|
||||||
|
|
||||||
|
Configured query builder to generate the search query.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')
|
||||||
|
Returns an enumerable of [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card') matching the [query](https://docs.microsoft.com/en-us/dotnet/api/query 'query').
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
At least one filter must be specified.
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client').[ApiClient](JpnCardsPokemon.Sdk.Client.ApiClient.md 'JpnCardsPokemon.Sdk.Client.ApiClient')
|
||||||
|
|
||||||
|
## ApiClient.FetchCardsAsync(string) Method
|
||||||
|
|
||||||
|
Fetches [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card') from a search query.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<JpnCardsPokemon.Sdk.Api.Card>> FetchCardsAsync(string query);
|
||||||
|
```
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<a name='JpnCardsPokemon.Sdk.Client.ApiClient.FetchCardsAsync(string).query'></a>
|
||||||
|
|
||||||
|
`query` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
||||||
|
The search query.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')
|
||||||
|
Returns an enumerable of [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card') matching the [query](https://docs.microsoft.com/en-us/dotnet/api/query 'query').
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception')
|
||||||
|
Thrown if the [query](https://docs.microsoft.com/en-us/dotnet/api/query 'query') is empty.
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
At least one filter query must be specified. More information about the query format can be found at
|
||||||
|
https://jpn-cards-site.readthedocs.io/en/latest/api_docs/pokemon/v2/v2_api/#card-queries.
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client').[ApiClient](JpnCardsPokemon.Sdk.Client.ApiClient.md 'JpnCardsPokemon.Sdk.Client.ApiClient')
|
||||||
|
|
||||||
|
## ApiClient.FetchSetById(int) Method
|
||||||
|
|
||||||
|
Fetches a [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set') by its id.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Threading.Tasks.Task<JpnCardsPokemon.Sdk.Api.Set?> FetchSetById(int id);
|
||||||
|
```
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<a name='JpnCardsPokemon.Sdk.Client.ApiClient.FetchSetById(int).id'></a>
|
||||||
|
|
||||||
|
`id` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
|
|
||||||
|
Id of the [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set') to fetch.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')
|
||||||
|
If existing returns the matching [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set').
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client').[ApiClient](JpnCardsPokemon.Sdk.Client.ApiClient.md 'JpnCardsPokemon.Sdk.Client.ApiClient')
|
||||||
|
|
||||||
|
## ApiClient.FetchSetByUuid(int) Method
|
||||||
|
|
||||||
|
Fetches a [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set') by its uuid.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Threading.Tasks.Task<JpnCardsPokemon.Sdk.Api.Set?> FetchSetByUuid(int uuid);
|
||||||
|
```
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<a name='JpnCardsPokemon.Sdk.Client.ApiClient.FetchSetByUuid(int).uuid'></a>
|
||||||
|
|
||||||
|
`uuid` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
|
||||||
|
|
||||||
|
Uuid of the [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set') to fetch.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')
|
||||||
|
If existing returns the matching [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set').
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client').[ApiClient](JpnCardsPokemon.Sdk.Client.ApiClient.md 'JpnCardsPokemon.Sdk.Client.ApiClient')
|
||||||
|
|
||||||
|
## ApiClient.FetchSetsAsync() Method
|
||||||
|
|
||||||
|
Fetches all [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<JpnCardsPokemon.Sdk.Api.Set>> FetchSetsAsync();
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')
|
||||||
|
Returns an enumerable containing all [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set').
|
||||||
25
docs/JpnCardsPokemon.Sdk.Client.ApiClient.md
Normal file
25
docs/JpnCardsPokemon.Sdk.Client.ApiClient.md
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client')
|
||||||
|
|
||||||
|
## ApiClient Class
|
||||||
|
|
||||||
|
A client to interact with the web api.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class ApiClient
|
||||||
|
```
|
||||||
|
|
||||||
|
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ApiClient
|
||||||
|
|
||||||
|
| Constructors | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [ApiClient()](JpnCardsPokemon.Sdk.Client.ApiClient.ApiClient().md 'JpnCardsPokemon.Sdk.Client.ApiClient.ApiClient()') | Creates a new instance of the ApiClient. |
|
||||||
|
| [ApiClient(HttpClient)](JpnCardsPokemon.Sdk.Client.ApiClient.ApiClient(System.Net.Http.HttpClient).md 'JpnCardsPokemon.Sdk.Client.ApiClient.ApiClient(System.Net.Http.HttpClient)') | Creates a new instance of the ApiClient. |
|
||||||
|
|
||||||
|
| Methods | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [FetchCardsAsync(IQueryFilterBuilder)](JpnCardsPokemon.Sdk.Client.ApiClient.FetchCardsAsync(JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder).md 'JpnCardsPokemon.Sdk.Client.ApiClient.FetchCardsAsync(JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder)') | Fetches [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card') from a search query. |
|
||||||
|
| [FetchCardsAsync(string)](JpnCardsPokemon.Sdk.Client.ApiClient.FetchCardsAsync(string).md 'JpnCardsPokemon.Sdk.Client.ApiClient.FetchCardsAsync(string)') | Fetches [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card') from a search query. |
|
||||||
|
| [FetchSetById(int)](JpnCardsPokemon.Sdk.Client.ApiClient.FetchSetById(int).md 'JpnCardsPokemon.Sdk.Client.ApiClient.FetchSetById(int)') | Fetches a [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set') by its id. |
|
||||||
|
| [FetchSetByUuid(int)](JpnCardsPokemon.Sdk.Client.ApiClient.FetchSetByUuid(int).md 'JpnCardsPokemon.Sdk.Client.ApiClient.FetchSetByUuid(int)') | Fetches a [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set') by its uuid. |
|
||||||
|
| [FetchSetsAsync()](JpnCardsPokemon.Sdk.Client.ApiClient.FetchSetsAsync().md 'JpnCardsPokemon.Sdk.Client.ApiClient.FetchSetsAsync()') | Fetches all [Set](JpnCardsPokemon.Sdk.Api.Set.md 'JpnCardsPokemon.Sdk.Api.Set'). |
|
||||||
7
docs/JpnCardsPokemon.Sdk.Client.md
Normal file
7
docs/JpnCardsPokemon.Sdk.Client.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
|
||||||
|
## JpnCardsPokemon.Sdk.Client Namespace
|
||||||
|
|
||||||
|
| Classes | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [ApiClient](JpnCardsPokemon.Sdk.Client.ApiClient.md 'JpnCardsPokemon.Sdk.Client.ApiClient') | A client to interact with the web api. |
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[AttributedQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder')
|
||||||
|
|
||||||
|
## AttributedQueryFilterBuilder.BuildQueryString() Method
|
||||||
|
|
||||||
|
Builds the query filter to use for the api request.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string BuildQueryString();
|
||||||
|
```
|
||||||
|
|
||||||
|
Implements [BuildQueryString()](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.BuildQueryString().md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.BuildQueryString()')
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
Returns the built query filter.
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter')
|
||||||
|
|
||||||
|
## AttributedQueryFilterBuilder Class
|
||||||
|
|
||||||
|
Abstract Implementation of an [IQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder') which builts the filter string based on
|
||||||
|
[QueryFilterNameAttribute](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute') attributed properties.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public abstract class AttributedQueryFilterBuilder :
|
||||||
|
JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder
|
||||||
|
```
|
||||||
|
|
||||||
|
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AttributedQueryFilterBuilder
|
||||||
|
|
||||||
|
Derived
|
||||||
|
↳ [CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
Implements [IQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder')
|
||||||
|
|
||||||
|
| Methods | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [BuildQueryString()](JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder.BuildQueryString().md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder.BuildQueryString()') | Builds the query filter to use for the api request. |
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.Artist Property
|
||||||
|
|
||||||
|
Sets a filter for the [Artist](JpnCardsPokemon.Sdk.Api.Card.Artist.md 'JpnCardsPokemon.Sdk.Api.Card.Artist').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Artist { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
Must match the full name.
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.Id Property
|
||||||
|
|
||||||
|
Sets a filter for the [Id](JpnCardsPokemon.Sdk.Api.Card.Id.md 'JpnCardsPokemon.Sdk.Api.Card.Id').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Nullable<int> Id { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.Name Property
|
||||||
|
|
||||||
|
Sets a filter for the [Name](JpnCardsPokemon.Sdk.Api.Card.Name.md 'JpnCardsPokemon.Sdk.Api.Card.Name').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Name { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
||||||
|
### Remarks
|
||||||
|
Must match the full name.
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.PrintedNumber Property
|
||||||
|
|
||||||
|
Sets a filter for the [PrintedNumber](JpnCardsPokemon.Sdk.Api.Card.PrintedNumber.md 'JpnCardsPokemon.Sdk.Api.Card.PrintedNumber').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? PrintedNumber { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.SetCode Property
|
||||||
|
|
||||||
|
Sets a filter for the [Set](JpnCardsPokemon.Sdk.Api.Card.Set.md 'JpnCardsPokemon.Sdk.Api.Card.Set') by [SetCode](JpnCardsPokemon.Sdk.Api.Set.SetCode.md 'JpnCardsPokemon.Sdk.Api.Set.SetCode').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? SetCode { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.SetId Property
|
||||||
|
|
||||||
|
Sets a filter for the [Set](JpnCardsPokemon.Sdk.Api.Card.Set.md 'JpnCardsPokemon.Sdk.Api.Card.Set') by [Id](JpnCardsPokemon.Sdk.Api.Set.Id.md 'JpnCardsPokemon.Sdk.Api.Set.Id').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Nullable<int> SetId { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.Subtype Property
|
||||||
|
|
||||||
|
Sets a filter for the [Subtypes](JpnCardsPokemon.Sdk.Api.Card.Subtypes.md 'JpnCardsPokemon.Sdk.Api.Card.Subtypes').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Subtype { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.Type Property
|
||||||
|
|
||||||
|
Sets a filter for the [Types](JpnCardsPokemon.Sdk.Api.Card.Types.md 'JpnCardsPokemon.Sdk.Api.Card.Types').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? Type { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder.Uuid Property
|
||||||
|
|
||||||
|
Sets a filter for the [Uuid](JpnCardsPokemon.Sdk.Api.Card.Uuid.md 'JpnCardsPokemon.Sdk.Api.Card.Uuid').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public System.Nullable<int> Uuid { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')
|
||||||
|
|
@ -0,0 +1,24 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter')
|
||||||
|
|
||||||
|
## CardQueryFilterBuilder Class
|
||||||
|
|
||||||
|
[IQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder') for [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class CardQueryFilterBuilder : JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder
|
||||||
|
```
|
||||||
|
|
||||||
|
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AttributedQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder') 🡒 CardQueryFilterBuilder
|
||||||
|
|
||||||
|
| Properties | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [Artist](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Artist.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Artist') | Sets a filter for the [Artist](JpnCardsPokemon.Sdk.Api.Card.Artist.md 'JpnCardsPokemon.Sdk.Api.Card.Artist'). |
|
||||||
|
| [Id](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Id.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Id') | Sets a filter for the [Id](JpnCardsPokemon.Sdk.Api.Card.Id.md 'JpnCardsPokemon.Sdk.Api.Card.Id'). |
|
||||||
|
| [Name](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Name.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Name') | Sets a filter for the [Name](JpnCardsPokemon.Sdk.Api.Card.Name.md 'JpnCardsPokemon.Sdk.Api.Card.Name'). |
|
||||||
|
| [PrintedNumber](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.PrintedNumber.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.PrintedNumber') | Sets a filter for the [PrintedNumber](JpnCardsPokemon.Sdk.Api.Card.PrintedNumber.md 'JpnCardsPokemon.Sdk.Api.Card.PrintedNumber'). |
|
||||||
|
| [SetCode](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.SetCode.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.SetCode') | Sets a filter for the [Set](JpnCardsPokemon.Sdk.Api.Card.Set.md 'JpnCardsPokemon.Sdk.Api.Card.Set') by [SetCode](JpnCardsPokemon.Sdk.Api.Set.SetCode.md 'JpnCardsPokemon.Sdk.Api.Set.SetCode'). |
|
||||||
|
| [SetId](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.SetId.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.SetId') | Sets a filter for the [Set](JpnCardsPokemon.Sdk.Api.Card.Set.md 'JpnCardsPokemon.Sdk.Api.Card.Set') by [Id](JpnCardsPokemon.Sdk.Api.Set.Id.md 'JpnCardsPokemon.Sdk.Api.Set.Id'). |
|
||||||
|
| [Subtype](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Subtype.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Subtype') | Sets a filter for the [Subtypes](JpnCardsPokemon.Sdk.Api.Card.Subtypes.md 'JpnCardsPokemon.Sdk.Api.Card.Subtypes'). |
|
||||||
|
| [Type](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Type.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Type') | Sets a filter for the [Types](JpnCardsPokemon.Sdk.Api.Card.Types.md 'JpnCardsPokemon.Sdk.Api.Card.Types'). |
|
||||||
|
| [Uuid](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Uuid.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.Uuid') | Sets a filter for the [Uuid](JpnCardsPokemon.Sdk.Api.Card.Uuid.md 'JpnCardsPokemon.Sdk.Api.Card.Uuid'). |
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[IQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder')
|
||||||
|
|
||||||
|
## IQueryFilterBuilder.BuildQueryString() Method
|
||||||
|
|
||||||
|
Builds the query filter to use for the api request.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
string BuildQueryString();
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
Returns the built query filter.
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter')
|
||||||
|
|
||||||
|
## IQueryFilterBuilder Interface
|
||||||
|
|
||||||
|
Defines an interface for a filter builder.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public interface IQueryFilterBuilder
|
||||||
|
```
|
||||||
|
|
||||||
|
Derived
|
||||||
|
↳ [AttributedQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder')
|
||||||
|
|
||||||
|
| Methods | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [BuildQueryString()](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.BuildQueryString().md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.BuildQueryString()') | Builds the query filter to use for the api request. |
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[QueryFilterNameAttribute](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute')
|
||||||
|
|
||||||
|
## QueryFilterNameAttribute.ParamName Property
|
||||||
|
|
||||||
|
Filter name for the web api.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string? ParamName { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[QueryFilterNameAttribute](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute')
|
||||||
|
|
||||||
|
## QueryFilterNameAttribute() Constructor
|
||||||
|
|
||||||
|
Creates a new query filter attribute.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public QueryFilterNameAttribute();
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter').[QueryFilterNameAttribute](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute')
|
||||||
|
|
||||||
|
## QueryFilterNameAttribute(string) Constructor
|
||||||
|
|
||||||
|
Creates a new query filter attribute with a custom filter name.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public QueryFilterNameAttribute(string? paramName);
|
||||||
|
```
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<a name='JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.QueryFilterNameAttribute(string).paramName'></a>
|
||||||
|
|
||||||
|
`paramName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
|
||||||
|
|
||||||
|
Custom filter name for the web request.
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
### [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter')
|
||||||
|
|
||||||
|
## QueryFilterNameAttribute Class
|
||||||
|
|
||||||
|
Attribute which can be used to mark a property as a filter for the [AttributedQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder').
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class QueryFilterNameAttribute : System.Attribute
|
||||||
|
```
|
||||||
|
|
||||||
|
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Attribute](https://docs.microsoft.com/en-us/dotnet/api/System.Attribute 'System.Attribute') 🡒 QueryFilterNameAttribute
|
||||||
|
|
||||||
|
| Constructors | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [QueryFilterNameAttribute()](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.QueryFilterNameAttribute().md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.QueryFilterNameAttribute()') | Creates a new query filter attribute. |
|
||||||
|
| [QueryFilterNameAttribute(string)](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.QueryFilterNameAttribute(string).md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.QueryFilterNameAttribute(string)') | Creates a new query filter attribute with a custom filter name. |
|
||||||
|
|
||||||
|
| Properties | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [ParamName](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.ParamName.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.ParamName') | Filter name for the web api. |
|
||||||
13
docs/JpnCardsPokemon.Sdk.Utils.QueryFilter.md
Normal file
13
docs/JpnCardsPokemon.Sdk.Utils.QueryFilter.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
|
||||||
|
## JpnCardsPokemon.Sdk.Utils.QueryFilter Namespace
|
||||||
|
|
||||||
|
| Classes | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [AttributedQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder') | Abstract Implementation of an [IQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder') which builts the filter string based on<br/>[QueryFilterNameAttribute](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute') attributed properties. |
|
||||||
|
| [CardQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.CardQueryFilterBuilder') | [IQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder') for [Card](JpnCardsPokemon.Sdk.Api.Card.md 'JpnCardsPokemon.Sdk.Api.Card'). |
|
||||||
|
| [QueryFilterNameAttribute](JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.QueryFilterNameAttribute') | Attribute which can be used to mark a property as a filter for the [AttributedQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.AttributedQueryFilterBuilder'). |
|
||||||
|
|
||||||
|
| Interfaces | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [IQueryFilterBuilder](JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter.IQueryFilterBuilder') | Defines an interface for a filter builder. |
|
||||||
9
docs/index.md
Normal file
9
docs/index.md
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
#### [JpnCardsPokemon.Sdk](index.md 'index')
|
||||||
|
|
||||||
|
## JpnCardsPokemon.Sdk Assembly
|
||||||
|
|
||||||
|
| Namespaces | |
|
||||||
|
| :--- | :--- |
|
||||||
|
| [JpnCardsPokemon.Sdk.Api](JpnCardsPokemon.Sdk.Api.md 'JpnCardsPokemon.Sdk.Api') | |
|
||||||
|
| [JpnCardsPokemon.Sdk.Client](JpnCardsPokemon.Sdk.Client.md 'JpnCardsPokemon.Sdk.Client') | |
|
||||||
|
| [JpnCardsPokemon.Sdk.Utils.QueryFilter](JpnCardsPokemon.Sdk.Utils.QueryFilter.md 'JpnCardsPokemon.Sdk.Utils.QueryFilter') | |
|
||||||
Loading…
Reference in a new issue