Skip to content

Changes from v0.3 to v0.4 ‐ InProgress

Chase Redmon edited this page Sep 21, 2023 · 1 revision

Breaking Changes

Renamed Methods

  • Renamed CatBoxClient.UploadMultipleImages to CatBoxClient.UploadFiles
  • Renamed CatBoxClient.UploadImage to CatBoxClient.UploadFilesAsStream
  • Renamed CatBoxClient.UploadMultipleUrls to CatBoxClient.UploadFilesAsUrl

Changed Method Type Parameters

  • Changed method parameter type on CatBoxClient.UploadFilesAsStream from StreamUploadRequest to IEnumerable<StreamUploadRequest>
  • Changed method parameter type on CatBoxClient.CreateAlbum from CreateAlbumRequest to RemoteCreateAlbumRequest
  • Changed method parameter type on CatBoxClient.ModifyAlbum from AlbumRequest to ModifyAlbumImagesRequest

New Features

  • Addition of CatBox Album API under the Catbox class.

CreateAlbumFromFiles - Accepts a CreateAlbumRequest. This represents a request to upload files to the CatBox API and create an album (that does not currently exist). When the album is created, we add those pictures to the album. UploadImagesToAlbum - Accepts a UploadToAlbumRequest. This represents a request to upload files to the CatBox API to an album that does already exists.

Bug Fixes

  • Added a null-check guard in the CatBoxClient.UploadFilesAsUrl(UrlUploadRequest urlUploadRequest) method, on the UrlUploadRequest.Files property to check and skip null URIs.
  • Added a null-check guard in the CatBoxClient.CreateAlbum(RemoteCreateAlbumRequest) method, on the RemoteCreateAlbumRequest.Files property to check for null links, to prevent NullReferenceExceptions.

Misc Changes

  • The EditAlbumRequest class has an Obsolete attribute added in an effort to communicate the severity and danger of using the EditAlbum API, without understanding the implications of how the API functions. Users can easily and irreversibly destroy / overwrite their albums.