Date | 2021-09-15 (1,181 days ago) |
---|---|
Downloads | 664 downloads |
NuGet | View on NuGet |
GitHub | View on GitHub |
Target Frameworks | .NET Standard 1.3 .NET Standard 2.0 .NET 4.5 .NET 4.6 .NET 4.7 |
#installation
">Installation#breaking
-changes">Breaking changes🅱️ The TwentyThreeService
class is now called TwentyThreeHttpService
(see 13a9d42
)
Across our API related packages, we're moving towards adding adding Http
to the service class to indicate the purpose.
🅱️ The TwentyThreePhotosRawEndpoint
class was moved to another namespace (see 13a9d42
)
The Skybrud.Social.TwentyThree.Endpoints.Raw
endpoint feels a bit redundant, so the class is now located in the Skybrud.Social.TwentyThree.Endpoints
namespace instead.
🅱️ The TwentyThreeGetPhotosResponse
class was renamed to TwentyThreePhotoListResponse
(see 13a9d42
)
Historically throughout our API related packages, names for response have included the HTTP verb used for the request to the API (eg GET
for GetPhotos
), but the name of the response classes should instead just reflect the type of content they contain (eg. TwentyThreePhotoListResponse
has a property with a TwentyThreePhotoList
, which then holds an array of TwentyThreePhoto
). This allows for re-use across methods that return the same type of content.
🅱️ Renamed HostName
property to Domain
to follow TwentyThree's own naming (see ed80f7a
)
TwentyThree accounts are set up using a custom domain, which TwentyThree in API responses refer to as "domains", which the property now reflects.
#other
-changes">Other changes🆕 Introduced new TwentyThreeException class to serve as a base class for TwentyThree related exceptions (see 29d3b58
)
While this package is currently only using the TwentyThreeHttpException
exception class, the TwentyThreeException
class now serves as a common base type for TwentyThreeHttpException
and potential new exception classes.
🆕 Added support for getting a list of spots (see e0eea0f
)
A new Spots endpoint has been introduced to support the spot-list method.
🆕 Added support for getting a list of albums (see 2e7a7db
)
A new Albums endpoint has been introduced to support the album-list method.
🆕 Added support for getting a list of players (see 2936fff
)
A new Players endpoint has been introduced to support the player-list method.
🆕 Introduced "TwentyThreeSite" class (see 614b280
)
Some responses may contain a reference to the site/account which is being accessed through the API. The site object may contain relevant information, so it's now accessible from list responses - eg TwentyThreeSpotList
.
🆕 Added support for OEmbed (see 12b2a16
and e42c4d4
)
TwentyThree supports getting OEmbed information about a video or photo, so this is now also supported by this package.