aboutsummaryrefslogtreecommitdiff
path: root/content/docs/mal2go/v4/user/anime/update-anime.md
diff options
context:
space:
mode:
authorVidhu Kant Sharma <vidhukant@vidhukant.xyz>2022-09-21 20:02:49 +0530
committerVidhu Kant Sharma <vidhukant@vidhukant.xyz>2022-09-21 20:02:49 +0530
commitfdd266052a6f64e67712a0bffdfca5469bef23c7 (patch)
tree147ed11cb4ff5f514ee6f1c11310cdb2a84ea611 /content/docs/mal2go/v4/user/anime/update-anime.md
parent451de26b401a992114eae377a9bcab74c6d92c58 (diff)
added MAL2Go/user/anime docs
Diffstat (limited to 'content/docs/mal2go/v4/user/anime/update-anime.md')
-rw-r--r--content/docs/mal2go/v4/user/anime/update-anime.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/content/docs/mal2go/v4/user/anime/update-anime.md b/content/docs/mal2go/v4/user/anime/update-anime.md
new file mode 100644
index 0000000..b2cfbce
--- /dev/null
+++ b/content/docs/mal2go/v4/user/anime/update-anime.md
@@ -0,0 +1,60 @@
+---
+title: "Update Anime"
+description: "Update every field of an anime"
+weight: 13
+---
+
+The `UpdateAnime` method combines all the other methods used to update any of the fields of an entry in the animelist.
+
+**Warning: This method will overwrite every field of the specified anime.
+If you don't specify a field it'd be set back to the default option.
+Use it with caution at your own risk.**
+
+- `id int` ID of the anime
+- `updateData `[`UpdateAnimeData`](/docs/mal2go/v4/user/anime/types/#mal2gouseranimeupdateanimedata)
+A struct containing all the fields that need to be updated. **If a field is missing it will be set to the default option.**
+
+Example:
+
+``` go
+package main
+
+import (
+ "github.com/MikunoNaka/MAL2Go/v4/user/anime"
+ "log"
+ "fmt"
+)
+
+func main() {
+ authToken := "YOUR_TOKEN_HERE"
+ myClient := anime.Client {
+ AuthToken: "Bearer " + authToken,
+ }
+
+ updateData := anime.UpdateAnimeData {
+ Status: "watching",
+ IsRewatching: false,
+ Score: 10,
+ EpWatched: 20,
+ Priority: 2,
+ TimesRewatched: 0,
+ RewatchValue: 0,
+ Tags: "",
+ Comments: "",
+ }
+
+ res, err := myClient.UpdateAnime(47194, updateData)
+ if err != nil {
+ log.Fatal(err)
+ }
+
+ fmt.Println(res)
+}
+```
+
+This is useful if you want to update many things without making too many API calls.
+You can get the previously set data with the `GetAnimeById` method, if a value needs to be
+unchanged, just use the previously set value returned by GetAnimeById. This way,
+you can update multiple fields with only two API calls.
+
+The [response](/docs/mal2go/v4/user/anime/types/#mal2gouseranimeupdateresponse) from the API can be used to show the information of the anime after being updated.