diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/README.md b/docs/api/public-api/@devvit/namespaces/Devvit/README.md index 45211b04..58e4528a 100644 --- a/docs/api/public-api/@devvit/namespaces/Devvit/README.md +++ b/docs/api/public-api/@devvit/namespaces/Devvit/README.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/Context.md b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/Context.md index 16f5f4ec..275779f4 100644 --- a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/Context.md +++ b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/Context.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/README.md b/docs/api/public-api/@devvit/namespaces/EventTypes/README.md index 2f7b3a08..6b9eaa23 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/README.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/README.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/DeletionReason.md b/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/DeletionReason.md index 114781dd..2f255c27 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/DeletionReason.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/DeletionReason.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/EventSource.md b/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/EventSource.md index 1f2f72c4..d2669aed 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/EventSource.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/EventSource.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonFromJSON.md b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonFromJSON.md index a788aae2..83f93eb1 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonFromJSON.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonFromJSON.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonToJSON.md b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonToJSON.md index 91b16211..77e6c8a9 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonToJSON.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonToJSON.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceFromJSON.md b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceFromJSON.md index 26c5d46c..a3f8bfe5 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceFromJSON.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceFromJSON.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceToJSON.md b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceToJSON.md index 998e123f..aa68e906 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceToJSON.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceToJSON.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AccountDelete.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AccountDelete.md index 5ebb927a..7d4ce3d2 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AccountDelete.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AccountDelete.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AppInstall.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AppInstall.md index 481a9915..6d68909d 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AppInstall.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AppInstall.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AppUpgrade.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AppUpgrade.md index 651d8a93..86108ab6 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AppUpgrade.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AppUpgrade.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterComment.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterComment.md index 6fd3986e..8d856ba1 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterComment.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterComment.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterPost.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterPost.md index bf8d88e4..2fc2cd5c 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterPost.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterPost.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentApprove.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentApprove.md index 33746d04..63ea4ce6 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentApprove.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentApprove.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentCreate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentCreate.md index d12903c9..57a14f4a 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentCreate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentDelete.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentDelete.md index ec615dda..1a1e9682 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentDelete.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentDelete.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentReport.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentReport.md index 308aa359..850ef44b 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentReport.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentReport.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentSubmit.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentSubmit.md index 0fa2a490..ec1a58e6 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentSubmit.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentSubmit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentUpdate.md index daf9a304..e9cdaf57 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/CommentUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/MentionInCommentCreate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/MentionInCommentCreate.md index 7e411ae8..f8562978 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/MentionInCommentCreate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/MentionInCommentCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostApprove.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostApprove.md index 52e9ef93..7a04b9c3 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostApprove.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostApprove.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostCreate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostCreate.md index 4db1bda2..888da1cd 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostCreate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostDelete.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostDelete.md index 682ac785..b88c8d2e 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostDelete.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostDelete.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostFlairUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostFlairUpdate.md index c8c7ef41..4ba2a15d 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostFlairUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostFlairUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostNsfwUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostNsfwUpdate.md index 37843cf5..fdef4be7 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostNsfwUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostNsfwUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostReport.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostReport.md index 3867fef8..18ecc74d 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostReport.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostReport.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostSpoilerUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostSpoilerUpdate.md index 9145c9f6..aee03dc7 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostSpoilerUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostSpoilerUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostSubmit.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostSubmit.md index c851fb00..5e2456fe 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostSubmit.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostSubmit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostUpdate.md index 874459cf..ee15f967 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/PostUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/SubredditSubscribe.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/SubredditSubscribe.md index 96acb196..459351e2 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/SubredditSubscribe.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/SubredditSubscribe.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/Vote.md b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/Vote.md index bde3056b..e17b5360 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/Vote.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/Vote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AccountDelete.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AccountDelete.md index 3c2aaa5d..27027750 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AccountDelete.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AccountDelete.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AppInstall.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AppInstall.md index 321f14ab..03106c6c 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AppInstall.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AppInstall.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AppUpgrade.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AppUpgrade.md index 39b8be4c..dbf32859 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AppUpgrade.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AppUpgrade.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AutomoderatorFilterComment.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AutomoderatorFilterComment.md index 96c2605f..40514f1c 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AutomoderatorFilterComment.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AutomoderatorFilterComment.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AutomoderatorFilterPost.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AutomoderatorFilterPost.md index 09caa647..c37dda98 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AutomoderatorFilterPost.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/AutomoderatorFilterPost.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentApprove.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentApprove.md index 21f12d88..0e02d57d 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentApprove.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentApprove.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentCreate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentCreate.md index bbda98de..4edf2bd9 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentCreate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentDelete.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentDelete.md index 389d8cad..bb3b0256 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentDelete.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentDelete.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentReport.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentReport.md index d737cd7c..c994d8d3 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentReport.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentReport.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentSubmit.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentSubmit.md index 1b2077c9..744366a6 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentSubmit.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentSubmit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentUpdate.md index feae6371..b975e8b7 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/CommentUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/MentionInCommentCreate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/MentionInCommentCreate.md index 39179da5..197755dd 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/MentionInCommentCreate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/MentionInCommentCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostApprove.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostApprove.md index d080df1f..9a9e2388 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostApprove.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostApprove.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostCreate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostCreate.md index 2359891b..cc909000 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostCreate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostDelete.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostDelete.md index ea423392..79bebae9 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostDelete.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostDelete.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostFlairUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostFlairUpdate.md index 1158620e..8052dc31 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostFlairUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostFlairUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostNsfwUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostNsfwUpdate.md index 5b31c7b9..4de98bf3 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostNsfwUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostNsfwUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostReport.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostReport.md index 30241a9f..2f5323ff 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostReport.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostReport.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostSpoilerUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostSpoilerUpdate.md index f657a429..ab6c153a 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostSpoilerUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostSpoilerUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostSubmit.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostSubmit.md index 890c1ece..3e7c2598 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostSubmit.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostSubmit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostUpdate.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostUpdate.md index 34615771..ef2a188e 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostUpdate.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/PostUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/SubredditSubscribe.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/SubredditSubscribe.md index 7bbab61e..5425aa97 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/SubredditSubscribe.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/SubredditSubscribe.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/Vote.md b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/Vote.md index d45deeaf..8ea1bfbd 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/variables/Vote.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/Vote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../../../../README.md) +[**@devvit/public-api v0.14.3-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/README.md b/docs/api/public-api/README.md index 1db5dc1c..bb11e166 100644 --- a/docs/api/public-api/README.md +++ b/docs/api/public-api/README.md @@ -1,8 +1,8 @@ -**@devvit/public-api v0.14.1-dev** +**@devvit/public-api v0.14.3-dev** *** -# @devvit/public-api v0.14.1-dev +# @devvit/public-api v0.14.3-dev ## Namespaces @@ -156,6 +156,7 @@ - [EmbedContainer](type-aliases/EmbedContainer.md) - [EmbedOptions](type-aliases/EmbedOptions.md) - [EnrichedThumbnail](type-aliases/EnrichedThumbnail.md) +- [FilterOptions](type-aliases/FilterOptions.md) - [FlairBackgroundColor](type-aliases/FlairBackgroundColor.md) - [FlairSettings](type-aliases/FlairSettings.md) - [FlairTextColor](type-aliases/FlairTextColor.md) diff --git a/docs/api/public-api/classes/AuthorFlairSettings.md b/docs/api/public-api/classes/AuthorFlairSettings.md index 047dc680..e815631e 100644 --- a/docs/api/public-api/classes/AuthorFlairSettings.md +++ b/docs/api/public-api/classes/AuthorFlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/ButtonWidget.md b/docs/api/public-api/classes/ButtonWidget.md index a54b74dc..8f1633c3 100644 --- a/docs/api/public-api/classes/ButtonWidget.md +++ b/docs/api/public-api/classes/ButtonWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/CalendarWidget.md b/docs/api/public-api/classes/CalendarWidget.md index 6183e6df..c5383c68 100644 --- a/docs/api/public-api/classes/CalendarWidget.md +++ b/docs/api/public-api/classes/CalendarWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/Comment.md b/docs/api/public-api/classes/Comment.md index 6d3a8ea6..d3e10b9b 100644 --- a/docs/api/public-api/classes/Comment.md +++ b/docs/api/public-api/classes/Comment.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -26,6 +26,8 @@ > **get** **approved**(): `boolean` +Whether the comment has been approved by a moderator. + ##### Returns `boolean` @@ -40,6 +42,11 @@ > **get** **approvedAtUtc**(): `number` +The moderation approval time as Unix seconds, or `0` when unavailable. + +Use [approved](#approved) to check the current approval state. Convert a +nonzero value to a `Date` with `new Date(comment.approvedAtUtc * 1000)`. + ##### Returns `number` @@ -54,6 +61,8 @@ > **get** **authorFlair**(): `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) +The author's subreddit flair, or `undefined` when unavailable. + ##### Returns `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) @@ -68,6 +77,8 @@ > **get** **authorId**(): `undefined` \| `` `t2_${string}` `` +The creator's account identifier or `undefined` when unavailable. + ##### Returns `undefined` \| `` `t2_${string}` `` @@ -82,6 +93,15 @@ > **get** **authorName**(): `string` +The creator's username without the leading `u/`. May be `"[deleted]"` when +the author is unavailable. + +##### Example + +```ts +"Example_User" +``` + ##### Returns `string` @@ -96,6 +116,11 @@ > **get** **bannedAtUtc**(): `number` +The ban time as Unix seconds, or `0` when unavailable. + +Convert a nonzero value to a `Date` with +`new Date(comment.bannedAtUtc * 1000)`. + ##### Returns `number` @@ -110,6 +135,8 @@ > **get** **body**(): `string` +The comment body in Markdown. + ##### Returns `string` @@ -124,6 +151,8 @@ > **get** **collapsedBecauseCrowdControl**(): `boolean` +Whether Crowd Control caused the comment to be collapsed. + ##### Returns `boolean` @@ -138,6 +167,8 @@ > **get** **createdAt**(): `Date` +The date when the comment was created. + ##### Returns `Date` @@ -152,6 +183,12 @@ > **get** **distinguishedBy**(): `undefined` \| `string` +The comment's distinction category. + +For example, a comment distinguished by a moderator or administrator +returns `"moderator"` or `"admin"`. `undefined` means no distinction is +available. + ##### Returns `undefined` \| `string` @@ -166,6 +203,8 @@ > **get** **edited**(): `boolean` +Whether the comment body has been edited since it was created. + ##### Returns `boolean` @@ -194,6 +233,8 @@ > **get** **ignoringReports**(): `boolean` +Whether reports on the comment are being ignored. + ##### Returns `boolean` @@ -208,6 +249,8 @@ > **get** **locked**(): `boolean` +Whether the comment is locked and new replies are disabled. + ##### Returns `boolean` @@ -240,6 +283,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **modReports**(): [`ModeratorReport`](../type-aliases/ModeratorReport.md)[] +Moderator reports and authors, or an empty array when unavailable. + ##### Returns [`ModeratorReport`](../type-aliases/ModeratorReport.md)[] @@ -254,6 +299,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **numReports**(): `number` +The number of reports, or `0` when none are available. + ##### Returns `number` @@ -268,6 +315,11 @@ Use [modReports](#modreports) to retain each report's author. > **get** **parentId**(): `` `t3_${string}` `` \| `` `t1_${string}` `` +The identifier of the comment's parent. + +A top-level comment returns the containing post's `T3`. A reply returns its +parent comment's `T1`. + ##### Returns `` `t3_${string}` `` \| `` `t1_${string}` `` @@ -282,6 +334,14 @@ Use [modReports](#modreports) to retain each report's author. > **get** **permalink**(): `string` +The comment's path relative to `https://www.reddit.com`. + +##### Example + +```ts +"/r/wallstreetbets/comments/abc123/example_post/def456/" +``` + ##### Returns `string` @@ -296,6 +356,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **postId**(): `` `t3_${string}` `` +The identifier of the post containing the comment. + ##### Returns `` `t3_${string}` `` @@ -310,6 +372,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **removed**(): `boolean` +Whether the comment has been removed by a moderator. + ##### Returns `boolean` @@ -324,6 +388,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **replies**(): [`Listing`](Listing.md)\<`Comment`\> +The comment's direct replies. + ##### Returns [`Listing`](Listing.md)\<`Comment`\> @@ -338,6 +404,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **score**(): `number` +The comment's upvotes minus downvotes, or `0` when unavailable. + ##### Returns `number` @@ -352,6 +420,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **spam**(): `boolean` +Whether the comment has been marked as spam by a moderator. + ##### Returns `boolean` @@ -366,6 +436,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **stickied**(): `boolean` +Whether the comment is pinned to the top of its comment thread. + ##### Returns `boolean` @@ -380,6 +452,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **subredditId**(): `` `t5_${string}` `` +The subreddit identifier where the comment was created. + ##### Returns `` `t5_${string}` `` @@ -394,6 +468,15 @@ Use [modReports](#modreports) to retain each report's author. > **get** **subredditName**(): `string` +The name of the subreddit that contains the comment, without the leading +`r/`. + +##### Example + +```ts +"AskReddit" +``` + ##### Returns `string` @@ -408,6 +491,14 @@ Use [modReports](#modreports) to retain each report's author. > **get** **url**(): `string` +The absolute `https://www.reddit.com` URL for the comment. + +##### Example + +```ts +"https://www.reddit.com/r/wallstreetbets/comments/abc123/post/def456/" +``` + ##### Returns `string` @@ -422,6 +513,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **userReportReasons**(): `string`[] +User report reasons, or an empty array when none are available. + ##### Returns `string`[] @@ -434,19 +527,13 @@ Use [modReports](#modreports) to retain each report's author. > **addRemovalNote**(`opts`): `Promise`\<`void`\> -Add a mod note for why the comment was removed +Adds a moderator note explaining why the comment was removed. #### Parameters ##### opts -###### modNote? - -`string` - -###### reasonId - -`string` +`Readonly`\<`Omit`\<[`AddRemovalNoteOptions`](../type-aliases/AddRemovalNoteOptions.md), `"itemIds"`\>\> #### Returns @@ -460,6 +547,8 @@ Add a mod note for why the comment was removed > **approve**(): `Promise`\<`void`\> +Approves the comment and updates this instance's moderation state. + #### Returns `Promise`\<`void`\> @@ -472,6 +561,10 @@ Add a mod note for why the comment was removed > **delete**(): `Promise`\<`void`\> +Deletes the comment as the app account. + +The `runAs` option is ignored when editing a comment. + #### Returns `Promise`\<`void`\> @@ -484,12 +577,16 @@ Add a mod note for why the comment was removed > **distinguish**(`makeSticky`?): `Promise`\<`void`\> +Distinguishes the comment as a moderator and updates this instance. + #### Parameters ##### makeSticky? `boolean` +Whether to pin the comment to the top of its thread. + #### Returns `Promise`\<`void`\> @@ -502,12 +599,16 @@ Add a mod note for why the comment was removed > **distinguishAsAdmin**(`makeSticky`?): `Promise`\<`void`\> +Distinguishes the comment as an employee and updates this instance. + #### Parameters ##### makeSticky? `boolean` +Whether to pin the comment to the top of its thread. + #### Returns `Promise`\<`void`\> @@ -520,6 +621,11 @@ Add a mod note for why the comment was removed > **edit**(`opts`): `Promise`\<`Comment`\> +Replaces the comment body as the app account, then updates the cached body +and edited state from the response. + +The `runAs` option is ignored when editing a comment. + #### Parameters ##### opts @@ -547,16 +653,12 @@ Filters the comment. When a comment is filtered, it is added to the ModQueue for ##### options? -`FilterOptions` - -The options for this filter action. +[`FilterOptions`](../type-aliases/FilterOptions.md) #### Returns `Promise`\<`void`\> -A Promise that resolves if the comment was filtered successfully. - *** @@ -565,6 +667,8 @@ A Promise that resolves if the comment was filtered successfully. > **getAuthor**(): `Promise`\<`undefined` \| [`User`](User.md)\> +Fetches the author's account, or `undefined` if it is unavailable. + #### Returns `Promise`\<`undefined` \| [`User`](User.md)\> @@ -577,6 +681,8 @@ A Promise that resolves if the comment was filtered successfully. > **ignoreReports**(): `Promise`\<`void`\> +Ignores reports and updates this instance's report-ignore state. + #### Returns `Promise`\<`void`\> @@ -589,6 +695,8 @@ A Promise that resolves if the comment was filtered successfully. > **isApproved**(): `boolean` +The comment's approval state. + #### Returns `boolean` @@ -601,6 +709,8 @@ A Promise that resolves if the comment was filtered successfully. > **isDistinguished**(): `boolean` +The comment's distinguished category state. + #### Returns `boolean` @@ -613,6 +723,8 @@ A Promise that resolves if the comment was filtered successfully. > **isEdited**(): `boolean` +The comment's edited state. + #### Returns `boolean` @@ -625,6 +737,8 @@ A Promise that resolves if the comment was filtered successfully. > **isIgnoringReports**(): `boolean` +The comment's report-ignore state. + #### Returns `boolean` @@ -637,6 +751,8 @@ A Promise that resolves if the comment was filtered successfully. > **isLocked**(): `boolean` +The comment's locked state. + #### Returns `boolean` @@ -649,6 +765,8 @@ A Promise that resolves if the comment was filtered successfully. > **isRemoved**(): `boolean` +The comment's removal state. + #### Returns `boolean` @@ -661,6 +779,8 @@ A Promise that resolves if the comment was filtered successfully. > **isSpam**(): `boolean` +The comment's spam state. + #### Returns `boolean` @@ -673,6 +793,8 @@ A Promise that resolves if the comment was filtered successfully. > **isStickied**(): `boolean` +The comment's stickied state. + #### Returns `boolean` @@ -685,6 +807,8 @@ A Promise that resolves if the comment was filtered successfully. > **lock**(): `Promise`\<`void`\> +Disables new replies and updates this instance's locked state. + #### Returns `Promise`\<`void`\> @@ -697,12 +821,16 @@ A Promise that resolves if the comment was filtered successfully. > **remove**(`isSpam`?): `Promise`\<`void`\> +Removes the comment and updates this instance's moderation state. + #### Parameters ##### isSpam? `boolean` +Whether to classify the removed comment as spam. + #### Returns `Promise`\<`void`\> @@ -715,6 +843,8 @@ A Promise that resolves if the comment was filtered successfully. > **reply**(`opts`): `Promise`\<`Comment`\> +Creates a direct reply to the comment. + #### Parameters ##### opts @@ -733,8 +863,8 @@ A Promise that resolves if the comment was filtered successfully. > **showComment**(): `Promise`\<`void`\> -Marks that this comment should not be collapsed by the crowd control system. -It can still be collapsed for other reasons. +Prevents Crowd Control from collapsing the comment. Other rules can still +collapse it. #### Returns @@ -748,8 +878,8 @@ It can still be collapsed for other reasons. > **snoozeReports**(`reason`): `Promise`\<`void`\> -Snooze subsequent reports with the given reason from the same users for the next 7 days. -Only works for free-form reports. +Snoozes subsequent reports with the same reason from the same users for +seven days. This only works for free-form reports. #### Parameters @@ -771,6 +901,8 @@ The report reason to snooze. > **toJSON**(): `Pick`\<`Comment`, `"postId"` \| `"subredditName"` \| `"id"` \| `"subredditId"` \| `"permalink"` \| `"url"` \| `"createdAt"` \| `"authorName"` \| `"body"` \| `"score"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"edited"` \| `"locked"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"parentId"` \| `"replies"` \| `"numReports"` \| `"collapsedBecauseCrowdControl"`\> +Returns the public fields included when the comment is serialized. + #### Returns `Pick`\<`Comment`, `"postId"` \| `"subredditName"` \| `"id"` \| `"subredditId"` \| `"permalink"` \| `"url"` \| `"createdAt"` \| `"authorName"` \| `"body"` \| `"score"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"edited"` \| `"locked"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"parentId"` \| `"replies"` \| `"numReports"` \| `"collapsedBecauseCrowdControl"`\> @@ -783,6 +915,9 @@ The report reason to snooze. > **undistinguish**(): `Promise`\<`void`\> +Removes the distinction category and sticky status and updates this +instance. + #### Returns `Promise`\<`void`\> @@ -795,6 +930,8 @@ The report reason to snooze. > **unignoreReports**(): `Promise`\<`void`\> +Stops ignoring reports and updates this instance's cached state. + #### Returns `Promise`\<`void`\> @@ -807,6 +944,8 @@ The report reason to snooze. > **unlock**(): `Promise`\<`void`\> +Enables new replies and updates this instance's locked state. + #### Returns `Promise`\<`void`\> @@ -819,8 +958,8 @@ The report reason to snooze. > **unsnoozeReports**(`reason`): `Promise`\<`void`\> -Unsnooze reports with the given reason. -Only works for free-form reports. +Unsnoozes reports with the given reason. This only works for free-form +reports. #### Parameters diff --git a/docs/api/public-api/classes/CommunityListWidget.md b/docs/api/public-api/classes/CommunityListWidget.md index a1e3f055..86c27617 100644 --- a/docs/api/public-api/classes/CommunityListWidget.md +++ b/docs/api/public-api/classes/CommunityListWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/CustomWidget.md b/docs/api/public-api/classes/CustomWidget.md index 30aeb1e9..60089302 100644 --- a/docs/api/public-api/classes/CustomWidget.md +++ b/docs/api/public-api/classes/CustomWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/Devvit.md b/docs/api/public-api/classes/Devvit.md index ba1478da..c535c545 100644 --- a/docs/api/public-api/classes/Devvit.md +++ b/docs/api/public-api/classes/Devvit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/Flair.md b/docs/api/public-api/classes/Flair.md index dbf76063..518408fe 100644 --- a/docs/api/public-api/classes/Flair.md +++ b/docs/api/public-api/classes/Flair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/FlairTemplate.md b/docs/api/public-api/classes/FlairTemplate.md index 23589737..cff409c8 100644 --- a/docs/api/public-api/classes/FlairTemplate.md +++ b/docs/api/public-api/classes/FlairTemplate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/ImageWidget.md b/docs/api/public-api/classes/ImageWidget.md index 8b131cd8..19b59acc 100644 --- a/docs/api/public-api/classes/ImageWidget.md +++ b/docs/api/public-api/classes/ImageWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/Listing.md b/docs/api/public-api/classes/Listing.md index a87354b8..7ac55de4 100644 --- a/docs/api/public-api/classes/Listing.md +++ b/docs/api/public-api/classes/Listing.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/ModMailService.md b/docs/api/public-api/classes/ModMailService.md index 8fc9e9b3..389a49a8 100644 --- a/docs/api/public-api/classes/ModMailService.md +++ b/docs/api/public-api/classes/ModMailService.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/ModNote.md b/docs/api/public-api/classes/ModNote.md index f6684548..51a3a6b9 100644 --- a/docs/api/public-api/classes/ModNote.md +++ b/docs/api/public-api/classes/ModNote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/Post.md b/docs/api/public-api/classes/Post.md index 250c9b41..9a974281 100644 --- a/docs/api/public-api/classes/Post.md +++ b/docs/api/public-api/classes/Post.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -26,6 +26,8 @@ > **get** **approved**(): `boolean` +Whether the post has been approved by a moderator. + ##### Returns `boolean` @@ -40,6 +42,11 @@ > **get** **approvedAtUtc**(): `number` +The moderation approval time as Unix seconds, or `0` when unavailable. + +Use [approved](#approved) to check the current approval state. Convert a nonzero +value to a `Date` with `new Date(post.approvedAtUtc * 1000)`. + ##### Returns `number` @@ -54,6 +61,8 @@ > **get** **archived**(): `boolean` +Whether the post is archived. + ##### Returns `boolean` @@ -68,6 +77,8 @@ > **get** **authorFlair**(): `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) +The author's subreddit flair, or `undefined` when unavailable. + ##### Returns `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) @@ -82,6 +93,8 @@ > **get** **authorId**(): `undefined` \| `` `t2_${string}` `` +The creator's account identifier, or `undefined` when unavailable. + ##### Returns `undefined` \| `` `t2_${string}` `` @@ -96,6 +109,8 @@ > **get** **authorName**(): `string` +The creator's username without the leading `u/`. + ##### Returns `string` @@ -110,6 +125,11 @@ > **get** **bannedAtUtc**(): `number` +The ban time as Unix seconds, or `0` when unavailable. + +Convert a nonzero value to a `Date` with +`new Date(post.bannedAtUtc * 1000)`. + ##### Returns `number` @@ -124,6 +144,8 @@ > **get** **body**(): `undefined` \| `string` +The post body in Markdown. `undefined` if absent. + ##### Returns `undefined` \| `string` @@ -138,6 +160,8 @@ > **get** **bodyHtml**(): `undefined` \| `string` +The post body rendered as HTML, or `undefined` when unavailable. + ##### Returns `undefined` \| `string` @@ -152,6 +176,15 @@ > **get** **comments**(): [`Listing`](Listing.md)\<[`Comment`](Comment.md)\> +A listing of the post's top-level comments. Each comment exposes its +replies separately. + +##### Example + +```ts +const comments = await post.comments.get(25); +``` + ##### Returns [`Listing`](Listing.md)\<[`Comment`](Comment.md)\> @@ -166,6 +199,8 @@ > **get** **createdAt**(): `Date` +The date when the post was created. + ##### Returns `Date` @@ -180,7 +215,8 @@ > **get** **crosspostParentId**(): `undefined` \| `` `t3_${string}` `` -The ID of the original post this was crossposted from. Undefined if this post is not a crosspost. +The original post's identifier when this post is a crosspost. `undefined` +if not a crosspost or parent is unavailable. ##### Returns @@ -196,6 +232,11 @@ The ID of the original post this was crossposted from. Undefined if this post is > **get** **distinguishedBy**(): `undefined` \| `string` +The post's distinction category. + +For example, a post distinguished by a moderator or employee returns +`"moderator"` or `"admin"`. `undefined` means no distinction is available. + ##### Returns `undefined` \| `string` @@ -210,6 +251,8 @@ The ID of the original post this was crossposted from. Undefined if this post is > **get** **edited**(): `boolean` +Whether the post body has been edited since it was created. + ##### Returns `boolean` @@ -224,6 +267,8 @@ The ID of the original post this was crossposted from. Undefined if this post is > **get** **flair**(): `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) +The post flair, or `undefined` when unavailable. + ##### Returns `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) @@ -238,7 +283,11 @@ The ID of the original post this was crossposted from. Undefined if this post is > **get** **gallery**(): [`GalleryMedia`](../type-aliases/GalleryMedia.md)[] -Get the media in the post. Empty if the post doesn't have any media. +Get the image or GIF metadata in the post. Empty if the post doesn't have +any media. + +Gallery posts can contain multiple entries. For other posts, one entry from +the first preview image or GIF variant. ##### Returns @@ -254,6 +303,8 @@ Get the media in the post. Empty if the post doesn't have any media. > **get** **hidden**(): `boolean` +Whether the post is hidden from listings. + ##### Returns `boolean` @@ -282,6 +333,8 @@ Get the media in the post. Empty if the post doesn't have any media. > **get** **ignoringReports**(): `boolean` +Whether reports on the post are being ignored. + ##### Returns `boolean` @@ -296,6 +349,8 @@ Get the media in the post. Empty if the post doesn't have any media. > **get** **locked**(): `boolean` +Whether the post is locked and new comments are disabled. + ##### Returns `boolean` @@ -328,6 +383,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **modReports**(): [`ModeratorReport`](../type-aliases/ModeratorReport.md)[] +Moderator reports and authors, or an empty array when unavailable. + ##### Returns [`ModeratorReport`](../type-aliases/ModeratorReport.md)[] @@ -342,6 +399,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **nsfw**(): `boolean` +Whether the post is marked not safe for work (NSFW). + ##### Returns `boolean` @@ -356,6 +415,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **numberOfComments**(): `number` +The number of comments, or `0` when none are available. + ##### Returns `number` @@ -370,6 +431,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **numberOfReports**(): `number` +The number of reports, or `0` when none are available. + ##### Returns `number` @@ -384,6 +447,14 @@ Use [modReports](#modreports) to retain each report's author. > **get** **permalink**(): `string` +The post's path relative to `https://www.reddit.com`. + +##### Example + +```ts +"/r/wallstreetbets/comments/abc123/post/" +``` + ##### Returns `string` @@ -398,7 +469,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **pollData**(): `undefined` \| [`PollData`](../type-aliases/PollData.md) -Poll data for the post, if the post is a poll. Undefined otherwise. +The post's poll options, vote totals, and voting end time. `undefined` if +the post is not a poll. ##### Returns @@ -414,6 +486,8 @@ Poll data for the post, if the post is a poll. Undefined otherwise. > **get** **quarantined**(): `boolean` +Whether the post is quarantined. + ##### Returns `boolean` @@ -428,6 +502,8 @@ Poll data for the post, if the post is a poll. Undefined otherwise. > **get** **removed**(): `boolean` +Whether the post has been removed by a moderator. + ##### Returns `boolean` @@ -442,7 +518,8 @@ Poll data for the post, if the post is a poll. Undefined otherwise. > **get** **removedBy**(): `undefined` \| `string` -Who removed this object (username) +The username of the account that removed the post, without the leading +`u/`, or `undefined` when unavailable. ##### Returns @@ -458,17 +535,18 @@ Who removed this object (username) > **get** **removedByCategory**(): `undefined` \| `string` -who/what removed this object. It will return one of the following: -- "anti_evil_ops": object is removed by a aeops member -- "author": object is removed by author of the post -- "automod_filtered": object is filtered by automod -- "community_ops": object is removed by a community team member -- "content_takedown": object is removed due to content violation -- "copyright_takedown": object is removed due to copyright violation -- "deleted": object is deleted -- "moderator": object is removed by a mod of the sub -- "reddit": object is removed by anyone else -- undefined: object is not removed +Identifies who or what removed the post: + +- `"anti_evil_ops"`: Reddit Anti-Evil Operations. +- `"author"`: The post's author. +- `"automod_filtered"`: AutoModerator filtering. +- `"community_ops"`: Reddit Community Operations. +- `"content_takedown"`: A content-policy takedown. +- `"copyright_takedown"`: A copyright takedown. +- `"deleted"`: The post was deleted. +- `"moderator"`: A subreddit moderator. +- `"reddit"`: Any other remover. +- `undefined`: No removal category is available. ##### Returns @@ -484,6 +562,8 @@ who/what removed this object. It will return one of the following: > **get** **score**(): `number` +The post's upvotes minus downvotes, or `0` when unavailable. + ##### Returns `number` @@ -498,6 +578,11 @@ who/what removed this object. It will return one of the following: > **get** **secureMedia**(): `undefined` \| [`SecureMedia`](../type-aliases/SecureMedia.md) +Metadata for embedded or Reddit-hosted media, including oEmbed or Reddit +video data. + +Returns `undefined` when the post has no secure media metadata. + ##### Returns `undefined` \| [`SecureMedia`](../type-aliases/SecureMedia.md) @@ -512,6 +597,8 @@ who/what removed this object. It will return one of the following: > **get** **spam**(): `boolean` +Whether the post has been marked as spam by a moderator. + ##### Returns `boolean` @@ -526,6 +613,8 @@ who/what removed this object. It will return one of the following: > **get** **spoiler**(): `boolean` +Whether the post's content is hidden until the user explicitly opens it. + ##### Returns `boolean` @@ -540,6 +629,8 @@ who/what removed this object. It will return one of the following: > **get** **stickied**(): `boolean` +Whether the post is presented before other posts in its subreddit. + ##### Returns `boolean` @@ -554,6 +645,8 @@ who/what removed this object. It will return one of the following: > **get** **subredditId**(): `` `t5_${string}` `` +The subreddit identifier where the post was created. + ##### Returns `` `t5_${string}` `` @@ -568,6 +661,8 @@ who/what removed this object. It will return one of the following: > **get** **subredditName**(): `string` +The owning subreddit's name without the leading `r/`. + ##### Returns `string` @@ -582,6 +677,11 @@ who/what removed this object. It will return one of the following: > **get** **thumbnail**(): `undefined` \| \{ `height`: `number`; `url`: `string`; `width`: `number`; \} +The post's preview thumbnail URL and dimensions in pixels. + +`undefined` means no thumbnail is available or the source field contains a +placeholder such as `"self"` or `"nsfw"`. + ##### Returns `undefined` \| \{ `height`: `number`; `url`: `string`; `width`: `number`; \} @@ -596,6 +696,8 @@ who/what removed this object. It will return one of the following: > **get** **title**(): `string` +The title displayed for the post. + ##### Returns `string` @@ -610,6 +712,17 @@ who/what removed this object. It will return one of the following: > **get** **url**(): `string` +The post URL. + +This is the submitted URL for a link post or the full-size media URL for an +image or video post. Use [permalink](#permalink) for the relative path. + +##### Example + +```ts +"https://www.reddit.com/r/wallstreetbets/comments/abc123/post/" +``` + ##### Returns `string` @@ -624,6 +737,8 @@ who/what removed this object. It will return one of the following: > **get** **userReportReasons**(): `string`[] +User report reasons, or an empty array when none are available. + ##### Returns `string`[] @@ -636,6 +751,8 @@ who/what removed this object. It will return one of the following: > **addComment**(`opts`): `Promise`\<[`Comment`](Comment.md)\> +Creates a top-level comment on the post. + #### Parameters ##### opts @@ -654,19 +771,13 @@ who/what removed this object. It will return one of the following: > **addRemovalNote**(`opts`): `Promise`\<`void`\> -Add a mod note for why the post was removed +Adds a moderator note explaining why the post was removed. #### Parameters ##### opts -###### modNote? - -`string` - -###### reasonId - -`string` +`Readonly`\<`Omit`\<[`AddRemovalNoteOptions`](../type-aliases/AddRemovalNoteOptions.md), `"itemIds"`\>\> #### Returns @@ -680,6 +791,8 @@ Add a mod note for why the post was removed > **approve**(): `Promise`\<`void`\> +Approves the post and updates this instance's moderation state. + #### Returns `Promise`\<`void`\> @@ -692,6 +805,8 @@ Add a mod note for why the post was removed > **crosspost**(`opts`): `Promise`\<`Post`\> +Creates a crosspost of this post in another subreddit. + #### Parameters ##### opts @@ -710,6 +825,8 @@ Add a mod note for why the post was removed > **delete**(): `Promise`\<`void`\> +Deletes the post as the app account. + #### Returns `Promise`\<`void`\> @@ -722,6 +839,8 @@ Add a mod note for why the post was removed > **distinguish**(): `Promise`\<`void`\> +Distinguishes the post as a moderator and updates this instance. + #### Returns `Promise`\<`void`\> @@ -734,6 +853,8 @@ Add a mod note for why the post was removed > **distinguishAsAdmin**(): `Promise`\<`void`\> +Distinguishes the post as an administrator and updates this instance. + #### Returns `Promise`\<`void`\> @@ -746,6 +867,9 @@ Add a mod note for why the post was removed > **edit**(`opts`): `Promise`\<`void`\> +Replaces the post body as the app account, then updates the cached body and +edited state from the response. + #### Parameters ##### opts @@ -773,16 +897,12 @@ Filters a post. When a post is filtered, it is added to the ModQueue for review, ##### options? -`FilterOptions` - -The options for this filter action. +[`FilterOptions`](../type-aliases/FilterOptions.md) #### Returns `Promise`\<`void`\> -A Promise that resolves if the post was filtered successfully. - *** @@ -791,6 +911,8 @@ A Promise that resolves if the post was filtered successfully. > **getAuthor**(): `Promise`\<`undefined` \| [`User`](User.md)\> +Fetches the creator's account, or `undefined` if it is unavailable. + #### Returns `Promise`\<`undefined` \| [`User`](User.md)\> @@ -837,6 +959,8 @@ Get the custom styles for a custom post. > **getDuplicates**(`opts`?): [`Listing`](Listing.md)\<`Post`\> +A listing of other posts that reference the same URL. + #### Parameters ##### opts? @@ -847,6 +971,12 @@ Get the custom styles for a custom post. [`Listing`](Listing.md)\<`Post`\> +#### Example + +```ts +const duplicates = await post.getDuplicates().get(25); +``` + *** @@ -883,7 +1013,7 @@ const enrichedThumbnail = await post.getEnrichedThumbnail(); > **getPostData**(): `Promise`\<`undefined` \| [`JSONObject`](../type-aliases/JSONObject.md)\> -Get the postData for the custom post. +Get the post data for the custom post. #### Returns @@ -904,6 +1034,8 @@ const postData = await post.getPostData(); > **hide**(): `Promise`\<`void`\> +Hides the post from the app account and updates this instance. + #### Returns `Promise`\<`void`\> @@ -916,6 +1048,8 @@ const postData = await post.getPostData(); > **ignoreReports**(): `Promise`\<`void`\> +Ignores reports and updates this instance's report-ignore state. + #### Returns `Promise`\<`void`\> @@ -928,6 +1062,8 @@ const postData = await post.getPostData(); > **isApproved**(): `boolean` +The post's approval state. + #### Returns `boolean` @@ -940,6 +1076,8 @@ const postData = await post.getPostData(); > **isArchived**(): `boolean` +The post's archived state. + #### Returns `boolean` @@ -952,6 +1090,8 @@ const postData = await post.getPostData(); > **isDistinguishedBy**(): `undefined` \| `string` +The post's distinction category. + #### Returns `undefined` \| `string` @@ -964,6 +1104,8 @@ const postData = await post.getPostData(); > **isEdited**(): `boolean` +The post's edited state. + #### Returns `boolean` @@ -976,6 +1118,8 @@ const postData = await post.getPostData(); > **isHidden**(): `boolean` +The post's hidden state. + #### Returns `boolean` @@ -988,6 +1132,8 @@ const postData = await post.getPostData(); > **isIgnoringReports**(): `boolean` +The post's report-ignore state. + #### Returns `boolean` @@ -1000,6 +1146,8 @@ const postData = await post.getPostData(); > **isLocked**(): `boolean` +The post's locked state. + #### Returns `boolean` @@ -1012,6 +1160,8 @@ const postData = await post.getPostData(); > **isNsfw**(): `boolean` +The post's NSFW state. + #### Returns `boolean` @@ -1024,6 +1174,8 @@ const postData = await post.getPostData(); > **isQuarantined**(): `boolean` +The post's quarantine state. + #### Returns `boolean` @@ -1036,6 +1188,8 @@ const postData = await post.getPostData(); > **isRemoved**(): `boolean` +The post's removal state. + #### Returns `boolean` @@ -1048,6 +1202,8 @@ const postData = await post.getPostData(); > **isSpam**(): `boolean` +The post's spam state. + #### Returns `boolean` @@ -1060,6 +1216,8 @@ const postData = await post.getPostData(); > **isSpoiler**(): `boolean` +The post's spoiler state. + #### Returns `boolean` @@ -1072,6 +1230,8 @@ const postData = await post.getPostData(); > **isStickied**(): `boolean` +The post's stickied state. + #### Returns `boolean` @@ -1084,6 +1244,8 @@ const postData = await post.getPostData(); > **lock**(): `Promise`\<`void`\> +Disables new comments and updates this instance's locked state. + #### Returns `Promise`\<`void`\> @@ -1096,6 +1258,8 @@ const postData = await post.getPostData(); > **markAsNsfw**(): `Promise`\<`void`\> +Marks the post as NSFW and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1108,6 +1272,8 @@ const postData = await post.getPostData(); > **markAsSpoiler**(): `Promise`\<`void`\> +Marks the post as a spoiler and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1120,7 +1286,10 @@ const postData = await post.getPostData(); > **mergePostData**(`postData`): `Promise`\<`void`\> -Merge the postData on a custom post with the postData specified in the input. This performs a shallow merge. +Shallow-merge `postData` with any existing post data. + +Existing top-level properties are preserved unless the input replaces +them. Nested objects are replaced rather than deeply merged. #### Parameters @@ -1128,22 +1297,21 @@ Merge the postData on a custom post with the postData specified in the input. Th [`JSONObject`](../type-aliases/JSONObject.md) -Represents the postData to be merged with the existing postData. - #### Returns `Promise`\<`void`\> #### Throws -Throws an error if the postData could not be merged. +If the post data could not be updated. #### Example ```ts const post = await reddit.getPostById(context.postId); -// Existing postData: { currentScore: 55, settings: { theme: 'dark', fontSize: 12 } } +// Existing data: +// { currentScore: 55, settings: { theme: 'dark', fontSize: 12 } } await post.mergePostData({ settings: { fontSize: 14 } }); // Result: { currentScore: 55, settings: { fontSize: 14 } } @@ -1157,12 +1325,16 @@ await post.mergePostData({ settings: { fontSize: 14 } }); > **remove**(`isSpam`?): `Promise`\<`void`\> +Removes the post and updates this instance's moderation state. + #### Parameters ##### isSpam? `boolean` +Whether to classify the removed post as spam. + #### Returns `Promise`\<`void`\> @@ -1177,15 +1349,15 @@ await post.mergePostData({ settings: { fontSize: 14 } }); **`Experimental`** -Set the custom styles for a custom post. +Updates a custom post's styles. + +Unspecified properties retain their existing values. Passing `undefined` +removes all custom styles. #### Parameters ##### styles -The styles to set for the post. If a value isn't specified, its previous value - will be preserved. If `undefined` is passed, all custom styles will be removed. - `undefined` | `CustomPostStylesInput` #### Returns @@ -1200,8 +1372,7 @@ The styles to set for the post. If a value isn't specified, its previous value > **setPostData**(`postData`): `Promise`\<`void`\> -Set the postData for the custom post. This will replace the existing -postData with the postData specified in the input. +Replace the post data stored on a custom post. #### Parameters @@ -1241,7 +1412,7 @@ await post.setPostData({ > **setSuggestedCommentSort**(`suggestedSort`): `Promise`\<`void`\> -Set the suggested sort for comments on a Post. +Sets the suggested default sort for the post's comments. #### Parameters @@ -1255,13 +1426,13 @@ Set the suggested sort for comments on a Post. #### Throws -Throws an error if the suggested sort could not be set. +If the suggested sort is rejected. #### Example ```ts const post = await reddit.getPostById(context.postId); -await post.setSuggestedCommentSort("NEW"); +await post.setSuggestedCommentSort('NEW'); ``` *** @@ -1272,7 +1443,11 @@ await post.setSuggestedCommentSort("NEW"); > **setTextFallback**(`opts`): `Promise`\<`void`\> -Set a text fallback for the custom post. +Replaces the content shown when a custom post cannot be rendered. Eg, on +`old.reddit.com`. + +The fallback may be plain text, Markdown, or rich text. This instance's +body and edited state are updated from the response. #### Parameters @@ -1280,20 +1455,17 @@ Set a text fallback for the custom post. `Readonly`\<[`CustomPostTextFallbackOptions`](../type-aliases/CustomPostTextFallbackOptions.md)\> -A text or a richtext to render in a fallback - #### Returns `Promise`\<`void`\> #### Throws -Throws an error if the fallback could not be set. +If the fallback could not be updated. #### Example ```ts -// from a menu action, form, scheduler, trigger, custom post click event, etc const newTextFallback = { text: 'This is an updated text fallback' }; const post = await context.reddit.getPostById(context.postId); await post.setTextFallback(newTextFallback); @@ -1307,8 +1479,8 @@ await post.setTextFallback(newTextFallback); > **snoozeReports**(`reason`): `Promise`\<`void`\> -Snooze subsequent reports with the given reason from the same users for the next 7 days. -Only works for free-form reports. +Snoozes subsequent reports with the same reason from the same users for +seven days. This only works for free-form reports. #### Parameters @@ -1330,10 +1502,16 @@ The report reason to snooze. > **sticky**(`position`?): `Promise`\<`void`\> +Pins the post in a sticky slot. + #### Parameters ##### position? +The sticky slot. If omitted, the bottom-most available +slot is used. Use 1 or 2 for subreddit posts. 3 and 4 are reserved for +profile pins. + `1` | `2` | `3` | `4` #### Returns @@ -1348,6 +1526,8 @@ The report reason to snooze. > **toJSON**(): `Pick`\<`Post`, `"subredditName"` \| `"title"` \| `"nsfw"` \| `"spoiler"` \| `"id"` \| `"subredditId"` \| `"permalink"` \| `"url"` \| `"createdAt"` \| `"authorId"` \| `"authorName"` \| `"body"` \| `"bodyHtml"` \| `"thumbnail"` \| `"score"` \| `"numberOfComments"` \| `"numberOfReports"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"removedBy"` \| `"removedByCategory"` \| `"archived"` \| `"edited"` \| `"locked"` \| `"quarantined"` \| `"hidden"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"flair"` \| `"authorFlair"` \| `"secureMedia"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"crosspostParentId"`\> +JSON representation of public fields. + #### Returns `Pick`\<`Post`, `"subredditName"` \| `"title"` \| `"nsfw"` \| `"spoiler"` \| `"id"` \| `"subredditId"` \| `"permalink"` \| `"url"` \| `"createdAt"` \| `"authorId"` \| `"authorName"` \| `"body"` \| `"bodyHtml"` \| `"thumbnail"` \| `"score"` \| `"numberOfComments"` \| `"numberOfReports"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"removedBy"` \| `"removedByCategory"` \| `"archived"` \| `"edited"` \| `"locked"` \| `"quarantined"` \| `"hidden"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"flair"` \| `"authorFlair"` \| `"secureMedia"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"crosspostParentId"`\> @@ -1360,6 +1540,8 @@ The report reason to snooze. > **undistinguish**(): `Promise`\<`void`\> +Removes the post's distinction and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1372,6 +1554,8 @@ The report reason to snooze. > **unhide**(): `Promise`\<`void`\> +Unhides the post for the app account and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1384,6 +1568,8 @@ The report reason to snooze. > **unignoreReports**(): `Promise`\<`void`\> +Stops ignoring reports and updates this instance's cached state. + #### Returns `Promise`\<`void`\> @@ -1396,6 +1582,8 @@ The report reason to snooze. > **unlock**(): `Promise`\<`void`\> +Enables new comments and updates this instance's locked state. + #### Returns `Promise`\<`void`\> @@ -1408,6 +1596,8 @@ The report reason to snooze. > **unmarkAsNsfw**(): `Promise`\<`void`\> +Removes the NSFW designation and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1420,6 +1610,8 @@ The report reason to snooze. > **unmarkAsSpoiler**(): `Promise`\<`void`\> +Removes the spoiler designation and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1432,8 +1624,8 @@ The report reason to snooze. > **unsnoozeReports**(`reason`): `Promise`\<`void`\> -Unsnooze reports with the given reason. -Only works for free-form reports. +Unsnoozes reports with the given reason. This only works for free-form +reports. #### Parameters @@ -1455,6 +1647,9 @@ The report reason to unsnooze. > **unsticky**(): `Promise`\<`void`\> +Unpins the post without updating this instance's cached [stickied](#stickied) +value. + #### Returns `Promise`\<`void`\> @@ -1467,7 +1662,7 @@ The report reason to unsnooze. > **updateCrowdControlLevel**(`level`): `Promise`\<`void`\> -Updates the crowd control level of the post to hide comments accordingly. +Sets which comments Crowd Control collapses on this post. #### Parameters @@ -1475,7 +1670,7 @@ Updates the crowd control level of the post to hide comments accordingly. [`CrowdControlLevel`](../type-aliases/CrowdControlLevel.md) -The crowd control level to set. See [CrowdControlLevel](../type-aliases/CrowdControlLevel.md) for more information. +See [CrowdControlLevel](../type-aliases/CrowdControlLevel.md) for the available levels. #### Returns diff --git a/docs/api/public-api/classes/PostFlairSettings.md b/docs/api/public-api/classes/PostFlairSettings.md index e3116bdc..0fb5a73c 100644 --- a/docs/api/public-api/classes/PostFlairSettings.md +++ b/docs/api/public-api/classes/PostFlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/PostFlairWidget.md b/docs/api/public-api/classes/PostFlairWidget.md index 9c598c83..6fcf6b5a 100644 --- a/docs/api/public-api/classes/PostFlairWidget.md +++ b/docs/api/public-api/classes/PostFlairWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/PrivateMessage.md b/docs/api/public-api/classes/PrivateMessage.md index 029b771e..f9e75713 100644 --- a/docs/api/public-api/classes/PrivateMessage.md +++ b/docs/api/public-api/classes/PrivateMessage.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/RedditAPIClient.md b/docs/api/public-api/classes/RedditAPIClient.md index 60aff6bf..d5be6afd 100644 --- a/docs/api/public-api/classes/RedditAPIClient.md +++ b/docs/api/public-api/classes/RedditAPIClient.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -130,21 +130,28 @@ Options for the request. > **addModNote**(`options`): `Promise`\<[`ModNote`](ModNote.md)\> -Add a mod note. +Adds a moderation note to a user and returns the created note. #### Parameters ##### options -`Prettify` - -Options for the request +[`CreateModNoteOptions`](../type-aliases/CreateModNoteOptions.md) #### Returns `Promise`\<[`ModNote`](ModNote.md)\> -A Promise that resolves if the mod note was successfully added. +#### Example + +```ts +const modNote = await reddit.addModNote({ + subreddit: 'wallstreetbets', + user: 'spez', + note: 'Repeated rule 1 violations', + label: 'ABUSE_WARNING', +}); +``` #### Inherited from @@ -158,18 +165,28 @@ A Promise that resolves if the mod note was successfully added. > **addRemovalNote**(`options`): `Promise`\<`void`\> -Add a mod note for why a post or comment was removed +Adds a removal note to each specified post or comment. #### Parameters ##### options -`Prettify` +[`AddRemovalNoteOptions`](../type-aliases/AddRemovalNoteOptions.md) #### Returns `Promise`\<`void`\> +#### Example + +```ts +await reddit.addRemovalNote({ + itemIds: ['t1_abc123', 't3_def456'], + reasonId: '', + modNote: 'Removed for breaking rule 1', +}); +``` + #### Inherited from [`RedditClient`](RedditClient.md).[`addRemovalNote`](RedditClient.md#addremovalnote) @@ -633,22 +650,18 @@ The ID of the flair template to delete. > **deleteModNote**(`options`): `Promise`\<`boolean`\> -Delete a mod note. +Deletes a moderation note. Returns true if successful. #### Parameters ##### options -`Prettify` - -Options for the request +[`DeleteNotesOptions`](../type-aliases/DeleteNotesOptions.md) #### Returns `Promise`\<`boolean`\> -True if it was deleted successfully; false otherwise. - #### Inherited from [`RedditClient`](RedditClient.md).[`deleteModNote`](RedditClient.md#deletemodnote) @@ -775,7 +788,7 @@ The id of the post (t3_) or comment (t1_) to filter. ##### options? -`FilterOptions` +[`FilterOptions`](../type-aliases/FilterOptions.md) The options for this filter action. @@ -1482,21 +1495,29 @@ A Listing of SubredditModeratorUser objects. > **getModNotes**(`options`): [`Listing`](Listing.md)\<[`ModNote`](ModNote.md)\> -Get a list of mod notes related to a user in a subreddit. +Get a user's moderation notes within a subreddit. #### Parameters ##### options -`Prettify` - -Options for the request +[`GetModNotesOptions`](../type-aliases/GetModNotesOptions.md) #### Returns [`Listing`](Listing.md)\<[`ModNote`](ModNote.md)\> -A listing of ModNote objects. +#### Example + +```ts +const notes = await reddit + .getModNotes({ + subreddit: 'wallstreetbets', + user: 'spez', + filter: 'NOTE', + }) + .get(25); +``` #### Inherited from @@ -2742,7 +2763,7 @@ A Listing of SubredditWikiContributorUser objects. #### Call Signature -> **getWikiPage**(`subredditName`, `page`, `revisionId`?): `Promise`\<[`WikiPage`](WikiPage.md)\> +> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](WikiPage.md)\> Get a specific revision of a wiki page from a subreddit. @@ -2760,12 +2781,12 @@ The name of the subreddit to get the wiki page from. The name of the wiki page to get. -###### revisionId? - -`` `${string}-${string}-${string}-${string}-${string}` `` +###### revisionId The revision ID of the wiki page version to get. Leaving it empty returns the latest version. +`undefined` | `` `${string}-${string}-${string}-${string}-${string}` `` + ##### Returns `Promise`\<[`WikiPage`](WikiPage.md)\> diff --git a/docs/api/public-api/classes/RedditClient.md b/docs/api/public-api/classes/RedditClient.md index 78b792bd..4ee6e3d6 100644 --- a/docs/api/public-api/classes/RedditClient.md +++ b/docs/api/public-api/classes/RedditClient.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -118,21 +118,28 @@ Options for the request. > **addModNote**(`options`): `Promise`\<[`ModNote`](ModNote.md)\> -Add a mod note. +Adds a moderation note to a user and returns the created note. #### Parameters ##### options -`Prettify` - -Options for the request +[`CreateModNoteOptions`](../type-aliases/CreateModNoteOptions.md) #### Returns `Promise`\<[`ModNote`](ModNote.md)\> -A Promise that resolves if the mod note was successfully added. +#### Example + +```ts +const modNote = await reddit.addModNote({ + subreddit: 'wallstreetbets', + user: 'spez', + note: 'Repeated rule 1 violations', + label: 'ABUSE_WARNING', +}); +``` *** @@ -142,18 +149,28 @@ A Promise that resolves if the mod note was successfully added. > **addRemovalNote**(`options`): `Promise`\<`void`\> -Add a mod note for why a post or comment was removed +Adds a removal note to each specified post or comment. #### Parameters ##### options -`Prettify` +[`AddRemovalNoteOptions`](../type-aliases/AddRemovalNoteOptions.md) #### Returns `Promise`\<`void`\> +#### Example + +```ts +await reddit.addRemovalNote({ + itemIds: ['t1_abc123', 't3_def456'], + reasonId: '', + modNote: 'Removed for breaking rule 1', +}); +``` + *** @@ -559,22 +576,18 @@ The ID of the flair template to delete. > **deleteModNote**(`options`): `Promise`\<`boolean`\> -Delete a mod note. +Deletes a moderation note. Returns true if successful. #### Parameters ##### options -`Prettify` - -Options for the request +[`DeleteNotesOptions`](../type-aliases/DeleteNotesOptions.md) #### Returns `Promise`\<`boolean`\> -True if it was deleted successfully; false otherwise. - *** @@ -685,7 +698,7 @@ The id of the post (t3_) or comment (t1_) to filter. ##### options? -`FilterOptions` +[`FilterOptions`](../type-aliases/FilterOptions.md) The options for this filter action. @@ -1282,21 +1295,29 @@ A Listing of SubredditModeratorUser objects. > **getModNotes**(`options`): [`Listing`](Listing.md)\<[`ModNote`](ModNote.md)\> -Get a list of mod notes related to a user in a subreddit. +Get a user's moderation notes within a subreddit. #### Parameters ##### options -`Prettify` - -Options for the request +[`GetModNotesOptions`](../type-aliases/GetModNotesOptions.md) #### Returns [`Listing`](Listing.md)\<[`ModNote`](ModNote.md)\> -A listing of ModNote objects. +#### Example + +```ts +const notes = await reddit + .getModNotes({ + subreddit: 'wallstreetbets', + user: 'spez', + filter: 'NOTE', + }) + .get(25); +``` *** @@ -2382,7 +2403,7 @@ A Listing of SubredditWikiContributorUser objects. #### Call Signature -> **getWikiPage**(`subredditName`, `page`, `revisionId`?): `Promise`\<[`WikiPage`](WikiPage.md)\> +> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](WikiPage.md)\> Get a specific revision of a wiki page from a subreddit. @@ -2400,12 +2421,12 @@ The name of the subreddit to get the wiki page from. The name of the wiki page to get. -###### revisionId? - -`` `${string}-${string}-${string}-${string}-${string}` `` +###### revisionId The revision ID of the wiki page version to get. Leaving it empty returns the latest version. +`undefined` | `` `${string}-${string}-${string}-${string}-${string}` `` + ##### Returns `Promise`\<[`WikiPage`](WikiPage.md)\> diff --git a/docs/api/public-api/classes/RichTextBuilder.md b/docs/api/public-api/classes/RichTextBuilder.md index 03ad6573..3b6b9a7f 100644 --- a/docs/api/public-api/classes/RichTextBuilder.md +++ b/docs/api/public-api/classes/RichTextBuilder.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/Rule.md b/docs/api/public-api/classes/Rule.md index b762f693..f6fcfeb5 100644 --- a/docs/api/public-api/classes/Rule.md +++ b/docs/api/public-api/classes/Rule.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SettingsClient.md b/docs/api/public-api/classes/SettingsClient.md index 1f55f4d3..9ac5e5f9 100644 --- a/docs/api/public-api/classes/SettingsClient.md +++ b/docs/api/public-api/classes/SettingsClient.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/Subreddit.md b/docs/api/public-api/classes/Subreddit.md index 7ebbd3dc..697a1e5a 100644 --- a/docs/api/public-api/classes/Subreddit.md +++ b/docs/api/public-api/classes/Subreddit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditBannedUser.md b/docs/api/public-api/classes/SubredditBannedUser.md index d457725c..ad2481cc 100644 --- a/docs/api/public-api/classes/SubredditBannedUser.md +++ b/docs/api/public-api/classes/SubredditBannedUser.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditContributorUser.md b/docs/api/public-api/classes/SubredditContributorUser.md index d78c099a..cdd8a74b 100644 --- a/docs/api/public-api/classes/SubredditContributorUser.md +++ b/docs/api/public-api/classes/SubredditContributorUser.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditDescription.md b/docs/api/public-api/classes/SubredditDescription.md index 537068ff..1769b146 100644 --- a/docs/api/public-api/classes/SubredditDescription.md +++ b/docs/api/public-api/classes/SubredditDescription.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditModeratorUser.md b/docs/api/public-api/classes/SubredditModeratorUser.md index aba581a1..c303d4cb 100644 --- a/docs/api/public-api/classes/SubredditModeratorUser.md +++ b/docs/api/public-api/classes/SubredditModeratorUser.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditMutedUser.md b/docs/api/public-api/classes/SubredditMutedUser.md index 17c45d22..0e10dc23 100644 --- a/docs/api/public-api/classes/SubredditMutedUser.md +++ b/docs/api/public-api/classes/SubredditMutedUser.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditRulesWidget.md b/docs/api/public-api/classes/SubredditRulesWidget.md index f56709ed..4f7bf4a8 100644 --- a/docs/api/public-api/classes/SubredditRulesWidget.md +++ b/docs/api/public-api/classes/SubredditRulesWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditWikiBannedUser.md b/docs/api/public-api/classes/SubredditWikiBannedUser.md index 498474ce..80ae5951 100644 --- a/docs/api/public-api/classes/SubredditWikiBannedUser.md +++ b/docs/api/public-api/classes/SubredditWikiBannedUser.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditWikiContributorUser.md b/docs/api/public-api/classes/SubredditWikiContributorUser.md index 55cef6d3..1fbbbfdf 100644 --- a/docs/api/public-api/classes/SubredditWikiContributorUser.md +++ b/docs/api/public-api/classes/SubredditWikiContributorUser.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/SubredditWikiSettings.md b/docs/api/public-api/classes/SubredditWikiSettings.md index 3837dd0d..de6bd870 100644 --- a/docs/api/public-api/classes/SubredditWikiSettings.md +++ b/docs/api/public-api/classes/SubredditWikiSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/TextAreaWidget.md b/docs/api/public-api/classes/TextAreaWidget.md index 4524e573..e9d5c5b6 100644 --- a/docs/api/public-api/classes/TextAreaWidget.md +++ b/docs/api/public-api/classes/TextAreaWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/User.md b/docs/api/public-api/classes/User.md index 4de5fcbc..204f6c05 100644 --- a/docs/api/public-api/classes/User.md +++ b/docs/api/public-api/classes/User.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/Widget.md b/docs/api/public-api/classes/Widget.md index 5bb39864..02edfe1d 100644 --- a/docs/api/public-api/classes/Widget.md +++ b/docs/api/public-api/classes/Widget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/WikiPage.md b/docs/api/public-api/classes/WikiPage.md index fd757728..72402389 100644 --- a/docs/api/public-api/classes/WikiPage.md +++ b/docs/api/public-api/classes/WikiPage.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/WikiPageRevision.md b/docs/api/public-api/classes/WikiPageRevision.md index 18840b33..4f735e2e 100644 --- a/docs/api/public-api/classes/WikiPageRevision.md +++ b/docs/api/public-api/classes/WikiPageRevision.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/classes/WikiPageSettings.md b/docs/api/public-api/classes/WikiPageSettings.md index a5631ba7..f3ea8414 100644 --- a/docs/api/public-api/classes/WikiPageSettings.md +++ b/docs/api/public-api/classes/WikiPageSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/AboutLocations.md b/docs/api/public-api/enumerations/AboutLocations.md index 0b62d78e..ea533f91 100644 --- a/docs/api/public-api/enumerations/AboutLocations.md +++ b/docs/api/public-api/enumerations/AboutLocations.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/DeletionReason.md b/docs/api/public-api/enumerations/DeletionReason.md index abacf225..f9a91f94 100644 --- a/docs/api/public-api/enumerations/DeletionReason.md +++ b/docs/api/public-api/enumerations/DeletionReason.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/EntrypointHeight.md b/docs/api/public-api/enumerations/EntrypointHeight.md index 760fcf7c..9d1e2a57 100644 --- a/docs/api/public-api/enumerations/EntrypointHeight.md +++ b/docs/api/public-api/enumerations/EntrypointHeight.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/EventSource.md b/docs/api/public-api/enumerations/EventSource.md index 988a11f4..462d7bd8 100644 --- a/docs/api/public-api/enumerations/EventSource.md +++ b/docs/api/public-api/enumerations/EventSource.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/FlairType.md b/docs/api/public-api/enumerations/FlairType.md index 332118c0..8335ffba 100644 --- a/docs/api/public-api/enumerations/FlairType.md +++ b/docs/api/public-api/enumerations/FlairType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/FormattingFlag.md b/docs/api/public-api/enumerations/FormattingFlag.md index 1f21b0a9..90b342d5 100644 --- a/docs/api/public-api/enumerations/FormattingFlag.md +++ b/docs/api/public-api/enumerations/FormattingFlag.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/ModMailActionType.md b/docs/api/public-api/enumerations/ModMailActionType.md index 3eb61cd9..11edf8b5 100644 --- a/docs/api/public-api/enumerations/ModMailActionType.md +++ b/docs/api/public-api/enumerations/ModMailActionType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/ModMailConversationState.md b/docs/api/public-api/enumerations/ModMailConversationState.md index c149cb1e..787dded3 100644 --- a/docs/api/public-api/enumerations/ModMailConversationState.md +++ b/docs/api/public-api/enumerations/ModMailConversationState.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/SettingScope.md b/docs/api/public-api/enumerations/SettingScope.md index 1764466c..665fb9c1 100644 --- a/docs/api/public-api/enumerations/SettingScope.md +++ b/docs/api/public-api/enumerations/SettingScope.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/SocialLinkType.md b/docs/api/public-api/enumerations/SocialLinkType.md index 9aae3994..85766c1c 100644 --- a/docs/api/public-api/enumerations/SocialLinkType.md +++ b/docs/api/public-api/enumerations/SocialLinkType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/WikiPagePermissionLevel.md b/docs/api/public-api/enumerations/WikiPagePermissionLevel.md index 9ccd9716..c91448cb 100644 --- a/docs/api/public-api/enumerations/WikiPagePermissionLevel.md +++ b/docs/api/public-api/enumerations/WikiPagePermissionLevel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/functions/getModerationLog.md b/docs/api/public-api/functions/getModerationLog.md index 8adab2e2..81ec2d79 100644 --- a/docs/api/public-api/functions/getModerationLog.md +++ b/docs/api/public-api/functions/getModerationLog.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/functions/getSubredditInfoById.md b/docs/api/public-api/functions/getSubredditInfoById.md index 7aba0719..a3bf6386 100644 --- a/docs/api/public-api/functions/getSubredditInfoById.md +++ b/docs/api/public-api/functions/getSubredditInfoById.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/functions/getSubredditInfoByName.md b/docs/api/public-api/functions/getSubredditInfoByName.md index 0e9d8aae..fe46b6a9 100644 --- a/docs/api/public-api/functions/getSubredditInfoByName.md +++ b/docs/api/public-api/functions/getSubredditInfoByName.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/functions/getSubredditLeaderboard.md b/docs/api/public-api/functions/getSubredditLeaderboard.md index 461bfc5b..8aacc9f6 100644 --- a/docs/api/public-api/functions/getSubredditLeaderboard.md +++ b/docs/api/public-api/functions/getSubredditLeaderboard.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/functions/getSubredditStyles.md b/docs/api/public-api/functions/getSubredditStyles.md index a6abb691..5fbc720b 100644 --- a/docs/api/public-api/functions/getSubredditStyles.md +++ b/docs/api/public-api/functions/getSubredditStyles.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/functions/getVaultByAddress.md b/docs/api/public-api/functions/getVaultByAddress.md index fc5e44e2..d0418614 100644 --- a/docs/api/public-api/functions/getVaultByAddress.md +++ b/docs/api/public-api/functions/getVaultByAddress.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/functions/getVaultByUserId.md b/docs/api/public-api/functions/getVaultByUserId.md index d5a83896..f6f8ca67 100644 --- a/docs/api/public-api/functions/getVaultByUserId.md +++ b/docs/api/public-api/functions/getVaultByUserId.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/BlockQuoteContext.md b/docs/api/public-api/interfaces/BlockQuoteContext.md index b504b2f8..f448fd27 100644 --- a/docs/api/public-api/interfaces/BlockQuoteContext.md +++ b/docs/api/public-api/interfaces/BlockQuoteContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/CodeBlockContext.md b/docs/api/public-api/interfaces/CodeBlockContext.md index bc021b6c..489926f5 100644 --- a/docs/api/public-api/interfaces/CodeBlockContext.md +++ b/docs/api/public-api/interfaces/CodeBlockContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/HeadingContext.md b/docs/api/public-api/interfaces/HeadingContext.md index bb6d6d8b..2f3427bd 100644 --- a/docs/api/public-api/interfaces/HeadingContext.md +++ b/docs/api/public-api/interfaces/HeadingContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/ListContext.md b/docs/api/public-api/interfaces/ListContext.md index f0c28c60..f92fb3a8 100644 --- a/docs/api/public-api/interfaces/ListContext.md +++ b/docs/api/public-api/interfaces/ListContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/ListItemContext.md b/docs/api/public-api/interfaces/ListItemContext.md index 62af3386..636a7e0f 100644 --- a/docs/api/public-api/interfaces/ListItemContext.md +++ b/docs/api/public-api/interfaces/ListItemContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/ModAction.md b/docs/api/public-api/interfaces/ModAction.md index f6c32ae0..fa375173 100644 --- a/docs/api/public-api/interfaces/ModAction.md +++ b/docs/api/public-api/interfaces/ModAction.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/ParagraphContext.md b/docs/api/public-api/interfaces/ParagraphContext.md index 8362f08c..7caeb60e 100644 --- a/docs/api/public-api/interfaces/ParagraphContext.md +++ b/docs/api/public-api/interfaces/ParagraphContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/SpoilerContext.md b/docs/api/public-api/interfaces/SpoilerContext.md index 87e0e68b..f7449609 100644 --- a/docs/api/public-api/interfaces/SpoilerContext.md +++ b/docs/api/public-api/interfaces/SpoilerContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/TableCellContext.md b/docs/api/public-api/interfaces/TableCellContext.md index cc3b1160..ff19895c 100644 --- a/docs/api/public-api/interfaces/TableCellContext.md +++ b/docs/api/public-api/interfaces/TableCellContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/TableContext.md b/docs/api/public-api/interfaces/TableContext.md index bc7ff35c..ae57244a 100644 --- a/docs/api/public-api/interfaces/TableContext.md +++ b/docs/api/public-api/interfaces/TableContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/TableRowContext.md b/docs/api/public-api/interfaces/TableRowContext.md index 7084e445..608b64ed 100644 --- a/docs/api/public-api/interfaces/TableRowContext.md +++ b/docs/api/public-api/interfaces/TableRowContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/interfaces/TxClientLike.md b/docs/api/public-api/interfaces/TxClientLike.md index 3917b463..b1126793 100644 --- a/docs/api/public-api/interfaces/TxClientLike.md +++ b/docs/api/public-api/interfaces/TxClientLike.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AboutSubredditTypes.md b/docs/api/public-api/type-aliases/AboutSubredditTypes.md index f01b90fc..b43e2e20 100644 --- a/docs/api/public-api/type-aliases/AboutSubredditTypes.md +++ b/docs/api/public-api/type-aliases/AboutSubredditTypes.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AddRemovalNoteOptions.md b/docs/api/public-api/type-aliases/AddRemovalNoteOptions.md index 1f8ba6f8..69d94cc0 100644 --- a/docs/api/public-api/type-aliases/AddRemovalNoteOptions.md +++ b/docs/api/public-api/type-aliases/AddRemovalNoteOptions.md @@ -1,7 +1,42 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** # Type Alias: AddRemovalNoteOptions -> **AddRemovalNoteOptions** = `Prettify`\<`PostRemovalNoteRequest`\> +> **AddRemovalNoteOptions** = `object` + +Options for adding a note that explains why posts or comments were removed. + +## Properties + + + +### itemIds + +> **itemIds**: `string`[] + +The IDs of the removed posts or comments. + +*** + + + +### modNote? + +> `optional` **modNote**: `string` + +The note explaining the removal. The maximum length is 100 characters. + +The plugin omits this field when it is `undefined` or an empty string. + +*** + + + +### reasonId + +> **reasonId**: `string` + +The removal reason identifier, or an empty string when no removal reason is +used. diff --git a/docs/api/public-api/type-aliases/AddWidgetData.md b/docs/api/public-api/type-aliases/AddWidgetData.md index 4ca24759..41191d96 100644 --- a/docs/api/public-api/type-aliases/AddWidgetData.md +++ b/docs/api/public-api/type-aliases/AddWidgetData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AllowableFlairContent.md b/docs/api/public-api/type-aliases/AllowableFlairContent.md index b554414f..cd3e8c23 100644 --- a/docs/api/public-api/type-aliases/AllowableFlairContent.md +++ b/docs/api/public-api/type-aliases/AllowableFlairContent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AnimatedImage.md b/docs/api/public-api/type-aliases/AnimatedImage.md index c0fc425b..41782e86 100644 --- a/docs/api/public-api/type-aliases/AnimatedImage.md +++ b/docs/api/public-api/type-aliases/AnimatedImage.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AppInstall.md b/docs/api/public-api/type-aliases/AppInstall.md index 36ba85dd..831ba5f4 100644 --- a/docs/api/public-api/type-aliases/AppInstall.md +++ b/docs/api/public-api/type-aliases/AppInstall.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AppInstallDefinition.md b/docs/api/public-api/type-aliases/AppInstallDefinition.md index 06dfc60c..56fe449f 100644 --- a/docs/api/public-api/type-aliases/AppInstallDefinition.md +++ b/docs/api/public-api/type-aliases/AppInstallDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AppUpgrade.md b/docs/api/public-api/type-aliases/AppUpgrade.md index 656609dd..72d063a0 100644 --- a/docs/api/public-api/type-aliases/AppUpgrade.md +++ b/docs/api/public-api/type-aliases/AppUpgrade.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AppUpgradeDefinition.md b/docs/api/public-api/type-aliases/AppUpgradeDefinition.md index a8d130d7..5ba07560 100644 --- a/docs/api/public-api/type-aliases/AppUpgradeDefinition.md +++ b/docs/api/public-api/type-aliases/AppUpgradeDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AutomoderatorFilterComment.md b/docs/api/public-api/type-aliases/AutomoderatorFilterComment.md index db2fc9f3..2047ece3 100644 --- a/docs/api/public-api/type-aliases/AutomoderatorFilterComment.md +++ b/docs/api/public-api/type-aliases/AutomoderatorFilterComment.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AutomoderatorFilterPost.md b/docs/api/public-api/type-aliases/AutomoderatorFilterPost.md index f0892e1f..72cda0d0 100644 --- a/docs/api/public-api/type-aliases/AutomoderatorFilterPost.md +++ b/docs/api/public-api/type-aliases/AutomoderatorFilterPost.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BackgroundImagePosition.md b/docs/api/public-api/type-aliases/BackgroundImagePosition.md index 81d59291..b6575ab0 100644 --- a/docs/api/public-api/type-aliases/BackgroundImagePosition.md +++ b/docs/api/public-api/type-aliases/BackgroundImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BanUserOptions.md b/docs/api/public-api/type-aliases/BanUserOptions.md index 262d9929..6b3770e9 100644 --- a/docs/api/public-api/type-aliases/BanUserOptions.md +++ b/docs/api/public-api/type-aliases/BanUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BanWikiContributorOptions.md b/docs/api/public-api/type-aliases/BanWikiContributorOptions.md index 1dd2c2c5..57947729 100644 --- a/docs/api/public-api/type-aliases/BanWikiContributorOptions.md +++ b/docs/api/public-api/type-aliases/BanWikiContributorOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BannerHeight.md b/docs/api/public-api/type-aliases/BannerHeight.md index 408b84f1..a04df628 100644 --- a/docs/api/public-api/type-aliases/BannerHeight.md +++ b/docs/api/public-api/type-aliases/BannerHeight.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BaseContext.md b/docs/api/public-api/type-aliases/BaseContext.md index 0ac74fc6..77cccb0e 100644 --- a/docs/api/public-api/type-aliases/BaseContext.md +++ b/docs/api/public-api/type-aliases/BaseContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BaseField.md b/docs/api/public-api/type-aliases/BaseField.md index b10e6407..513d3338 100644 --- a/docs/api/public-api/type-aliases/BaseField.md +++ b/docs/api/public-api/type-aliases/BaseField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BitfieldCommand.md b/docs/api/public-api/type-aliases/BitfieldCommand.md index 7519062a..f420762a 100644 --- a/docs/api/public-api/type-aliases/BitfieldCommand.md +++ b/docs/api/public-api/type-aliases/BitfieldCommand.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BlockQuote.md b/docs/api/public-api/type-aliases/BlockQuote.md index 04154d74..e5c8c5ea 100644 --- a/docs/api/public-api/type-aliases/BlockQuote.md +++ b/docs/api/public-api/type-aliases/BlockQuote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BlockQuoteContainer.md b/docs/api/public-api/type-aliases/BlockQuoteContainer.md index 45d617e0..fc789bd0 100644 --- a/docs/api/public-api/type-aliases/BlockQuoteContainer.md +++ b/docs/api/public-api/type-aliases/BlockQuoteContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BlockQuoteNode.md b/docs/api/public-api/type-aliases/BlockQuoteNode.md index 84b3b0cb..c461da4b 100644 --- a/docs/api/public-api/type-aliases/BlockQuoteNode.md +++ b/docs/api/public-api/type-aliases/BlockQuoteNode.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BlockQuoteOptions.md b/docs/api/public-api/type-aliases/BlockQuoteOptions.md index 7d56e59c..998d6a32 100644 --- a/docs/api/public-api/type-aliases/BlockQuoteOptions.md +++ b/docs/api/public-api/type-aliases/BlockQuoteOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BooleanField.md b/docs/api/public-api/type-aliases/BooleanField.md index 49a0457e..e7f5e7ff 100644 --- a/docs/api/public-api/type-aliases/BooleanField.md +++ b/docs/api/public-api/type-aliases/BooleanField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CancelJob.md b/docs/api/public-api/type-aliases/CancelJob.md index e072c4b4..695457bf 100644 --- a/docs/api/public-api/type-aliases/CancelJob.md +++ b/docs/api/public-api/type-aliases/CancelJob.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CodeBlock.md b/docs/api/public-api/type-aliases/CodeBlock.md index 3485db85..8bf99e27 100644 --- a/docs/api/public-api/type-aliases/CodeBlock.md +++ b/docs/api/public-api/type-aliases/CodeBlock.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CodeBlockContainer.md b/docs/api/public-api/type-aliases/CodeBlockContainer.md index c295d43f..7ffda6bb 100644 --- a/docs/api/public-api/type-aliases/CodeBlockContainer.md +++ b/docs/api/public-api/type-aliases/CodeBlockContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CodeBlockOptions.md b/docs/api/public-api/type-aliases/CodeBlockOptions.md index 5c63ab1c..71bb51b8 100644 --- a/docs/api/public-api/type-aliases/CodeBlockOptions.md +++ b/docs/api/public-api/type-aliases/CodeBlockOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ColumnAlignment.md b/docs/api/public-api/type-aliases/ColumnAlignment.md index f6f35deb..66769669 100644 --- a/docs/api/public-api/type-aliases/ColumnAlignment.md +++ b/docs/api/public-api/type-aliases/ColumnAlignment.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentCreate.md b/docs/api/public-api/type-aliases/CommentCreate.md index 7518a4dc..b5feee5a 100644 --- a/docs/api/public-api/type-aliases/CommentCreate.md +++ b/docs/api/public-api/type-aliases/CommentCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentCreateDefinition.md b/docs/api/public-api/type-aliases/CommentCreateDefinition.md index 127264ba..14381d27 100644 --- a/docs/api/public-api/type-aliases/CommentCreateDefinition.md +++ b/docs/api/public-api/type-aliases/CommentCreateDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentDelete.md b/docs/api/public-api/type-aliases/CommentDelete.md index d8014b21..d8904742 100644 --- a/docs/api/public-api/type-aliases/CommentDelete.md +++ b/docs/api/public-api/type-aliases/CommentDelete.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentDeleteDefinition.md b/docs/api/public-api/type-aliases/CommentDeleteDefinition.md index a0d0a81d..0d0021e7 100644 --- a/docs/api/public-api/type-aliases/CommentDeleteDefinition.md +++ b/docs/api/public-api/type-aliases/CommentDeleteDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentLink.md b/docs/api/public-api/type-aliases/CommentLink.md index 1ba9d1aa..caff5292 100644 --- a/docs/api/public-api/type-aliases/CommentLink.md +++ b/docs/api/public-api/type-aliases/CommentLink.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentLinkOptions.md b/docs/api/public-api/type-aliases/CommentLinkOptions.md index c835203a..a8fd54ba 100644 --- a/docs/api/public-api/type-aliases/CommentLinkOptions.md +++ b/docs/api/public-api/type-aliases/CommentLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentMediaTypes.md b/docs/api/public-api/type-aliases/CommentMediaTypes.md index 53360961..0a1417ce 100644 --- a/docs/api/public-api/type-aliases/CommentMediaTypes.md +++ b/docs/api/public-api/type-aliases/CommentMediaTypes.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentReport.md b/docs/api/public-api/type-aliases/CommentReport.md index ab3c24ca..da6738f0 100644 --- a/docs/api/public-api/type-aliases/CommentReport.md +++ b/docs/api/public-api/type-aliases/CommentReport.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentReportDefinition.md b/docs/api/public-api/type-aliases/CommentReportDefinition.md index 41907442..d1848226 100644 --- a/docs/api/public-api/type-aliases/CommentReportDefinition.md +++ b/docs/api/public-api/type-aliases/CommentReportDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentSort.md b/docs/api/public-api/type-aliases/CommentSort.md index b2a4d14d..35f5e2fd 100644 --- a/docs/api/public-api/type-aliases/CommentSort.md +++ b/docs/api/public-api/type-aliases/CommentSort.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentSubmissionOptions.md b/docs/api/public-api/type-aliases/CommentSubmissionOptions.md index c830212e..12c5cd8c 100644 --- a/docs/api/public-api/type-aliases/CommentSubmissionOptions.md +++ b/docs/api/public-api/type-aliases/CommentSubmissionOptions.md @@ -1,7 +1,41 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** # Type Alias: CommentSubmissionOptions > **CommentSubmissionOptions** = \{ `runAs`: `"USER"` \| `"APP"`; `text`: `string`; \} \| \{ `richtext`: `object` \| [`RichTextBuilder`](../classes/RichTextBuilder.md); `runAs`: `"USER"` \| `"APP"`; \} + +Options for submitting a comment body. + +## Type declaration + +\{ `runAs`: `"USER"` \| `"APP"`; `text`: `string`; \} + +### runAs? + +> `optional` **runAs**: `"USER"` \| `"APP"` + +The account used to create the comment. Defaults to the app account. +This option is ignored by [Comment.edit](../classes/Comment.md#edit). + +### text + +> **text**: `string` + +The comment body in Markdown. + +\{ `richtext`: `object` \| [`RichTextBuilder`](../classes/RichTextBuilder.md); `runAs`: `"USER"` \| `"APP"`; \} + +### richtext + +> **richtext**: `object` \| [`RichTextBuilder`](../classes/RichTextBuilder.md) + +The comment body as rich text. + +### runAs? + +> `optional` **runAs**: `"USER"` \| `"APP"` + +The account used to create the comment. Defaults to the app account. +This option is ignored by [Comment.edit](../classes/Comment.md#edit). diff --git a/docs/api/public-api/type-aliases/CommentSubmit.md b/docs/api/public-api/type-aliases/CommentSubmit.md index daf19e52..7131d2bf 100644 --- a/docs/api/public-api/type-aliases/CommentSubmit.md +++ b/docs/api/public-api/type-aliases/CommentSubmit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentSubmitDefinition.md b/docs/api/public-api/type-aliases/CommentSubmitDefinition.md index c1bb5e6c..f9691450 100644 --- a/docs/api/public-api/type-aliases/CommentSubmitDefinition.md +++ b/docs/api/public-api/type-aliases/CommentSubmitDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentUpdate.md b/docs/api/public-api/type-aliases/CommentUpdate.md index e52d9825..8bc08d09 100644 --- a/docs/api/public-api/type-aliases/CommentUpdate.md +++ b/docs/api/public-api/type-aliases/CommentUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentUpdateDefinition.md b/docs/api/public-api/type-aliases/CommentUpdateDefinition.md index 56ff1330..0b240fa5 100644 --- a/docs/api/public-api/type-aliases/CommentUpdateDefinition.md +++ b/docs/api/public-api/type-aliases/CommentUpdateDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommonFlair.md b/docs/api/public-api/type-aliases/CommonFlair.md index e0687033..ada8272a 100644 --- a/docs/api/public-api/type-aliases/CommonFlair.md +++ b/docs/api/public-api/type-aliases/CommonFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommonSubmitPostOptions.md b/docs/api/public-api/type-aliases/CommonSubmitPostOptions.md index dd5f8d50..604ea17e 100644 --- a/docs/api/public-api/type-aliases/CommonSubmitPostOptions.md +++ b/docs/api/public-api/type-aliases/CommonSubmitPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -14,6 +14,8 @@ > `optional` **flairId**: `string` +The flair template to apply to the new post. + *** @@ -22,6 +24,8 @@ > `optional` **flairText**: `string` +The flair text to apply to the new post. + *** @@ -30,6 +34,8 @@ > `optional` **nsfw**: `boolean` +Whether to mark the new post as NSFW. + *** @@ -38,6 +44,8 @@ > `optional` **runAs**: `"USER"` \| `"APP"` +The account that creates the post. Defaults to the app account. + *** @@ -46,6 +54,8 @@ > `optional` **sendreplies**: `boolean` +Whether the author receives notifications for new comments. + *** @@ -54,6 +64,8 @@ > `optional` **spoiler**: `boolean` +Whether to mark the new post as a spoiler. + *** @@ -61,3 +73,5 @@ ### title > **title**: `string` + +The title of the new post. diff --git a/docs/api/public-api/type-aliases/CommunityNameFormat.md b/docs/api/public-api/type-aliases/CommunityNameFormat.md index c3645c43..8511f56b 100644 --- a/docs/api/public-api/type-aliases/CommunityNameFormat.md +++ b/docs/api/public-api/type-aliases/CommunityNameFormat.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Configuration.md b/docs/api/public-api/type-aliases/Configuration.md index e9d2fb85..1780ad01 100644 --- a/docs/api/public-api/type-aliases/Configuration.md +++ b/docs/api/public-api/type-aliases/Configuration.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Context.md b/docs/api/public-api/type-aliases/Context.md index 65166ea9..b7451fa6 100644 --- a/docs/api/public-api/type-aliases/Context.md +++ b/docs/api/public-api/type-aliases/Context.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ContextAPIClients.md b/docs/api/public-api/type-aliases/ContextAPIClients.md index c35702e9..068dc077 100644 --- a/docs/api/public-api/type-aliases/ContextAPIClients.md +++ b/docs/api/public-api/type-aliases/ContextAPIClients.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ContextDebugInfo.md b/docs/api/public-api/type-aliases/ContextDebugInfo.md index 56b0672e..749d6ca4 100644 --- a/docs/api/public-api/type-aliases/ContextDebugInfo.md +++ b/docs/api/public-api/type-aliases/ContextDebugInfo.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ConversationData.md b/docs/api/public-api/type-aliases/ConversationData.md index a18a0292..55852694 100644 --- a/docs/api/public-api/type-aliases/ConversationData.md +++ b/docs/api/public-api/type-aliases/ConversationData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ConversationResponse.md b/docs/api/public-api/type-aliases/ConversationResponse.md index b21bf2a0..4a4265af 100644 --- a/docs/api/public-api/type-aliases/ConversationResponse.md +++ b/docs/api/public-api/type-aliases/ConversationResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ConversationStateFilter.md b/docs/api/public-api/type-aliases/ConversationStateFilter.md index fd62d954..ad36fb1e 100644 --- a/docs/api/public-api/type-aliases/ConversationStateFilter.md +++ b/docs/api/public-api/type-aliases/ConversationStateFilter.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ConversationUserData.md b/docs/api/public-api/type-aliases/ConversationUserData.md index 707fd939..b1c6e05d 100644 --- a/docs/api/public-api/type-aliases/ConversationUserData.md +++ b/docs/api/public-api/type-aliases/ConversationUserData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CreateFlairTemplateOptions.md b/docs/api/public-api/type-aliases/CreateFlairTemplateOptions.md index 02b09630..be44b7f2 100644 --- a/docs/api/public-api/type-aliases/CreateFlairTemplateOptions.md +++ b/docs/api/public-api/type-aliases/CreateFlairTemplateOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CreateModNoteOptions.md b/docs/api/public-api/type-aliases/CreateModNoteOptions.md index 745d9174..f73c4b52 100644 --- a/docs/api/public-api/type-aliases/CreateModNoteOptions.md +++ b/docs/api/public-api/type-aliases/CreateModNoteOptions.md @@ -1,7 +1,59 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** # Type Alias: CreateModNoteOptions -> **CreateModNoteOptions** = `Prettify`\<`PostNotesRequest` & `object`\> +> **CreateModNoteOptions** = `object` + +Options for adding a moderation note to a user. + +## Properties + + + +### label? + +> `optional` **label**: [`UserNoteLabel`](UserNoteLabel.md) + +A label that categorizes the moderation note. + +*** + + + +### note + +> **note**: `string` + +The text of the moderation note. The maximum length is 250 characters. + +*** + + + +### redditId? + +> `optional` **redditId**: `T1` \| `T3` + +The comment or post associated with the moderation note. + +*** + + + +### subreddit + +> **subreddit**: `string` + +The subreddit name without the leading `r/`. + +*** + + + +### user + +> **user**: `string` + +The username without the leading `u/`. diff --git a/docs/api/public-api/type-aliases/CreateRelationshipOptions.md b/docs/api/public-api/type-aliases/CreateRelationshipOptions.md index 212f5b0b..28092577 100644 --- a/docs/api/public-api/type-aliases/CreateRelationshipOptions.md +++ b/docs/api/public-api/type-aliases/CreateRelationshipOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CreateRuleOptions.md b/docs/api/public-api/type-aliases/CreateRuleOptions.md index 52a0e68d..ebeccc62 100644 --- a/docs/api/public-api/type-aliases/CreateRuleOptions.md +++ b/docs/api/public-api/type-aliases/CreateRuleOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CreateWikiPageOptions.md b/docs/api/public-api/type-aliases/CreateWikiPageOptions.md index 959c16a3..48d18a26 100644 --- a/docs/api/public-api/type-aliases/CreateWikiPageOptions.md +++ b/docs/api/public-api/type-aliases/CreateWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CrosspostOptions.md b/docs/api/public-api/type-aliases/CrosspostOptions.md index 05cf646a..523ee144 100644 --- a/docs/api/public-api/type-aliases/CrosspostOptions.md +++ b/docs/api/public-api/type-aliases/CrosspostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -6,6 +6,8 @@ > **CrosspostOptions** = [`CommonSubmitPostOptions`](CommonSubmitPostOptions.md) & `Required`\<[`SubredditOptions`](SubredditOptions.md)\> & `object` +Options for creating a crosspost. + ## Type declaration ### postId diff --git a/docs/api/public-api/type-aliases/CrowdControlLevel.md b/docs/api/public-api/type-aliases/CrowdControlLevel.md index 208a76c8..f25b01bc 100644 --- a/docs/api/public-api/type-aliases/CrowdControlLevel.md +++ b/docs/api/public-api/type-aliases/CrowdControlLevel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -6,8 +6,11 @@ > **CrowdControlLevel** = `"OFF"` \| `"LENIENT"` \| `"MEDIUM"` \| `"STRICT"` -Crowd control level for posts. Determines which comments should be collapsed due to crowd control. -OFF: Anyone with a Reddit account can comment freely. -LENIENT: Collapse comments from people who have negative karma in your community. -MEDIUM: Collapse comments from new Reddit users and people with negative karma in your community. -STRICT: Collapse comments from people who haven’t joined your community, new Reddit users, and people with negative karma in your community +Crowd Control threshold for comments on a post. Determines which comments +should be collapsed by default. + +OFF: Do not collapse or filter comments through Crowd Control. +LENIENT: Collapse or filter comments from accounts with negative community + karma. +MEDIUM: LENIENT but also applies to new accounts. +STRICT: MEDIUM but applies to accounts that have not joined the community. diff --git a/docs/api/public-api/type-aliases/CustomPostRichTextFallback.md b/docs/api/public-api/type-aliases/CustomPostRichTextFallback.md index 98cde010..9961a4df 100644 --- a/docs/api/public-api/type-aliases/CustomPostRichTextFallback.md +++ b/docs/api/public-api/type-aliases/CustomPostRichTextFallback.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CustomPostTextFallbackOptions.md b/docs/api/public-api/type-aliases/CustomPostTextFallbackOptions.md index 8beb2357..e31b1ed4 100644 --- a/docs/api/public-api/type-aliases/CustomPostTextFallbackOptions.md +++ b/docs/api/public-api/type-aliases/CustomPostTextFallbackOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -14,10 +14,13 @@ > **text**: `string` -May also include markdown. See https://www.reddit.com/r/reddit.com/wiki/markdown/ +The fallback content as plaintext or Markdown. See +https://www.reddit.com/r/reddit.com/wiki/markdown/. \{ `richtext`: [`CustomPostRichTextFallback`](CustomPostRichTextFallback.md); \} ### richtext > **richtext**: [`CustomPostRichTextFallback`](CustomPostRichTextFallback.md) + +The fallback content as richtext. diff --git a/docs/api/public-api/type-aliases/CustomizationFlag.md b/docs/api/public-api/type-aliases/CustomizationFlag.md index ecef6f5c..6b9d446c 100644 --- a/docs/api/public-api/type-aliases/CustomizationFlag.md +++ b/docs/api/public-api/type-aliases/CustomizationFlag.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Data.md b/docs/api/public-api/type-aliases/Data.md index c1d8770a..4408b491 100644 --- a/docs/api/public-api/type-aliases/Data.md +++ b/docs/api/public-api/type-aliases/Data.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/DeleteNotesOptions.md b/docs/api/public-api/type-aliases/DeleteNotesOptions.md index fa162622..28a39ba7 100644 --- a/docs/api/public-api/type-aliases/DeleteNotesOptions.md +++ b/docs/api/public-api/type-aliases/DeleteNotesOptions.md @@ -1,7 +1,39 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** # Type Alias: DeleteNotesOptions -> **DeleteNotesOptions** = `Prettify`\<`DeleteNotesRequest`\> +> **DeleteNotesOptions** = `object` + +Options for deleting a moderation note. + +## Properties + + + +### noteId + +> **noteId**: `string` + +The unique moderation note identifier, including its `ModNote_` prefix. + +*** + + + +### subreddit + +> **subreddit**: `string` + +The subreddit name without the leading `r/`. + +*** + + + +### user + +> **user**: `string` + +The username without the leading `u/`. diff --git a/docs/api/public-api/type-aliases/DevvitDebug.md b/docs/api/public-api/type-aliases/DevvitDebug.md index 3ffeccf3..9516308f 100644 --- a/docs/api/public-api/type-aliases/DevvitDebug.md +++ b/docs/api/public-api/type-aliases/DevvitDebug.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Document.md b/docs/api/public-api/type-aliases/Document.md index c92a2d9e..ea817a27 100644 --- a/docs/api/public-api/type-aliases/Document.md +++ b/docs/api/public-api/type-aliases/Document.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/DocumentNode.md b/docs/api/public-api/type-aliases/DocumentNode.md index ae558983..60362366 100644 --- a/docs/api/public-api/type-aliases/DocumentNode.md +++ b/docs/api/public-api/type-aliases/DocumentNode.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/EditCommentOptions.md b/docs/api/public-api/type-aliases/EditCommentOptions.md index f560af08..af78f7bb 100644 --- a/docs/api/public-api/type-aliases/EditCommentOptions.md +++ b/docs/api/public-api/type-aliases/EditCommentOptions.md @@ -1,7 +1,9 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** # Type Alias: EditCommentOptions > **EditCommentOptions** = [`CommentSubmissionOptions`](CommentSubmissionOptions.md) + +Options for replacing a comment body. diff --git a/docs/api/public-api/type-aliases/EditFlairTemplateOptions.md b/docs/api/public-api/type-aliases/EditFlairTemplateOptions.md index 6c860655..a34856d7 100644 --- a/docs/api/public-api/type-aliases/EditFlairTemplateOptions.md +++ b/docs/api/public-api/type-aliases/EditFlairTemplateOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Embed.md b/docs/api/public-api/type-aliases/Embed.md index 3503f83a..eb4796f3 100644 --- a/docs/api/public-api/type-aliases/Embed.md +++ b/docs/api/public-api/type-aliases/Embed.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/EmbedContainer.md b/docs/api/public-api/type-aliases/EmbedContainer.md index 96ba8b3e..f81ebe5e 100644 --- a/docs/api/public-api/type-aliases/EmbedContainer.md +++ b/docs/api/public-api/type-aliases/EmbedContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/EmbedOptions.md b/docs/api/public-api/type-aliases/EmbedOptions.md index 0f6e07a8..d43eb8c6 100644 --- a/docs/api/public-api/type-aliases/EmbedOptions.md +++ b/docs/api/public-api/type-aliases/EmbedOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/EnrichedThumbnail.md b/docs/api/public-api/type-aliases/EnrichedThumbnail.md index 95e2fbff..7790815b 100644 --- a/docs/api/public-api/type-aliases/EnrichedThumbnail.md +++ b/docs/api/public-api/type-aliases/EnrichedThumbnail.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -6,7 +6,7 @@ > **EnrichedThumbnail** = `object` -Contains data about a post's thumbnail. Also contains a blurred version if the thumbnail is NSFW. +Contains a post's thumbnail and, for NSFW content, its blurred version. ## Properties @@ -26,7 +26,7 @@ Attribution text for the thumbnail > **image**: `object` -The image used for the thumbnail. May have different resolution from Post.thumbnail +The thumbnail image. Its resolution can differ from [Post.thumbnail](../classes/Post.md#thumbnail). #### height diff --git a/docs/api/public-api/type-aliases/FilterOptions.md b/docs/api/public-api/type-aliases/FilterOptions.md new file mode 100644 index 00000000..e22bb05e --- /dev/null +++ b/docs/api/public-api/type-aliases/FilterOptions.md @@ -0,0 +1,35 @@ +[**@devvit/public-api v0.14.3-dev**](../README.md) + +*** + +# Type Alias: FilterOptions + +> **FilterOptions** = `object` + +## Properties + + + +### keep? + +> `optional` **keep**: `boolean` + +Whether the post or comment remains visible while it is in the moderation +queue. Defaults to `false`. + +*** + + + +### reason? + +> `optional` **reason**: `string` + +The reason shown to moderators in the moderation queue. If [keep](#keep) is +`true`, the reason is also shown on the post or comment. + +#### Example + +```ts +"contains sensitive content" +``` diff --git a/docs/api/public-api/type-aliases/FlairBackgroundColor.md b/docs/api/public-api/type-aliases/FlairBackgroundColor.md index 452e317c..aba571a4 100644 --- a/docs/api/public-api/type-aliases/FlairBackgroundColor.md +++ b/docs/api/public-api/type-aliases/FlairBackgroundColor.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FlairSettings.md b/docs/api/public-api/type-aliases/FlairSettings.md index 1d0e6b1f..884614c9 100644 --- a/docs/api/public-api/type-aliases/FlairSettings.md +++ b/docs/api/public-api/type-aliases/FlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FlairTextColor.md b/docs/api/public-api/type-aliases/FlairTextColor.md index e549b6ef..ed245027 100644 --- a/docs/api/public-api/type-aliases/FlairTextColor.md +++ b/docs/api/public-api/type-aliases/FlairTextColor.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Form.md b/docs/api/public-api/type-aliases/Form.md index f710176f..d5736db2 100644 --- a/docs/api/public-api/type-aliases/Form.md +++ b/docs/api/public-api/type-aliases/Form.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormDefinition.md b/docs/api/public-api/type-aliases/FormDefinition.md index 9cc971f6..91c754f9 100644 --- a/docs/api/public-api/type-aliases/FormDefinition.md +++ b/docs/api/public-api/type-aliases/FormDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormField.md b/docs/api/public-api/type-aliases/FormField.md index 51f730a8..190b9a94 100644 --- a/docs/api/public-api/type-aliases/FormField.md +++ b/docs/api/public-api/type-aliases/FormField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormFieldGroup.md b/docs/api/public-api/type-aliases/FormFieldGroup.md index dfc31dde..42162bcb 100644 --- a/docs/api/public-api/type-aliases/FormFieldGroup.md +++ b/docs/api/public-api/type-aliases/FormFieldGroup.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormFunction.md b/docs/api/public-api/type-aliases/FormFunction.md index 239930b5..374b0ed5 100644 --- a/docs/api/public-api/type-aliases/FormFunction.md +++ b/docs/api/public-api/type-aliases/FormFunction.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormKey.md b/docs/api/public-api/type-aliases/FormKey.md index f0d4ef03..3c083df1 100644 --- a/docs/api/public-api/type-aliases/FormKey.md +++ b/docs/api/public-api/type-aliases/FormKey.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormOnSubmitEvent.md b/docs/api/public-api/type-aliases/FormOnSubmitEvent.md index a7d09676..d0532d2f 100644 --- a/docs/api/public-api/type-aliases/FormOnSubmitEvent.md +++ b/docs/api/public-api/type-aliases/FormOnSubmitEvent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormOnSubmitEventHandler.md b/docs/api/public-api/type-aliases/FormOnSubmitEventHandler.md index 629600a3..c6ca5b9f 100644 --- a/docs/api/public-api/type-aliases/FormOnSubmitEventHandler.md +++ b/docs/api/public-api/type-aliases/FormOnSubmitEventHandler.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormToFormValues.md b/docs/api/public-api/type-aliases/FormToFormValues.md index 68472c1e..9ed2d47b 100644 --- a/docs/api/public-api/type-aliases/FormToFormValues.md +++ b/docs/api/public-api/type-aliases/FormToFormValues.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormValues.md b/docs/api/public-api/type-aliases/FormValues.md index 19b0db7d..0036aa7e 100644 --- a/docs/api/public-api/type-aliases/FormValues.md +++ b/docs/api/public-api/type-aliases/FormValues.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormatOptions.md b/docs/api/public-api/type-aliases/FormatOptions.md index 64bfbfef..1e4e098d 100644 --- a/docs/api/public-api/type-aliases/FormatOptions.md +++ b/docs/api/public-api/type-aliases/FormatOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormatRange.md b/docs/api/public-api/type-aliases/FormatRange.md index c870be49..0d9279b1 100644 --- a/docs/api/public-api/type-aliases/FormatRange.md +++ b/docs/api/public-api/type-aliases/FormatRange.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormattingSpecification.md b/docs/api/public-api/type-aliases/FormattingSpecification.md index 363c7355..80a8e13a 100644 --- a/docs/api/public-api/type-aliases/FormattingSpecification.md +++ b/docs/api/public-api/type-aliases/FormattingSpecification.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GalleryMedia.md b/docs/api/public-api/type-aliases/GalleryMedia.md index 6fc2bb3a..2817452d 100644 --- a/docs/api/public-api/type-aliases/GalleryMedia.md +++ b/docs/api/public-api/type-aliases/GalleryMedia.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -24,7 +24,7 @@ Represents media that the post may contain. > **status**: [`GalleryMediaStatus`](GalleryMediaStatus.md) -Status of the media. Media that were successfully uplaoded will have GalleryMediaStatus.VALID status +The media processing status. Successful uploads have `VALID` status. *** diff --git a/docs/api/public-api/type-aliases/GalleryMediaStatus.md b/docs/api/public-api/type-aliases/GalleryMediaStatus.md index fc57a326..83bb9376 100644 --- a/docs/api/public-api/type-aliases/GalleryMediaStatus.md +++ b/docs/api/public-api/type-aliases/GalleryMediaStatus.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetBestPostsOptions.md b/docs/api/public-api/type-aliases/GetBestPostsOptions.md index ee22e6d2..60c07d90 100644 --- a/docs/api/public-api/type-aliases/GetBestPostsOptions.md +++ b/docs/api/public-api/type-aliases/GetBestPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetCommentsByUserOptions.md b/docs/api/public-api/type-aliases/GetCommentsByUserOptions.md index 5045938d..0106c37f 100644 --- a/docs/api/public-api/type-aliases/GetCommentsByUserOptions.md +++ b/docs/api/public-api/type-aliases/GetCommentsByUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetCommentsOptions.md b/docs/api/public-api/type-aliases/GetCommentsOptions.md index 70735528..c4e53da9 100644 --- a/docs/api/public-api/type-aliases/GetCommentsOptions.md +++ b/docs/api/public-api/type-aliases/GetCommentsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetConversationResponse.md b/docs/api/public-api/type-aliases/GetConversationResponse.md index ad04b9ef..067281f6 100644 --- a/docs/api/public-api/type-aliases/GetConversationResponse.md +++ b/docs/api/public-api/type-aliases/GetConversationResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetConversationsRequest.md b/docs/api/public-api/type-aliases/GetConversationsRequest.md index 43e1184c..8ccd34a8 100644 --- a/docs/api/public-api/type-aliases/GetConversationsRequest.md +++ b/docs/api/public-api/type-aliases/GetConversationsRequest.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetConversationsResponse.md b/docs/api/public-api/type-aliases/GetConversationsResponse.md index 10ba18ec..664de910 100644 --- a/docs/api/public-api/type-aliases/GetConversationsResponse.md +++ b/docs/api/public-api/type-aliases/GetConversationsResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetDuplicatesOptions.md b/docs/api/public-api/type-aliases/GetDuplicatesOptions.md index 28841838..026e2345 100644 --- a/docs/api/public-api/type-aliases/GetDuplicatesOptions.md +++ b/docs/api/public-api/type-aliases/GetDuplicatesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -18,13 +18,13 @@ Only return duplicates that are crossposting this post. > **postId**: `T3` -Post ID with t3_ prefix (e.g. `t3_abc123`). The prefix is stripped internally. +The post identifier. ### show? > `optional` **show**: `string` -Adding the string "all" will show all results regardless of user preferences. +Use `"all"` to include results hidden by the account's preferences. ### sort? diff --git a/docs/api/public-api/type-aliases/GetHotPostsOptions.md b/docs/api/public-api/type-aliases/GetHotPostsOptions.md index c09f3eed..7f2aa9d7 100644 --- a/docs/api/public-api/type-aliases/GetHotPostsOptions.md +++ b/docs/api/public-api/type-aliases/GetHotPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetModNotesOptions.md b/docs/api/public-api/type-aliases/GetModNotesOptions.md index 9c5027e4..fec8fba3 100644 --- a/docs/api/public-api/type-aliases/GetModNotesOptions.md +++ b/docs/api/public-api/type-aliases/GetModNotesOptions.md @@ -1,7 +1,62 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** # Type Alias: GetModNotesOptions -> **GetModNotesOptions** = `Prettify`\<`Pick`\<`GetNotesRequest`, `"subreddit"` \| `"user"`\> & `object` & `Pick`\<[`ListingFetchOptions`](ListingFetchOptions.md), `"limit"` \| `"before"`\>\> +> **GetModNotesOptions** = `object` + +Options for retrieving a user's moderation notes from a subreddit. + +## Properties + + + +### before? + +> `optional` **before**: `string` + +The pagination cursor before which results should be returned. + +*** + + + +### filter? + +> `optional` **filter**: [`ModNoteType`](ModNoteType.md) + +The type of moderation notes to return. Defaults to all types. + +*** + + + +### limit? + +> `optional` **limit**: `number` + +The maximum total number of moderation notes to return. + +Accepts at most 100 notes per request. Omit this option to allow the +listing to paginate beyond the first 100 notes. + +*** + + + +### subreddit + +> **subreddit**: `string` + +The subreddit name without the leading `r/`. + +*** + + + +### user + +> **user**: `string` + +The username without the leading `u/`. diff --git a/docs/api/public-api/type-aliases/GetModerationLogOptions.md b/docs/api/public-api/type-aliases/GetModerationLogOptions.md index 56511cf2..fb17fab5 100644 --- a/docs/api/public-api/type-aliases/GetModerationLogOptions.md +++ b/docs/api/public-api/type-aliases/GetModerationLogOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetPageRevisionsOptions.md b/docs/api/public-api/type-aliases/GetPageRevisionsOptions.md index d81a56ba..7c0c9ba9 100644 --- a/docs/api/public-api/type-aliases/GetPageRevisionsOptions.md +++ b/docs/api/public-api/type-aliases/GetPageRevisionsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetPostsByUserOptions.md b/docs/api/public-api/type-aliases/GetPostsByUserOptions.md index c009ea6e..d378e207 100644 --- a/docs/api/public-api/type-aliases/GetPostsByUserOptions.md +++ b/docs/api/public-api/type-aliases/GetPostsByUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetPostsOptions.md b/docs/api/public-api/type-aliases/GetPostsOptions.md index c6e20805..ae68c622 100644 --- a/docs/api/public-api/type-aliases/GetPostsOptions.md +++ b/docs/api/public-api/type-aliases/GetPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetPostsOptionsWithTimeframe.md b/docs/api/public-api/type-aliases/GetPostsOptionsWithTimeframe.md index b443eafe..d5434f60 100644 --- a/docs/api/public-api/type-aliases/GetPostsOptionsWithTimeframe.md +++ b/docs/api/public-api/type-aliases/GetPostsOptionsWithTimeframe.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetPrivateMessagesOptions.md b/docs/api/public-api/type-aliases/GetPrivateMessagesOptions.md index 735d5dc9..e098b36c 100644 --- a/docs/api/public-api/type-aliases/GetPrivateMessagesOptions.md +++ b/docs/api/public-api/type-aliases/GetPrivateMessagesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetSortedPostsOptions.md b/docs/api/public-api/type-aliases/GetSortedPostsOptions.md index 7dadf5d8..a582b308 100644 --- a/docs/api/public-api/type-aliases/GetSortedPostsOptions.md +++ b/docs/api/public-api/type-aliases/GetSortedPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetSubredditUsersByTypeOptions.md b/docs/api/public-api/type-aliases/GetSubredditUsersByTypeOptions.md index f0bc45b7..f945d26c 100644 --- a/docs/api/public-api/type-aliases/GetSubredditUsersByTypeOptions.md +++ b/docs/api/public-api/type-aliases/GetSubredditUsersByTypeOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetSubscribedSubredditsForCurrentUserOptions.md b/docs/api/public-api/type-aliases/GetSubscribedSubredditsForCurrentUserOptions.md index f48a6f3f..21c82a4a 100644 --- a/docs/api/public-api/type-aliases/GetSubscribedSubredditsForCurrentUserOptions.md +++ b/docs/api/public-api/type-aliases/GetSubscribedSubredditsForCurrentUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetUserFlairBySubredditOptions.md b/docs/api/public-api/type-aliases/GetUserFlairBySubredditOptions.md index 820ed87f..9bdea106 100644 --- a/docs/api/public-api/type-aliases/GetUserFlairBySubredditOptions.md +++ b/docs/api/public-api/type-aliases/GetUserFlairBySubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetUserFlairBySubredditResponse.md b/docs/api/public-api/type-aliases/GetUserFlairBySubredditResponse.md index 8969ae10..56edb7ad 100644 --- a/docs/api/public-api/type-aliases/GetUserFlairBySubredditResponse.md +++ b/docs/api/public-api/type-aliases/GetUserFlairBySubredditResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetUserFlairOptions.md b/docs/api/public-api/type-aliases/GetUserFlairOptions.md index a472f931..66fd9feb 100644 --- a/docs/api/public-api/type-aliases/GetUserFlairOptions.md +++ b/docs/api/public-api/type-aliases/GetUserFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetUserOverviewOptions.md b/docs/api/public-api/type-aliases/GetUserOverviewOptions.md index ef9519e8..97dcde6b 100644 --- a/docs/api/public-api/type-aliases/GetUserOverviewOptions.md +++ b/docs/api/public-api/type-aliases/GetUserOverviewOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/GetWikiPageOptions.md b/docs/api/public-api/type-aliases/GetWikiPageOptions.md index a39c037f..f7d8fe53 100644 --- a/docs/api/public-api/type-aliases/GetWikiPageOptions.md +++ b/docs/api/public-api/type-aliases/GetWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Heading.md b/docs/api/public-api/type-aliases/Heading.md index c46cef0b..cfe67108 100644 --- a/docs/api/public-api/type-aliases/Heading.md +++ b/docs/api/public-api/type-aliases/Heading.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/HeadingContainer.md b/docs/api/public-api/type-aliases/HeadingContainer.md index 15430e0a..a9189758 100644 --- a/docs/api/public-api/type-aliases/HeadingContainer.md +++ b/docs/api/public-api/type-aliases/HeadingContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/HeadingLevel.md b/docs/api/public-api/type-aliases/HeadingLevel.md index b4dbb545..83c21596 100644 --- a/docs/api/public-api/type-aliases/HeadingLevel.md +++ b/docs/api/public-api/type-aliases/HeadingLevel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/HeadingOptions.md b/docs/api/public-api/type-aliases/HeadingOptions.md index ebdcd850..ad654ba8 100644 --- a/docs/api/public-api/type-aliases/HeadingOptions.md +++ b/docs/api/public-api/type-aliases/HeadingOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/HeadingText.md b/docs/api/public-api/type-aliases/HeadingText.md index b64bca95..8f555c91 100644 --- a/docs/api/public-api/type-aliases/HeadingText.md +++ b/docs/api/public-api/type-aliases/HeadingText.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/HorizontalRule.md b/docs/api/public-api/type-aliases/HorizontalRule.md index a188957a..fc866329 100644 --- a/docs/api/public-api/type-aliases/HorizontalRule.md +++ b/docs/api/public-api/type-aliases/HorizontalRule.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/HorizontalRuleContainer.md b/docs/api/public-api/type-aliases/HorizontalRuleContainer.md index 00d500ff..a4159580 100644 --- a/docs/api/public-api/type-aliases/HorizontalRuleContainer.md +++ b/docs/api/public-api/type-aliases/HorizontalRuleContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Image.md b/docs/api/public-api/type-aliases/Image.md index 038ec12a..e934f10e 100644 --- a/docs/api/public-api/type-aliases/Image.md +++ b/docs/api/public-api/type-aliases/Image.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ImageContainer.md b/docs/api/public-api/type-aliases/ImageContainer.md index f28c6cf0..4d87fcd8 100644 --- a/docs/api/public-api/type-aliases/ImageContainer.md +++ b/docs/api/public-api/type-aliases/ImageContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ImageField.md b/docs/api/public-api/type-aliases/ImageField.md index 8a4f5201..2b10d03c 100644 --- a/docs/api/public-api/type-aliases/ImageField.md +++ b/docs/api/public-api/type-aliases/ImageField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ImageOptions.md b/docs/api/public-api/type-aliases/ImageOptions.md index 29943874..bd886f7c 100644 --- a/docs/api/public-api/type-aliases/ImageOptions.md +++ b/docs/api/public-api/type-aliases/ImageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ImagePosition.md b/docs/api/public-api/type-aliases/ImagePosition.md index 921fab19..7816c172 100644 --- a/docs/api/public-api/type-aliases/ImagePosition.md +++ b/docs/api/public-api/type-aliases/ImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/InternalSetPostFlairOptions.md b/docs/api/public-api/type-aliases/InternalSetPostFlairOptions.md index cc8801c7..177355bc 100644 --- a/docs/api/public-api/type-aliases/InternalSetPostFlairOptions.md +++ b/docs/api/public-api/type-aliases/InternalSetPostFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JSONArray.md b/docs/api/public-api/type-aliases/JSONArray.md index 7af98d24..0f4c2248 100644 --- a/docs/api/public-api/type-aliases/JSONArray.md +++ b/docs/api/public-api/type-aliases/JSONArray.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JSONObject.md b/docs/api/public-api/type-aliases/JSONObject.md index 46ac8380..b033d8b8 100644 --- a/docs/api/public-api/type-aliases/JSONObject.md +++ b/docs/api/public-api/type-aliases/JSONObject.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JSONPrimitive.md b/docs/api/public-api/type-aliases/JSONPrimitive.md index b3a6e8b1..5e09dd2a 100644 --- a/docs/api/public-api/type-aliases/JSONPrimitive.md +++ b/docs/api/public-api/type-aliases/JSONPrimitive.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JSONValue.md b/docs/api/public-api/type-aliases/JSONValue.md index 9a0b1f15..38970c44 100644 --- a/docs/api/public-api/type-aliases/JSONValue.md +++ b/docs/api/public-api/type-aliases/JSONValue.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JobContext.md b/docs/api/public-api/type-aliases/JobContext.md index e58b8647..313fc7de 100644 --- a/docs/api/public-api/type-aliases/JobContext.md +++ b/docs/api/public-api/type-aliases/JobContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/LineBreak.md b/docs/api/public-api/type-aliases/LineBreak.md index 0e208941..7791efed 100644 --- a/docs/api/public-api/type-aliases/LineBreak.md +++ b/docs/api/public-api/type-aliases/LineBreak.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/LineBreakContainer.md b/docs/api/public-api/type-aliases/LineBreakContainer.md index 7fd97641..998782c9 100644 --- a/docs/api/public-api/type-aliases/LineBreakContainer.md +++ b/docs/api/public-api/type-aliases/LineBreakContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Link.md b/docs/api/public-api/type-aliases/Link.md index 36e27a93..bcb9365c 100644 --- a/docs/api/public-api/type-aliases/Link.md +++ b/docs/api/public-api/type-aliases/Link.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/LinkContainer.md b/docs/api/public-api/type-aliases/LinkContainer.md index f58c4c2e..8978e926 100644 --- a/docs/api/public-api/type-aliases/LinkContainer.md +++ b/docs/api/public-api/type-aliases/LinkContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/LinkFlair.md b/docs/api/public-api/type-aliases/LinkFlair.md index 7cb1c2cf..3281e1af 100644 --- a/docs/api/public-api/type-aliases/LinkFlair.md +++ b/docs/api/public-api/type-aliases/LinkFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/LinkOptions.md b/docs/api/public-api/type-aliases/LinkOptions.md index 986805db..5ef346e1 100644 --- a/docs/api/public-api/type-aliases/LinkOptions.md +++ b/docs/api/public-api/type-aliases/LinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/List.md b/docs/api/public-api/type-aliases/List.md index 33fb1ccd..adbe631f 100644 --- a/docs/api/public-api/type-aliases/List.md +++ b/docs/api/public-api/type-aliases/List.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ListChild.md b/docs/api/public-api/type-aliases/ListChild.md index c4a5eceb..577b5f65 100644 --- a/docs/api/public-api/type-aliases/ListChild.md +++ b/docs/api/public-api/type-aliases/ListChild.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ListContainer.md b/docs/api/public-api/type-aliases/ListContainer.md index e8299a31..25c4f4ea 100644 --- a/docs/api/public-api/type-aliases/ListContainer.md +++ b/docs/api/public-api/type-aliases/ListContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ListItem.md b/docs/api/public-api/type-aliases/ListItem.md index aff699ff..2fd61d43 100644 --- a/docs/api/public-api/type-aliases/ListItem.md +++ b/docs/api/public-api/type-aliases/ListItem.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ListItemContainer.md b/docs/api/public-api/type-aliases/ListItemContainer.md index 706356bb..d79c83c1 100644 --- a/docs/api/public-api/type-aliases/ListItemContainer.md +++ b/docs/api/public-api/type-aliases/ListItemContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ListOptions.md b/docs/api/public-api/type-aliases/ListOptions.md index 78d2a9a3..8f973333 100644 --- a/docs/api/public-api/type-aliases/ListOptions.md +++ b/docs/api/public-api/type-aliases/ListOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ListingFetchOptions.md b/docs/api/public-api/type-aliases/ListingFetchOptions.md index b8dc034c..0d18e8c8 100644 --- a/docs/api/public-api/type-aliases/ListingFetchOptions.md +++ b/docs/api/public-api/type-aliases/ListingFetchOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ListingFetchResponse.md b/docs/api/public-api/type-aliases/ListingFetchResponse.md index 0bad5688..2ecbcb7d 100644 --- a/docs/api/public-api/type-aliases/ListingFetchResponse.md +++ b/docs/api/public-api/type-aliases/ListingFetchResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Media.md b/docs/api/public-api/type-aliases/Media.md index c4181b50..f13f0afc 100644 --- a/docs/api/public-api/type-aliases/Media.md +++ b/docs/api/public-api/type-aliases/Media.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MediaAsset.md b/docs/api/public-api/type-aliases/MediaAsset.md index 2f3d507d..1039d058 100644 --- a/docs/api/public-api/type-aliases/MediaAsset.md +++ b/docs/api/public-api/type-aliases/MediaAsset.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MediaAssetId.md b/docs/api/public-api/type-aliases/MediaAssetId.md index 4516e0c2..8de19ab5 100644 --- a/docs/api/public-api/type-aliases/MediaAssetId.md +++ b/docs/api/public-api/type-aliases/MediaAssetId.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MediaOptions.md b/docs/api/public-api/type-aliases/MediaOptions.md index 7468c1f5..8b3785d1 100644 --- a/docs/api/public-api/type-aliases/MediaOptions.md +++ b/docs/api/public-api/type-aliases/MediaOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MediaPlugin.md b/docs/api/public-api/type-aliases/MediaPlugin.md index c742b910..9bc52162 100644 --- a/docs/api/public-api/type-aliases/MediaPlugin.md +++ b/docs/api/public-api/type-aliases/MediaPlugin.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MentionInCommentCreate.md b/docs/api/public-api/type-aliases/MentionInCommentCreate.md index 99f86d86..087ff1a5 100644 --- a/docs/api/public-api/type-aliases/MentionInCommentCreate.md +++ b/docs/api/public-api/type-aliases/MentionInCommentCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MentionInCommentCreateDefinition.md b/docs/api/public-api/type-aliases/MentionInCommentCreateDefinition.md index 3fd6ba70..0395ee4a 100644 --- a/docs/api/public-api/type-aliases/MentionInCommentCreateDefinition.md +++ b/docs/api/public-api/type-aliases/MentionInCommentCreateDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItem.md b/docs/api/public-api/type-aliases/MenuItem.md index e8d3c38d..71b03de6 100644 --- a/docs/api/public-api/type-aliases/MenuItem.md +++ b/docs/api/public-api/type-aliases/MenuItem.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItemLocation.md b/docs/api/public-api/type-aliases/MenuItemLocation.md index 05c9c245..ac808918 100644 --- a/docs/api/public-api/type-aliases/MenuItemLocation.md +++ b/docs/api/public-api/type-aliases/MenuItemLocation.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItemOnPressEvent.md b/docs/api/public-api/type-aliases/MenuItemOnPressEvent.md index 8bf3d7e8..92bb8a9e 100644 --- a/docs/api/public-api/type-aliases/MenuItemOnPressEvent.md +++ b/docs/api/public-api/type-aliases/MenuItemOnPressEvent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItemPostFilter.md b/docs/api/public-api/type-aliases/MenuItemPostFilter.md index c2d22618..b0bb1ebd 100644 --- a/docs/api/public-api/type-aliases/MenuItemPostFilter.md +++ b/docs/api/public-api/type-aliases/MenuItemPostFilter.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItemUserType.md b/docs/api/public-api/type-aliases/MenuItemUserType.md index 92f34085..ed2ee3db 100644 --- a/docs/api/public-api/type-aliases/MenuItemUserType.md +++ b/docs/api/public-api/type-aliases/MenuItemUserType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuPosition.md b/docs/api/public-api/type-aliases/MenuPosition.md index c7dbc33f..c8a99006 100644 --- a/docs/api/public-api/type-aliases/MenuPosition.md +++ b/docs/api/public-api/type-aliases/MenuPosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MessageData.md b/docs/api/public-api/type-aliases/MessageData.md index 942ddc2d..b0b502e4 100644 --- a/docs/api/public-api/type-aliases/MessageData.md +++ b/docs/api/public-api/type-aliases/MessageData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Metadata.md b/docs/api/public-api/type-aliases/Metadata.md index af2af1a6..aa168511 100644 --- a/docs/api/public-api/type-aliases/Metadata.md +++ b/docs/api/public-api/type-aliases/Metadata.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModActionData.md b/docs/api/public-api/type-aliases/ModActionData.md index 0b4ddfd8..5df1d9c4 100644 --- a/docs/api/public-api/type-aliases/ModActionData.md +++ b/docs/api/public-api/type-aliases/ModActionData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModActionDefinition.md b/docs/api/public-api/type-aliases/ModActionDefinition.md index 331ba615..d8f443eb 100644 --- a/docs/api/public-api/type-aliases/ModActionDefinition.md +++ b/docs/api/public-api/type-aliases/ModActionDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModActionTarget.md b/docs/api/public-api/type-aliases/ModActionTarget.md index e02845df..8d23019c 100644 --- a/docs/api/public-api/type-aliases/ModActionTarget.md +++ b/docs/api/public-api/type-aliases/ModActionTarget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModActionTrigger.md b/docs/api/public-api/type-aliases/ModActionTrigger.md index f8fd7f90..6c51cc05 100644 --- a/docs/api/public-api/type-aliases/ModActionTrigger.md +++ b/docs/api/public-api/type-aliases/ModActionTrigger.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModActionType.md b/docs/api/public-api/type-aliases/ModActionType.md index 449ec07f..f7abad1e 100644 --- a/docs/api/public-api/type-aliases/ModActionType.md +++ b/docs/api/public-api/type-aliases/ModActionType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModLogOptions.md b/docs/api/public-api/type-aliases/ModLogOptions.md index 9991089b..f5cd1bdd 100644 --- a/docs/api/public-api/type-aliases/ModLogOptions.md +++ b/docs/api/public-api/type-aliases/ModLogOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModMailDefinition.md b/docs/api/public-api/type-aliases/ModMailDefinition.md index 814058bc..70f3d89e 100644 --- a/docs/api/public-api/type-aliases/ModMailDefinition.md +++ b/docs/api/public-api/type-aliases/ModMailDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModMailTrigger.md b/docs/api/public-api/type-aliases/ModMailTrigger.md index c80ee89f..a3c36d89 100644 --- a/docs/api/public-api/type-aliases/ModMailTrigger.md +++ b/docs/api/public-api/type-aliases/ModMailTrigger.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModNoteType.md b/docs/api/public-api/type-aliases/ModNoteType.md index 62e01dcf..92712c56 100644 --- a/docs/api/public-api/type-aliases/ModNoteType.md +++ b/docs/api/public-api/type-aliases/ModNoteType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModeratorPermission.md b/docs/api/public-api/type-aliases/ModeratorPermission.md index 66f5e685..6b3202fa 100644 --- a/docs/api/public-api/type-aliases/ModeratorPermission.md +++ b/docs/api/public-api/type-aliases/ModeratorPermission.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModeratorReport.md b/docs/api/public-api/type-aliases/ModeratorReport.md index 0a993e26..f29dd503 100644 --- a/docs/api/public-api/type-aliases/ModeratorReport.md +++ b/docs/api/public-api/type-aliases/ModeratorReport.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MoreObject.md b/docs/api/public-api/type-aliases/MoreObject.md index 00856dfe..484cb656 100644 --- a/docs/api/public-api/type-aliases/MoreObject.md +++ b/docs/api/public-api/type-aliases/MoreObject.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MultiTriggerDefinition.md b/docs/api/public-api/type-aliases/MultiTriggerDefinition.md index 4155b942..6c9b5f81 100644 --- a/docs/api/public-api/type-aliases/MultiTriggerDefinition.md +++ b/docs/api/public-api/type-aliases/MultiTriggerDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/NumberField.md b/docs/api/public-api/type-aliases/NumberField.md index 1f4cf34f..71d26abc 100644 --- a/docs/api/public-api/type-aliases/NumberField.md +++ b/docs/api/public-api/type-aliases/NumberField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ObfuscationReason.md b/docs/api/public-api/type-aliases/ObfuscationReason.md index d47493b0..80126587 100644 --- a/docs/api/public-api/type-aliases/ObfuscationReason.md +++ b/docs/api/public-api/type-aliases/ObfuscationReason.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Oembed.md b/docs/api/public-api/type-aliases/Oembed.md index 743490f2..fa7a6b67 100644 --- a/docs/api/public-api/type-aliases/Oembed.md +++ b/docs/api/public-api/type-aliases/Oembed.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -6,9 +6,9 @@ > **Oembed** = `object` -oEmbed is a format for allowing an embedded representation of a URL on third party sites. -The simple API allows a website to display embedded content (such as photos or videos) -when a user posts a link to that resource, without having to parse the resource directly. +oEmbed is a format for allowing an embedded representation of a URL on +third-party sites. The API lets a website display embedded content, such as +photos or videos, without parsing the resource directly. See: https://oembed.com/ ## Properties @@ -29,7 +29,13 @@ The name of the author/owner of the resource. E.g. "Reddit" > `optional` **authorUrl**: `string` -A URL for the author/owner of the resource. E.g. "https://www.youtube.com/@Reddit" +A URL for the resource's author or owner. + +#### Example + +```ts +"https://www.youtube.com/@Reddit" +``` *** @@ -39,7 +45,7 @@ A URL for the author/owner of the resource. E.g. "https://www.youtube.com/@Reddi > `optional` **height**: `number` -The width in pixels required to display the HTML. +The height in pixels required to display the HTML. *** @@ -49,7 +55,9 @@ The width in pixels required to display the HTML. > **html**: `string` -The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. +The HTML required to embed a video player. It should have no padding or +margins. Consider loading it in a separate-origin iframe to avoid XSS +vulnerabilities. *** @@ -119,7 +127,7 @@ A text title, describing the resource. > **type**: `string` -The resource type. Valid values, along with value-specific parameters, are described below. E.g. "video" +The resource type and its type-specific parameters, such as `"video"`. *** @@ -139,4 +147,4 @@ The oEmbed version number. This must be 1.0. > `optional` **width**: `number` -The height in pixels required to display the HTML. +The width in pixels required to display the HTML. diff --git a/docs/api/public-api/type-aliases/OnAutomoderatorFilterCommentDefinition.md b/docs/api/public-api/type-aliases/OnAutomoderatorFilterCommentDefinition.md index 18b8b7cf..8a549191 100644 --- a/docs/api/public-api/type-aliases/OnAutomoderatorFilterCommentDefinition.md +++ b/docs/api/public-api/type-aliases/OnAutomoderatorFilterCommentDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/OnAutomoderatorFilterPostDefinition.md b/docs/api/public-api/type-aliases/OnAutomoderatorFilterPostDefinition.md index 84a5d249..b6909f1f 100644 --- a/docs/api/public-api/type-aliases/OnAutomoderatorFilterPostDefinition.md +++ b/docs/api/public-api/type-aliases/OnAutomoderatorFilterPostDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/OnTriggerRequest.md b/docs/api/public-api/type-aliases/OnTriggerRequest.md index 8ac87e76..aa34b623 100644 --- a/docs/api/public-api/type-aliases/OnTriggerRequest.md +++ b/docs/api/public-api/type-aliases/OnTriggerRequest.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/OnValidateHandler.md b/docs/api/public-api/type-aliases/OnValidateHandler.md index 85181913..59fe1881 100644 --- a/docs/api/public-api/type-aliases/OnValidateHandler.md +++ b/docs/api/public-api/type-aliases/OnValidateHandler.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Paragraph.md b/docs/api/public-api/type-aliases/Paragraph.md index 5b7e3447..9ea1d5a0 100644 --- a/docs/api/public-api/type-aliases/Paragraph.md +++ b/docs/api/public-api/type-aliases/Paragraph.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ParagraphContainer.md b/docs/api/public-api/type-aliases/ParagraphContainer.md index 4dbca9f3..e6372c5e 100644 --- a/docs/api/public-api/type-aliases/ParagraphContainer.md +++ b/docs/api/public-api/type-aliases/ParagraphContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ParagraphContentNode.md b/docs/api/public-api/type-aliases/ParagraphContentNode.md index 10be7035..758c8a1a 100644 --- a/docs/api/public-api/type-aliases/ParagraphContentNode.md +++ b/docs/api/public-api/type-aliases/ParagraphContentNode.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ParagraphField.md b/docs/api/public-api/type-aliases/ParagraphField.md index 4a9f8366..cd2df4d6 100644 --- a/docs/api/public-api/type-aliases/ParagraphField.md +++ b/docs/api/public-api/type-aliases/ParagraphField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PartialJSONArray.md b/docs/api/public-api/type-aliases/PartialJSONArray.md index 9af2dd4f..b61856cb 100644 --- a/docs/api/public-api/type-aliases/PartialJSONArray.md +++ b/docs/api/public-api/type-aliases/PartialJSONArray.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PartialJSONObject.md b/docs/api/public-api/type-aliases/PartialJSONObject.md index d79b5c11..d16d79d8 100644 --- a/docs/api/public-api/type-aliases/PartialJSONObject.md +++ b/docs/api/public-api/type-aliases/PartialJSONObject.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PartialJSONPrimitive.md b/docs/api/public-api/type-aliases/PartialJSONPrimitive.md index 7c515767..a10dfbc4 100644 --- a/docs/api/public-api/type-aliases/PartialJSONPrimitive.md +++ b/docs/api/public-api/type-aliases/PartialJSONPrimitive.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PartialJSONValue.md b/docs/api/public-api/type-aliases/PartialJSONValue.md index 16397eab..cb26f5b0 100644 --- a/docs/api/public-api/type-aliases/PartialJSONValue.md +++ b/docs/api/public-api/type-aliases/PartialJSONValue.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Participant.md b/docs/api/public-api/type-aliases/Participant.md index 9d34acf3..76013d91 100644 --- a/docs/api/public-api/type-aliases/Participant.md +++ b/docs/api/public-api/type-aliases/Participant.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PlainText.md b/docs/api/public-api/type-aliases/PlainText.md index ec3a9280..3b2f06f9 100644 --- a/docs/api/public-api/type-aliases/PlainText.md +++ b/docs/api/public-api/type-aliases/PlainText.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PluginSettings.md b/docs/api/public-api/type-aliases/PluginSettings.md index 961deccc..f9229cd4 100644 --- a/docs/api/public-api/type-aliases/PluginSettings.md +++ b/docs/api/public-api/type-aliases/PluginSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PollData.md b/docs/api/public-api/type-aliases/PollData.md index 6485d1a2..2833d088 100644 --- a/docs/api/public-api/type-aliases/PollData.md +++ b/docs/api/public-api/type-aliases/PollData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -26,7 +26,7 @@ Options in the poll. > **totalVoteCount**: `number` -Total number of votes cast in the poll. Aggregated across all PollOption objects. +Total votes cast across all of the poll's options. *** diff --git a/docs/api/public-api/type-aliases/PollOption.md b/docs/api/public-api/type-aliases/PollOption.md index 9c122d44..536a40af 100644 --- a/docs/api/public-api/type-aliases/PollOption.md +++ b/docs/api/public-api/type-aliases/PollOption.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PositionedImagePosition.md b/docs/api/public-api/type-aliases/PositionedImagePosition.md index 108a348c..a3398950 100644 --- a/docs/api/public-api/type-aliases/PositionedImagePosition.md +++ b/docs/api/public-api/type-aliases/PositionedImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostCapabilities.md b/docs/api/public-api/type-aliases/PostCapabilities.md index 8bbfa20d..cc01c074 100644 --- a/docs/api/public-api/type-aliases/PostCapabilities.md +++ b/docs/api/public-api/type-aliases/PostCapabilities.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostCreate.md b/docs/api/public-api/type-aliases/PostCreate.md index c7c76d61..c445a591 100644 --- a/docs/api/public-api/type-aliases/PostCreate.md +++ b/docs/api/public-api/type-aliases/PostCreate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostCreateDefinition.md b/docs/api/public-api/type-aliases/PostCreateDefinition.md index d203f893..0ab456d7 100644 --- a/docs/api/public-api/type-aliases/PostCreateDefinition.md +++ b/docs/api/public-api/type-aliases/PostCreateDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostDelete.md b/docs/api/public-api/type-aliases/PostDelete.md index 69e7a008..e414d235 100644 --- a/docs/api/public-api/type-aliases/PostDelete.md +++ b/docs/api/public-api/type-aliases/PostDelete.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostDeleteDefinition.md b/docs/api/public-api/type-aliases/PostDeleteDefinition.md index 2c83b39e..5055e6af 100644 --- a/docs/api/public-api/type-aliases/PostDeleteDefinition.md +++ b/docs/api/public-api/type-aliases/PostDeleteDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostFlairUpdate.md b/docs/api/public-api/type-aliases/PostFlairUpdate.md index 008da441..54fb4ce3 100644 --- a/docs/api/public-api/type-aliases/PostFlairUpdate.md +++ b/docs/api/public-api/type-aliases/PostFlairUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostFlairUpdateDefinition.md b/docs/api/public-api/type-aliases/PostFlairUpdateDefinition.md index c045529a..520412a9 100644 --- a/docs/api/public-api/type-aliases/PostFlairUpdateDefinition.md +++ b/docs/api/public-api/type-aliases/PostFlairUpdateDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostLink.md b/docs/api/public-api/type-aliases/PostLink.md index b75fbaf8..b8028928 100644 --- a/docs/api/public-api/type-aliases/PostLink.md +++ b/docs/api/public-api/type-aliases/PostLink.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostLinkOptions.md b/docs/api/public-api/type-aliases/PostLinkOptions.md index 20ca45a7..ab4cbb5a 100644 --- a/docs/api/public-api/type-aliases/PostLinkOptions.md +++ b/docs/api/public-api/type-aliases/PostLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostNsfwUpdate.md b/docs/api/public-api/type-aliases/PostNsfwUpdate.md index 9bbca1b2..69957512 100644 --- a/docs/api/public-api/type-aliases/PostNsfwUpdate.md +++ b/docs/api/public-api/type-aliases/PostNsfwUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostNsfwUpdateDefinition.md b/docs/api/public-api/type-aliases/PostNsfwUpdateDefinition.md index 3a3ccb32..3558b717 100644 --- a/docs/api/public-api/type-aliases/PostNsfwUpdateDefinition.md +++ b/docs/api/public-api/type-aliases/PostNsfwUpdateDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostReport.md b/docs/api/public-api/type-aliases/PostReport.md index 32edee2c..43ff3709 100644 --- a/docs/api/public-api/type-aliases/PostReport.md +++ b/docs/api/public-api/type-aliases/PostReport.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostReportDefinition.md b/docs/api/public-api/type-aliases/PostReportDefinition.md index 6c9ffeb0..76d1c78d 100644 --- a/docs/api/public-api/type-aliases/PostReportDefinition.md +++ b/docs/api/public-api/type-aliases/PostReportDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSpoilerUpdate.md b/docs/api/public-api/type-aliases/PostSpoilerUpdate.md index eacab5f7..fc3c6dab 100644 --- a/docs/api/public-api/type-aliases/PostSpoilerUpdate.md +++ b/docs/api/public-api/type-aliases/PostSpoilerUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSpoilerUpdateDefinition.md b/docs/api/public-api/type-aliases/PostSpoilerUpdateDefinition.md index 78d4c880..ac1bf8f5 100644 --- a/docs/api/public-api/type-aliases/PostSpoilerUpdateDefinition.md +++ b/docs/api/public-api/type-aliases/PostSpoilerUpdateDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSubmit.md b/docs/api/public-api/type-aliases/PostSubmit.md index 48bf96e8..4f7e75c5 100644 --- a/docs/api/public-api/type-aliases/PostSubmit.md +++ b/docs/api/public-api/type-aliases/PostSubmit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSubmitDefinition.md b/docs/api/public-api/type-aliases/PostSubmitDefinition.md index bf6aac89..f1810075 100644 --- a/docs/api/public-api/type-aliases/PostSubmitDefinition.md +++ b/docs/api/public-api/type-aliases/PostSubmitDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSuggestedCommentSort.md b/docs/api/public-api/type-aliases/PostSuggestedCommentSort.md index 03c1cda1..bafccf43 100644 --- a/docs/api/public-api/type-aliases/PostSuggestedCommentSort.md +++ b/docs/api/public-api/type-aliases/PostSuggestedCommentSort.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostTextOptions.md b/docs/api/public-api/type-aliases/PostTextOptions.md index c4ef1c2b..642446df 100644 --- a/docs/api/public-api/type-aliases/PostTextOptions.md +++ b/docs/api/public-api/type-aliases/PostTextOptions.md @@ -1,7 +1,27 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** # Type Alias: PostTextOptions > **PostTextOptions** = \{ `text`: `string`; \} \| \{ `richtext`: `object` \| [`RichTextBuilder`](../classes/RichTextBuilder.md); \} + +Options for replacing a post body. + +## Type declaration + +\{ `text`: `string`; \} + +### text + +> **text**: `string` + +The post body in Markdown. + +\{ `richtext`: `object` \| [`RichTextBuilder`](../classes/RichTextBuilder.md); \} + +### richtext + +> **richtext**: `object` \| [`RichTextBuilder`](../classes/RichTextBuilder.md) + +The post body as rich text. diff --git a/docs/api/public-api/type-aliases/PostType.md b/docs/api/public-api/type-aliases/PostType.md index 1115cb89..9f6675ef 100644 --- a/docs/api/public-api/type-aliases/PostType.md +++ b/docs/api/public-api/type-aliases/PostType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostUpdate.md b/docs/api/public-api/type-aliases/PostUpdate.md index 08332e05..f8051fdd 100644 --- a/docs/api/public-api/type-aliases/PostUpdate.md +++ b/docs/api/public-api/type-aliases/PostUpdate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostUpdateDefinition.md b/docs/api/public-api/type-aliases/PostUpdateDefinition.md index bec9fca5..b76d1ebe 100644 --- a/docs/api/public-api/type-aliases/PostUpdateDefinition.md +++ b/docs/api/public-api/type-aliases/PostUpdateDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PrefixedRedditLinkOptions.md b/docs/api/public-api/type-aliases/PrefixedRedditLinkOptions.md index d78c1762..8bc2f90a 100644 --- a/docs/api/public-api/type-aliases/PrefixedRedditLinkOptions.md +++ b/docs/api/public-api/type-aliases/PrefixedRedditLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RawText.md b/docs/api/public-api/type-aliases/RawText.md index ad32d631..45c2f6be 100644 --- a/docs/api/public-api/type-aliases/RawText.md +++ b/docs/api/public-api/type-aliases/RawText.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RawTextContainer.md b/docs/api/public-api/type-aliases/RawTextContainer.md index 9586b12b..029a4d92 100644 --- a/docs/api/public-api/type-aliases/RawTextContainer.md +++ b/docs/api/public-api/type-aliases/RawTextContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RawTextOptions.md b/docs/api/public-api/type-aliases/RawTextOptions.md index a047be88..2e8b2125 100644 --- a/docs/api/public-api/type-aliases/RawTextOptions.md +++ b/docs/api/public-api/type-aliases/RawTextOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RedditLink.md b/docs/api/public-api/type-aliases/RedditLink.md index f5381982..36b4059e 100644 --- a/docs/api/public-api/type-aliases/RedditLink.md +++ b/docs/api/public-api/type-aliases/RedditLink.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RedditLinkContainer.md b/docs/api/public-api/type-aliases/RedditLinkContainer.md index d12c1a75..f210a82d 100644 --- a/docs/api/public-api/type-aliases/RedditLinkContainer.md +++ b/docs/api/public-api/type-aliases/RedditLinkContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RedditPermalinkOptions.md b/docs/api/public-api/type-aliases/RedditPermalinkOptions.md index 4a898546..2387ed59 100644 --- a/docs/api/public-api/type-aliases/RedditPermalinkOptions.md +++ b/docs/api/public-api/type-aliases/RedditPermalinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RedditVideo.md b/docs/api/public-api/type-aliases/RedditVideo.md index bc0bd3ab..5da0389b 100644 --- a/docs/api/public-api/type-aliases/RedditVideo.md +++ b/docs/api/public-api/type-aliases/RedditVideo.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -26,7 +26,13 @@ The bitrate of the video in kilobits per second. E.g. 450 > `optional` **dashUrl**: `string` -The URL to the DASH playlist file. E.g. "https://v.redd.it/abc123/DASHPlaylist.mpd" +The URL to the DASH playlist file. + +#### Example + +```ts +"https://v.redd.it/abc123/DASHPlaylist.mpd" +``` *** @@ -46,7 +52,13 @@ The duration of the video in seconds. E.g. 30 > `optional` **fallbackUrl**: `string` -The direct URL to the video. E.g. "https://v.redd.it/abc123/DASH_1080.mp4?source=fallback" +The direct URL to the video. + +#### Example + +```ts +"https://v.redd.it/abc123/DASH_1080.mp4?source=fallback" +``` *** @@ -66,7 +78,13 @@ The height of the video in pixels. E.g. 1080 > `optional` **hlsUrl**: `string` -The URL to the HLS playlist file. E.g. "https://v.redd.it/abc123/HLSPlaylist.m3u8" +The URL to the HLS playlist file. + +#### Example + +```ts +"https://v.redd.it/abc123/HLSPlaylist.m3u8" +``` *** @@ -86,7 +104,13 @@ If `true`, the video is a GIF > `optional` **scrubberMediaUrl**: `string` -The URL to the scrubber media file. E.g. "https://v.redd.it/abc123/DASH_96.mp4" +The URL to the scrubber media file. + +#### Example + +```ts +"https://v.redd.it/abc123/DASH_96.mp4" +``` *** diff --git a/docs/api/public-api/type-aliases/RedisClient.md b/docs/api/public-api/type-aliases/RedisClient.md index 25645509..c63b2611 100644 --- a/docs/api/public-api/type-aliases/RedisClient.md +++ b/docs/api/public-api/type-aliases/RedisClient.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RelationshipType.md b/docs/api/public-api/type-aliases/RelationshipType.md index 15d739b8..86bf06b7 100644 --- a/docs/api/public-api/type-aliases/RelationshipType.md +++ b/docs/api/public-api/type-aliases/RelationshipType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RemovalReason.md b/docs/api/public-api/type-aliases/RemovalReason.md index be52b954..7ce94c48 100644 --- a/docs/api/public-api/type-aliases/RemovalReason.md +++ b/docs/api/public-api/type-aliases/RemovalReason.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RemoveRelationshipOptions.md b/docs/api/public-api/type-aliases/RemoveRelationshipOptions.md index 5461e0e8..408b1753 100644 --- a/docs/api/public-api/type-aliases/RemoveRelationshipOptions.md +++ b/docs/api/public-api/type-aliases/RemoveRelationshipOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ReplyToCommentOptions.md b/docs/api/public-api/type-aliases/ReplyToCommentOptions.md index e2a0f9e5..869de4f9 100644 --- a/docs/api/public-api/type-aliases/ReplyToCommentOptions.md +++ b/docs/api/public-api/type-aliases/ReplyToCommentOptions.md @@ -1,7 +1,9 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** # Type Alias: ReplyToCommentOptions > **ReplyToCommentOptions** = [`CommentSubmissionOptions`](CommentSubmissionOptions.md) + +Options for replying to a comment. diff --git a/docs/api/public-api/type-aliases/RichTextContent.md b/docs/api/public-api/type-aliases/RichTextContent.md index 1c6483b6..bb24d414 100644 --- a/docs/api/public-api/type-aliases/RichTextContent.md +++ b/docs/api/public-api/type-aliases/RichTextContent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RunJob.md b/docs/api/public-api/type-aliases/RunJob.md index 8498cab0..2b1be529 100644 --- a/docs/api/public-api/type-aliases/RunJob.md +++ b/docs/api/public-api/type-aliases/RunJob.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledCronJob.md b/docs/api/public-api/type-aliases/ScheduledCronJob.md index c5ded05f..186ae143 100644 --- a/docs/api/public-api/type-aliases/ScheduledCronJob.md +++ b/docs/api/public-api/type-aliases/ScheduledCronJob.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledCronJobOptions.md b/docs/api/public-api/type-aliases/ScheduledCronJobOptions.md index 521e5327..75103550 100644 --- a/docs/api/public-api/type-aliases/ScheduledCronJobOptions.md +++ b/docs/api/public-api/type-aliases/ScheduledCronJobOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJob.md b/docs/api/public-api/type-aliases/ScheduledJob.md index ebf004db..faa0d557 100644 --- a/docs/api/public-api/type-aliases/ScheduledJob.md +++ b/docs/api/public-api/type-aliases/ScheduledJob.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJobEvent.md b/docs/api/public-api/type-aliases/ScheduledJobEvent.md index 163cc4f9..6563889e 100644 --- a/docs/api/public-api/type-aliases/ScheduledJobEvent.md +++ b/docs/api/public-api/type-aliases/ScheduledJobEvent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJobHandler.md b/docs/api/public-api/type-aliases/ScheduledJobHandler.md index 72b67ab4..7bd2a4d0 100644 --- a/docs/api/public-api/type-aliases/ScheduledJobHandler.md +++ b/docs/api/public-api/type-aliases/ScheduledJobHandler.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJobOptions.md b/docs/api/public-api/type-aliases/ScheduledJobOptions.md index a4f92efe..910848d0 100644 --- a/docs/api/public-api/type-aliases/ScheduledJobOptions.md +++ b/docs/api/public-api/type-aliases/ScheduledJobOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJobType.md b/docs/api/public-api/type-aliases/ScheduledJobType.md index 132b158f..e38bd36f 100644 --- a/docs/api/public-api/type-aliases/ScheduledJobType.md +++ b/docs/api/public-api/type-aliases/ScheduledJobType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Scheduler.md b/docs/api/public-api/type-aliases/Scheduler.md index e206ebdc..7e84b092 100644 --- a/docs/api/public-api/type-aliases/Scheduler.md +++ b/docs/api/public-api/type-aliases/Scheduler.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SearchPostsOptions.md b/docs/api/public-api/type-aliases/SearchPostsOptions.md index 1bd09983..68f64009 100644 --- a/docs/api/public-api/type-aliases/SearchPostsOptions.md +++ b/docs/api/public-api/type-aliases/SearchPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** @@ -24,7 +24,8 @@ How to sort the search results. Defaults to `relevance`. > `optional` **subredditName**: `string` -The subreddit to search without 'r/' prefix. If specified, will restrict the search to posts in this subreddit +The subreddit to search without the `r/` prefix. If specified, restricts +the search to posts in this subreddit. ### timeframe? diff --git a/docs/api/public-api/type-aliases/SecureMedia.md b/docs/api/public-api/type-aliases/SecureMedia.md index c803b011..99f1a2a5 100644 --- a/docs/api/public-api/type-aliases/SecureMedia.md +++ b/docs/api/public-api/type-aliases/SecureMedia.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SelectField.md b/docs/api/public-api/type-aliases/SelectField.md index 8731bd5a..43a89ec5 100644 --- a/docs/api/public-api/type-aliases/SelectField.md +++ b/docs/api/public-api/type-aliases/SelectField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SendPrivateMessageAsSubredditOptions.md b/docs/api/public-api/type-aliases/SendPrivateMessageAsSubredditOptions.md index f55067af..572ff935 100644 --- a/docs/api/public-api/type-aliases/SendPrivateMessageAsSubredditOptions.md +++ b/docs/api/public-api/type-aliases/SendPrivateMessageAsSubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SendPrivateMessageOptions.md b/docs/api/public-api/type-aliases/SendPrivateMessageOptions.md index 0107611c..7a67eef7 100644 --- a/docs/api/public-api/type-aliases/SendPrivateMessageOptions.md +++ b/docs/api/public-api/type-aliases/SendPrivateMessageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SetFlairOptions.md b/docs/api/public-api/type-aliases/SetFlairOptions.md index 1ea9e95d..e96dcf16 100644 --- a/docs/api/public-api/type-aliases/SetFlairOptions.md +++ b/docs/api/public-api/type-aliases/SetFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SetOptions.md b/docs/api/public-api/type-aliases/SetOptions.md index 8e35d806..94d8638f 100644 --- a/docs/api/public-api/type-aliases/SetOptions.md +++ b/docs/api/public-api/type-aliases/SetOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SetPostFlairOptions.md b/docs/api/public-api/type-aliases/SetPostFlairOptions.md index 070d1d81..1abe5201 100644 --- a/docs/api/public-api/type-aliases/SetPostFlairOptions.md +++ b/docs/api/public-api/type-aliases/SetPostFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SetUserFlairBatchConfig.md b/docs/api/public-api/type-aliases/SetUserFlairBatchConfig.md index 091f6f8f..313b45da 100644 --- a/docs/api/public-api/type-aliases/SetUserFlairBatchConfig.md +++ b/docs/api/public-api/type-aliases/SetUserFlairBatchConfig.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SetUserFlairOptions.md b/docs/api/public-api/type-aliases/SetUserFlairOptions.md index 8af21a21..378a5140 100644 --- a/docs/api/public-api/type-aliases/SetUserFlairOptions.md +++ b/docs/api/public-api/type-aliases/SetUserFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingScopeType.md b/docs/api/public-api/type-aliases/SettingScopeType.md index 8443e2cc..e7190035 100644 --- a/docs/api/public-api/type-aliases/SettingScopeType.md +++ b/docs/api/public-api/type-aliases/SettingScopeType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsFormField.md b/docs/api/public-api/type-aliases/SettingsFormField.md index 4bed75f8..44933062 100644 --- a/docs/api/public-api/type-aliases/SettingsFormField.md +++ b/docs/api/public-api/type-aliases/SettingsFormField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsFormFieldGroup.md b/docs/api/public-api/type-aliases/SettingsFormFieldGroup.md index e70ea442..fc354055 100644 --- a/docs/api/public-api/type-aliases/SettingsFormFieldGroup.md +++ b/docs/api/public-api/type-aliases/SettingsFormFieldGroup.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsFormFieldValidatorEvent.md b/docs/api/public-api/type-aliases/SettingsFormFieldValidatorEvent.md index d5e22280..6aa5a092 100644 --- a/docs/api/public-api/type-aliases/SettingsFormFieldValidatorEvent.md +++ b/docs/api/public-api/type-aliases/SettingsFormFieldValidatorEvent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsValues.md b/docs/api/public-api/type-aliases/SettingsValues.md index 08d7c286..a4f70f74 100644 --- a/docs/api/public-api/type-aliases/SettingsValues.md +++ b/docs/api/public-api/type-aliases/SettingsValues.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SpoilerContainer.md b/docs/api/public-api/type-aliases/SpoilerContainer.md index 9df47117..83a8201a 100644 --- a/docs/api/public-api/type-aliases/SpoilerContainer.md +++ b/docs/api/public-api/type-aliases/SpoilerContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SpoilerText.md b/docs/api/public-api/type-aliases/SpoilerText.md index 97d9eaf7..3b554135 100644 --- a/docs/api/public-api/type-aliases/SpoilerText.md +++ b/docs/api/public-api/type-aliases/SpoilerText.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/StringField.md b/docs/api/public-api/type-aliases/StringField.md index 600b2606..42c32269 100644 --- a/docs/api/public-api/type-aliases/StringField.md +++ b/docs/api/public-api/type-aliases/StringField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubmitCustomPostOptions.md b/docs/api/public-api/type-aliases/SubmitCustomPostOptions.md index 95cbf982..7a21b54a 100644 --- a/docs/api/public-api/type-aliases/SubmitCustomPostOptions.md +++ b/docs/api/public-api/type-aliases/SubmitCustomPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubmitLinkOptions.md b/docs/api/public-api/type-aliases/SubmitLinkOptions.md index 52aada56..7c712d49 100644 --- a/docs/api/public-api/type-aliases/SubmitLinkOptions.md +++ b/docs/api/public-api/type-aliases/SubmitLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubmitMediaOptions.md b/docs/api/public-api/type-aliases/SubmitMediaOptions.md index 7447902c..5a6eafaf 100644 --- a/docs/api/public-api/type-aliases/SubmitMediaOptions.md +++ b/docs/api/public-api/type-aliases/SubmitMediaOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubmitPostOptions.md b/docs/api/public-api/type-aliases/SubmitPostOptions.md index cc3a93c4..dee0d269 100644 --- a/docs/api/public-api/type-aliases/SubmitPostOptions.md +++ b/docs/api/public-api/type-aliases/SubmitPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubmitSelfPostOptions.md b/docs/api/public-api/type-aliases/SubmitSelfPostOptions.md index 08ea91d2..8a2b7af3 100644 --- a/docs/api/public-api/type-aliases/SubmitSelfPostOptions.md +++ b/docs/api/public-api/type-aliases/SubmitSelfPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditData.md b/docs/api/public-api/type-aliases/SubredditData.md index 700293f7..cc58ce32 100644 --- a/docs/api/public-api/type-aliases/SubredditData.md +++ b/docs/api/public-api/type-aliases/SubredditData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditInfo.md b/docs/api/public-api/type-aliases/SubredditInfo.md index 6fd6f0b0..ca8bc5c8 100644 --- a/docs/api/public-api/type-aliases/SubredditInfo.md +++ b/docs/api/public-api/type-aliases/SubredditInfo.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditLeaderboard.md b/docs/api/public-api/type-aliases/SubredditLeaderboard.md index 54b2c8bd..94e0c5e5 100644 --- a/docs/api/public-api/type-aliases/SubredditLeaderboard.md +++ b/docs/api/public-api/type-aliases/SubredditLeaderboard.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditLeaderboardSummary.md b/docs/api/public-api/type-aliases/SubredditLeaderboardSummary.md index 65ce6ffe..113d8880 100644 --- a/docs/api/public-api/type-aliases/SubredditLeaderboardSummary.md +++ b/docs/api/public-api/type-aliases/SubredditLeaderboardSummary.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditLeaderboardSummaryRow.md b/docs/api/public-api/type-aliases/SubredditLeaderboardSummaryRow.md index 7d925cee..8b843b1b 100644 --- a/docs/api/public-api/type-aliases/SubredditLeaderboardSummaryRow.md +++ b/docs/api/public-api/type-aliases/SubredditLeaderboardSummaryRow.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditLink.md b/docs/api/public-api/type-aliases/SubredditLink.md index e2f1e10c..e4c8e1d3 100644 --- a/docs/api/public-api/type-aliases/SubredditLink.md +++ b/docs/api/public-api/type-aliases/SubredditLink.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditLinkOptions.md b/docs/api/public-api/type-aliases/SubredditLinkOptions.md index cfe303b7..ec6c47e2 100644 --- a/docs/api/public-api/type-aliases/SubredditLinkOptions.md +++ b/docs/api/public-api/type-aliases/SubredditLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditOptions.md b/docs/api/public-api/type-aliases/SubredditOptions.md index c307956a..7d1d1af9 100644 --- a/docs/api/public-api/type-aliases/SubredditOptions.md +++ b/docs/api/public-api/type-aliases/SubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditSettings.md b/docs/api/public-api/type-aliases/SubredditSettings.md index 7d399189..6eacbf44 100644 --- a/docs/api/public-api/type-aliases/SubredditSettings.md +++ b/docs/api/public-api/type-aliases/SubredditSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditSettingsOptions.md b/docs/api/public-api/type-aliases/SubredditSettingsOptions.md index 7a138e9a..6b8a7bac 100644 --- a/docs/api/public-api/type-aliases/SubredditSettingsOptions.md +++ b/docs/api/public-api/type-aliases/SubredditSettingsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditStyles.md b/docs/api/public-api/type-aliases/SubredditStyles.md index 23b58e47..53964c55 100644 --- a/docs/api/public-api/type-aliases/SubredditStyles.md +++ b/docs/api/public-api/type-aliases/SubredditStyles.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SubredditType.md b/docs/api/public-api/type-aliases/SubredditType.md index 7551765b..0977d48b 100644 --- a/docs/api/public-api/type-aliases/SubredditType.md +++ b/docs/api/public-api/type-aliases/SubredditType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Table.md b/docs/api/public-api/type-aliases/Table.md index 53387360..bf03734d 100644 --- a/docs/api/public-api/type-aliases/Table.md +++ b/docs/api/public-api/type-aliases/Table.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableCell.md b/docs/api/public-api/type-aliases/TableCell.md index bf0c2e86..52894680 100644 --- a/docs/api/public-api/type-aliases/TableCell.md +++ b/docs/api/public-api/type-aliases/TableCell.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableCellContainer.md b/docs/api/public-api/type-aliases/TableCellContainer.md index 18630068..2caa1d1f 100644 --- a/docs/api/public-api/type-aliases/TableCellContainer.md +++ b/docs/api/public-api/type-aliases/TableCellContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableCellText.md b/docs/api/public-api/type-aliases/TableCellText.md index a44b19e0..d2c15d1e 100644 --- a/docs/api/public-api/type-aliases/TableCellText.md +++ b/docs/api/public-api/type-aliases/TableCellText.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableContainer.md b/docs/api/public-api/type-aliases/TableContainer.md index e1d904d2..4d826f38 100644 --- a/docs/api/public-api/type-aliases/TableContainer.md +++ b/docs/api/public-api/type-aliases/TableContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableContentContainer.md b/docs/api/public-api/type-aliases/TableContentContainer.md index 7490fa0f..54ab1470 100644 --- a/docs/api/public-api/type-aliases/TableContentContainer.md +++ b/docs/api/public-api/type-aliases/TableContentContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableHeaderCell.md b/docs/api/public-api/type-aliases/TableHeaderCell.md index 70370901..a39bab85 100644 --- a/docs/api/public-api/type-aliases/TableHeaderCell.md +++ b/docs/api/public-api/type-aliases/TableHeaderCell.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableHeaderCellContext.md b/docs/api/public-api/type-aliases/TableHeaderCellContext.md index 2ed00da7..a40478c5 100644 --- a/docs/api/public-api/type-aliases/TableHeaderCellContext.md +++ b/docs/api/public-api/type-aliases/TableHeaderCellContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableHeaderCellOptions.md b/docs/api/public-api/type-aliases/TableHeaderCellOptions.md index ddaf8be0..bb323a39 100644 --- a/docs/api/public-api/type-aliases/TableHeaderCellOptions.md +++ b/docs/api/public-api/type-aliases/TableHeaderCellOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableHeaderRow.md b/docs/api/public-api/type-aliases/TableHeaderRow.md index bf005831..d616aac9 100644 --- a/docs/api/public-api/type-aliases/TableHeaderRow.md +++ b/docs/api/public-api/type-aliases/TableHeaderRow.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TableRow.md b/docs/api/public-api/type-aliases/TableRow.md index 33d0a45f..2781dbd0 100644 --- a/docs/api/public-api/type-aliases/TableRow.md +++ b/docs/api/public-api/type-aliases/TableRow.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Text.md b/docs/api/public-api/type-aliases/Text.md index e342306b..03db4285 100644 --- a/docs/api/public-api/type-aliases/Text.md +++ b/docs/api/public-api/type-aliases/Text.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TextContainer.md b/docs/api/public-api/type-aliases/TextContainer.md index e68af391..dea95538 100644 --- a/docs/api/public-api/type-aliases/TextContainer.md +++ b/docs/api/public-api/type-aliases/TextContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TextNode.md b/docs/api/public-api/type-aliases/TextNode.md index c887d66a..8a5151f4 100644 --- a/docs/api/public-api/type-aliases/TextNode.md +++ b/docs/api/public-api/type-aliases/TextNode.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TextOptions.md b/docs/api/public-api/type-aliases/TextOptions.md index b837c4ad..46443fb3 100644 --- a/docs/api/public-api/type-aliases/TextOptions.md +++ b/docs/api/public-api/type-aliases/TextOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Toast.md b/docs/api/public-api/type-aliases/Toast.md index 718056de..c7112085 100644 --- a/docs/api/public-api/type-aliases/Toast.md +++ b/docs/api/public-api/type-aliases/Toast.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerContext.md b/docs/api/public-api/type-aliases/TriggerContext.md index 055cecbc..73cc0952 100644 --- a/docs/api/public-api/type-aliases/TriggerContext.md +++ b/docs/api/public-api/type-aliases/TriggerContext.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerDefinition.md b/docs/api/public-api/type-aliases/TriggerDefinition.md index 35e7819e..88e6de89 100644 --- a/docs/api/public-api/type-aliases/TriggerDefinition.md +++ b/docs/api/public-api/type-aliases/TriggerDefinition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerEvent.md b/docs/api/public-api/type-aliases/TriggerEvent.md index 7277f2cb..6501e7da 100644 --- a/docs/api/public-api/type-aliases/TriggerEvent.md +++ b/docs/api/public-api/type-aliases/TriggerEvent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerEventType.md b/docs/api/public-api/type-aliases/TriggerEventType.md index ac30fb63..5b8fc0bf 100644 --- a/docs/api/public-api/type-aliases/TriggerEventType.md +++ b/docs/api/public-api/type-aliases/TriggerEventType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerOnEventHandler.md b/docs/api/public-api/type-aliases/TriggerOnEventHandler.md index 61a0db15..2fd7f5a1 100644 --- a/docs/api/public-api/type-aliases/TriggerOnEventHandler.md +++ b/docs/api/public-api/type-aliases/TriggerOnEventHandler.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Trophy.md b/docs/api/public-api/type-aliases/Trophy.md index 83494105..963bd26c 100644 --- a/docs/api/public-api/type-aliases/Trophy.md +++ b/docs/api/public-api/type-aliases/Trophy.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UIClient.md b/docs/api/public-api/type-aliases/UIClient.md index 4af88595..7687fae5 100644 --- a/docs/api/public-api/type-aliases/UIClient.md +++ b/docs/api/public-api/type-aliases/UIClient.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UnreadCountResponse.md b/docs/api/public-api/type-aliases/UnreadCountResponse.md index 07602115..6666832e 100644 --- a/docs/api/public-api/type-aliases/UnreadCountResponse.md +++ b/docs/api/public-api/type-aliases/UnreadCountResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UpdatePageSettingsOptions.md b/docs/api/public-api/type-aliases/UpdatePageSettingsOptions.md index 6d7878b3..718a8819 100644 --- a/docs/api/public-api/type-aliases/UpdatePageSettingsOptions.md +++ b/docs/api/public-api/type-aliases/UpdatePageSettingsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UpdateRuleOptions.md b/docs/api/public-api/type-aliases/UpdateRuleOptions.md index f28b49e0..fa56e6aa 100644 --- a/docs/api/public-api/type-aliases/UpdateRuleOptions.md +++ b/docs/api/public-api/type-aliases/UpdateRuleOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UpdateWidgetData.md b/docs/api/public-api/type-aliases/UpdateWidgetData.md index e7a1c36d..bab77fa7 100644 --- a/docs/api/public-api/type-aliases/UpdateWidgetData.md +++ b/docs/api/public-api/type-aliases/UpdateWidgetData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UpdateWikiPageOptions.md b/docs/api/public-api/type-aliases/UpdateWikiPageOptions.md index c958315b..e3c543e9 100644 --- a/docs/api/public-api/type-aliases/UpdateWikiPageOptions.md +++ b/docs/api/public-api/type-aliases/UpdateWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UploadMediaOptions.md b/docs/api/public-api/type-aliases/UploadMediaOptions.md index 32450f6b..2d3a4051 100644 --- a/docs/api/public-api/type-aliases/UploadMediaOptions.md +++ b/docs/api/public-api/type-aliases/UploadMediaOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UrlString.md b/docs/api/public-api/type-aliases/UrlString.md index cc37a687..2030d2b7 100644 --- a/docs/api/public-api/type-aliases/UrlString.md +++ b/docs/api/public-api/type-aliases/UrlString.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserFlair.md b/docs/api/public-api/type-aliases/UserFlair.md index 76f74210..f557417f 100644 --- a/docs/api/public-api/type-aliases/UserFlair.md +++ b/docs/api/public-api/type-aliases/UserFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserFlairPageOptions.md b/docs/api/public-api/type-aliases/UserFlairPageOptions.md index 76fda218..4f16ae7f 100644 --- a/docs/api/public-api/type-aliases/UserFlairPageOptions.md +++ b/docs/api/public-api/type-aliases/UserFlairPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserLink.md b/docs/api/public-api/type-aliases/UserLink.md index 08e3cd6b..142f81a2 100644 --- a/docs/api/public-api/type-aliases/UserLink.md +++ b/docs/api/public-api/type-aliases/UserLink.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserLinkOptions.md b/docs/api/public-api/type-aliases/UserLinkOptions.md index bb1f7e4f..2b2331b1 100644 --- a/docs/api/public-api/type-aliases/UserLinkOptions.md +++ b/docs/api/public-api/type-aliases/UserLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserMention.md b/docs/api/public-api/type-aliases/UserMention.md index db5468a8..1b6e1435 100644 --- a/docs/api/public-api/type-aliases/UserMention.md +++ b/docs/api/public-api/type-aliases/UserMention.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserMentionOptions.md b/docs/api/public-api/type-aliases/UserMentionOptions.md index f860b32a..e66844c9 100644 --- a/docs/api/public-api/type-aliases/UserMentionOptions.md +++ b/docs/api/public-api/type-aliases/UserMentionOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserNote.md b/docs/api/public-api/type-aliases/UserNote.md index d381bb68..2f1c9783 100644 --- a/docs/api/public-api/type-aliases/UserNote.md +++ b/docs/api/public-api/type-aliases/UserNote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserNoteLabel.md b/docs/api/public-api/type-aliases/UserNoteLabel.md index 2f9afb51..ebaace62 100644 --- a/docs/api/public-api/type-aliases/UserNoteLabel.md +++ b/docs/api/public-api/type-aliases/UserNoteLabel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UserSocialLink.md b/docs/api/public-api/type-aliases/UserSocialLink.md index a81a55ed..3c588309 100644 --- a/docs/api/public-api/type-aliases/UserSocialLink.md +++ b/docs/api/public-api/type-aliases/UserSocialLink.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedBooleanField.md b/docs/api/public-api/type-aliases/ValidatedBooleanField.md index dc117310..a244c2f6 100644 --- a/docs/api/public-api/type-aliases/ValidatedBooleanField.md +++ b/docs/api/public-api/type-aliases/ValidatedBooleanField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedFormField.md b/docs/api/public-api/type-aliases/ValidatedFormField.md index ee50db52..c2f35934 100644 --- a/docs/api/public-api/type-aliases/ValidatedFormField.md +++ b/docs/api/public-api/type-aliases/ValidatedFormField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedNumberField.md b/docs/api/public-api/type-aliases/ValidatedNumberField.md index 42ea6683..af5beeb5 100644 --- a/docs/api/public-api/type-aliases/ValidatedNumberField.md +++ b/docs/api/public-api/type-aliases/ValidatedNumberField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedParagraphField.md b/docs/api/public-api/type-aliases/ValidatedParagraphField.md index 40c791a0..0b10aa93 100644 --- a/docs/api/public-api/type-aliases/ValidatedParagraphField.md +++ b/docs/api/public-api/type-aliases/ValidatedParagraphField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedSelectField.md b/docs/api/public-api/type-aliases/ValidatedSelectField.md index 282aa256..e64aceed 100644 --- a/docs/api/public-api/type-aliases/ValidatedSelectField.md +++ b/docs/api/public-api/type-aliases/ValidatedSelectField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedStringField.md b/docs/api/public-api/type-aliases/ValidatedStringField.md index c80f5b42..9b825d95 100644 --- a/docs/api/public-api/type-aliases/ValidatedStringField.md +++ b/docs/api/public-api/type-aliases/ValidatedStringField.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Vault.md b/docs/api/public-api/type-aliases/Vault.md index cb038178..1e14fd51 100644 --- a/docs/api/public-api/type-aliases/Vault.md +++ b/docs/api/public-api/type-aliases/Vault.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Video.md b/docs/api/public-api/type-aliases/Video.md index 6bff8303..50a1dd6d 100644 --- a/docs/api/public-api/type-aliases/Video.md +++ b/docs/api/public-api/type-aliases/Video.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/VideoContainer.md b/docs/api/public-api/type-aliases/VideoContainer.md index 122df8f9..486cb3f3 100644 --- a/docs/api/public-api/type-aliases/VideoContainer.md +++ b/docs/api/public-api/type-aliases/VideoContainer.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/VideoOptions.md b/docs/api/public-api/type-aliases/VideoOptions.md index 7764ab88..2f8b7f5c 100644 --- a/docs/api/public-api/type-aliases/VideoOptions.md +++ b/docs/api/public-api/type-aliases/VideoOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Visibility.md b/docs/api/public-api/type-aliases/Visibility.md index fb1fb61c..2ccefd45 100644 --- a/docs/api/public-api/type-aliases/Visibility.md +++ b/docs/api/public-api/type-aliases/Visibility.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/WikiEditMode.md b/docs/api/public-api/type-aliases/WikiEditMode.md index 2db9af46..a0a09a82 100644 --- a/docs/api/public-api/type-aliases/WikiEditMode.md +++ b/docs/api/public-api/type-aliases/WikiEditMode.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/WikiPageRevisionId.md b/docs/api/public-api/type-aliases/WikiPageRevisionId.md index ea6be3cb..6fa53849 100644 --- a/docs/api/public-api/type-aliases/WikiPageRevisionId.md +++ b/docs/api/public-api/type-aliases/WikiPageRevisionId.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/WikiVersion.md b/docs/api/public-api/type-aliases/WikiVersion.md index 0751b121..befece14 100644 --- a/docs/api/public-api/type-aliases/WikiVersion.md +++ b/docs/api/public-api/type-aliases/WikiVersion.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/WikiVersionOptions.md b/docs/api/public-api/type-aliases/WikiVersionOptions.md index 3f75d0b7..ae01b48c 100644 --- a/docs/api/public-api/type-aliases/WikiVersionOptions.md +++ b/docs/api/public-api/type-aliases/WikiVersionOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/WithUserData.md b/docs/api/public-api/type-aliases/WithUserData.md index a2e6f883..b06f2d4e 100644 --- a/docs/api/public-api/type-aliases/WithUserData.md +++ b/docs/api/public-api/type-aliases/WithUserData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ZMember.md b/docs/api/public-api/type-aliases/ZMember.md index d3c02485..9661ee52 100644 --- a/docs/api/public-api/type-aliases/ZMember.md +++ b/docs/api/public-api/type-aliases/ZMember.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ZRangeByScoreOptions.md b/docs/api/public-api/type-aliases/ZRangeByScoreOptions.md index 87cfb204..1760c95d 100644 --- a/docs/api/public-api/type-aliases/ZRangeByScoreOptions.md +++ b/docs/api/public-api/type-aliases/ZRangeByScoreOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ZRangeOptions.md b/docs/api/public-api/type-aliases/ZRangeOptions.md index b139d1f0..fca2fb8b 100644 --- a/docs/api/public-api/type-aliases/ZRangeOptions.md +++ b/docs/api/public-api/type-aliases/ZRangeOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/ANIMATED_IMAGE_ELEMENT.md b/docs/api/public-api/variables/ANIMATED_IMAGE_ELEMENT.md index 099cca49..083c8cea 100644 --- a/docs/api/public-api/variables/ANIMATED_IMAGE_ELEMENT.md +++ b/docs/api/public-api/variables/ANIMATED_IMAGE_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/BLOCK_QUOTE_ELEMENT.md b/docs/api/public-api/variables/BLOCK_QUOTE_ELEMENT.md index b64d1aaa..b73294a0 100644 --- a/docs/api/public-api/variables/BLOCK_QUOTE_ELEMENT.md +++ b/docs/api/public-api/variables/BLOCK_QUOTE_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/CODE_BLOCK_ELEMENT.md b/docs/api/public-api/variables/CODE_BLOCK_ELEMENT.md index 51ff1631..a32b7e3a 100644 --- a/docs/api/public-api/variables/CODE_BLOCK_ELEMENT.md +++ b/docs/api/public-api/variables/CODE_BLOCK_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/COLUMN_ALIGN_CENTER.md b/docs/api/public-api/variables/COLUMN_ALIGN_CENTER.md index dcb0a0e7..e0c298e9 100644 --- a/docs/api/public-api/variables/COLUMN_ALIGN_CENTER.md +++ b/docs/api/public-api/variables/COLUMN_ALIGN_CENTER.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/COLUMN_ALIGN_LEFT.md b/docs/api/public-api/variables/COLUMN_ALIGN_LEFT.md index 3283bd29..8edb1110 100644 --- a/docs/api/public-api/variables/COLUMN_ALIGN_LEFT.md +++ b/docs/api/public-api/variables/COLUMN_ALIGN_LEFT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/COLUMN_ALIGN_RIGHT.md b/docs/api/public-api/variables/COLUMN_ALIGN_RIGHT.md index 34adcaf3..be1b1351 100644 --- a/docs/api/public-api/variables/COLUMN_ALIGN_RIGHT.md +++ b/docs/api/public-api/variables/COLUMN_ALIGN_RIGHT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/COMMENT_LINK_ELEMENT.md b/docs/api/public-api/variables/COMMENT_LINK_ELEMENT.md index f7622629..30474b36 100644 --- a/docs/api/public-api/variables/COMMENT_LINK_ELEMENT.md +++ b/docs/api/public-api/variables/COMMENT_LINK_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/EMBED_ELEMENT.md b/docs/api/public-api/variables/EMBED_ELEMENT.md index 6e4647a0..5597e726 100644 --- a/docs/api/public-api/variables/EMBED_ELEMENT.md +++ b/docs/api/public-api/variables/EMBED_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/GalleryMediaStatus.md b/docs/api/public-api/variables/GalleryMediaStatus.md index e65c0073..8572c2f8 100644 --- a/docs/api/public-api/variables/GalleryMediaStatus.md +++ b/docs/api/public-api/variables/GalleryMediaStatus.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/HEADING_ELEMENT.md b/docs/api/public-api/variables/HEADING_ELEMENT.md index fabdb6ec..b940b57e 100644 --- a/docs/api/public-api/variables/HEADING_ELEMENT.md +++ b/docs/api/public-api/variables/HEADING_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/HORIZONTAL_RULE_ELEMENT.md b/docs/api/public-api/variables/HORIZONTAL_RULE_ELEMENT.md index 23c94c11..628696dc 100644 --- a/docs/api/public-api/variables/HORIZONTAL_RULE_ELEMENT.md +++ b/docs/api/public-api/variables/HORIZONTAL_RULE_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/IMAGE_ELEMENT.md b/docs/api/public-api/variables/IMAGE_ELEMENT.md index 6e5a752a..6791c4af 100644 --- a/docs/api/public-api/variables/IMAGE_ELEMENT.md +++ b/docs/api/public-api/variables/IMAGE_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/LINEBREAK_ELEMENT.md b/docs/api/public-api/variables/LINEBREAK_ELEMENT.md index 4ed77385..087b4473 100644 --- a/docs/api/public-api/variables/LINEBREAK_ELEMENT.md +++ b/docs/api/public-api/variables/LINEBREAK_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/LINK_ELEMENT.md b/docs/api/public-api/variables/LINK_ELEMENT.md index 2fc3799d..5d4e9d40 100644 --- a/docs/api/public-api/variables/LINK_ELEMENT.md +++ b/docs/api/public-api/variables/LINK_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/LIST_ELEMENT.md b/docs/api/public-api/variables/LIST_ELEMENT.md index fc3634cd..eadc2b28 100644 --- a/docs/api/public-api/variables/LIST_ELEMENT.md +++ b/docs/api/public-api/variables/LIST_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/LIST_ITEM_ELEMENT.md b/docs/api/public-api/variables/LIST_ITEM_ELEMENT.md index bb3a34e1..87f8de9c 100644 --- a/docs/api/public-api/variables/LIST_ITEM_ELEMENT.md +++ b/docs/api/public-api/variables/LIST_ITEM_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/PARAGRAPH_ELEMENT.md b/docs/api/public-api/variables/PARAGRAPH_ELEMENT.md index 02b7edc5..4a0cb06d 100644 --- a/docs/api/public-api/variables/PARAGRAPH_ELEMENT.md +++ b/docs/api/public-api/variables/PARAGRAPH_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/POST_LINK_ELEMENT.md b/docs/api/public-api/variables/POST_LINK_ELEMENT.md index 8456bca5..1926ce56 100644 --- a/docs/api/public-api/variables/POST_LINK_ELEMENT.md +++ b/docs/api/public-api/variables/POST_LINK_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/RAW_TEXT_ELEMENT.md b/docs/api/public-api/variables/RAW_TEXT_ELEMENT.md index 2d227444..c9f489e8 100644 --- a/docs/api/public-api/variables/RAW_TEXT_ELEMENT.md +++ b/docs/api/public-api/variables/RAW_TEXT_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/SPOILER_TEXT_ELEMENT.md b/docs/api/public-api/variables/SPOILER_TEXT_ELEMENT.md index 6973eceb..b8b3fe44 100644 --- a/docs/api/public-api/variables/SPOILER_TEXT_ELEMENT.md +++ b/docs/api/public-api/variables/SPOILER_TEXT_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/SUBREDDIT_LINK_ELEMENT.md b/docs/api/public-api/variables/SUBREDDIT_LINK_ELEMENT.md index a956c62e..0c7d47d1 100644 --- a/docs/api/public-api/variables/SUBREDDIT_LINK_ELEMENT.md +++ b/docs/api/public-api/variables/SUBREDDIT_LINK_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/TABLE_ELEMENT.md b/docs/api/public-api/variables/TABLE_ELEMENT.md index a4c8ae72..1bb9f541 100644 --- a/docs/api/public-api/variables/TABLE_ELEMENT.md +++ b/docs/api/public-api/variables/TABLE_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/TEXT_ELEMENT.md b/docs/api/public-api/variables/TEXT_ELEMENT.md index 985f25c0..0bf350c3 100644 --- a/docs/api/public-api/variables/TEXT_ELEMENT.md +++ b/docs/api/public-api/variables/TEXT_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/USER_LINK_ELEMENT.md b/docs/api/public-api/variables/USER_LINK_ELEMENT.md index 028dee6b..b741169a 100644 --- a/docs/api/public-api/variables/USER_LINK_ELEMENT.md +++ b/docs/api/public-api/variables/USER_LINK_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/USER_MENTION_ELEMENT.md b/docs/api/public-api/variables/USER_MENTION_ELEMENT.md index f967b252..db495809 100644 --- a/docs/api/public-api/variables/USER_MENTION_ELEMENT.md +++ b/docs/api/public-api/variables/USER_MENTION_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/VIDEO_ELEMENT.md b/docs/api/public-api/variables/VIDEO_ELEMENT.md index a6ed819c..d0dd8b36 100644 --- a/docs/api/public-api/variables/VIDEO_ELEMENT.md +++ b/docs/api/public-api/variables/VIDEO_ELEMENT.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/reddit.md b/docs/api/public-api/variables/reddit.md index 1ba75a35..0aeb6c78 100644 --- a/docs/api/public-api/variables/reddit.md +++ b/docs/api/public-api/variables/reddit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) +[**@devvit/public-api v0.14.3-dev**](../README.md) *** diff --git a/docs/api/redditapi/README.md b/docs/api/redditapi/README.md index b7b85b8b..d2062064 100644 --- a/docs/api/redditapi/README.md +++ b/docs/api/redditapi/README.md @@ -1,8 +1,8 @@ -**@devvit/reddit v0.14.1-dev** +**@devvit/reddit v0.14.3-dev** *** -# @devvit/reddit v0.14.1-dev +# @devvit/reddit v0.14.3-dev ## Modules diff --git a/docs/api/redditapi/RedditClient/README.md b/docs/api/redditapi/RedditClient/README.md index 901cdd52..ee51baa3 100644 --- a/docs/api/redditapi/RedditClient/README.md +++ b/docs/api/redditapi/RedditClient/README.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../README.md) +[**@devvit/reddit v0.14.3-dev**](../README.md) *** diff --git a/docs/api/redditapi/RedditClient/classes/RedditClient.md b/docs/api/redditapi/RedditClient/classes/RedditClient.md index 47a679d8..4b8042e6 100644 --- a/docs/api/redditapi/RedditClient/classes/RedditClient.md +++ b/docs/api/redditapi/RedditClient/classes/RedditClient.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -114,21 +114,28 @@ Options for the request. > **addModNote**(`options`): `Promise`\<[`ModNote`](../../models/classes/ModNote.md)\> -Add a mod note. +Adds a moderation note to a user and returns the created note. #### Parameters ##### options -`Prettify` - -Options for the request +[`CreateModNoteOptions`](../../models/type-aliases/CreateModNoteOptions.md) #### Returns `Promise`\<[`ModNote`](../../models/classes/ModNote.md)\> -A Promise that resolves if the mod note was successfully added. +#### Example + +```ts +const modNote = await reddit.addModNote({ + subreddit: 'wallstreetbets', + user: 'spez', + note: 'Repeated rule 1 violations', + label: 'ABUSE_WARNING', +}); +``` *** @@ -138,18 +145,28 @@ A Promise that resolves if the mod note was successfully added. > **addRemovalNote**(`options`): `Promise`\<`void`\> -Add a mod note for why a post or comment was removed +Adds a removal note to each specified post or comment. #### Parameters ##### options -`Prettify` +[`AddRemovalNoteOptions`](../../models/type-aliases/AddRemovalNoteOptions.md) #### Returns `Promise`\<`void`\> +#### Example + +```ts +await reddit.addRemovalNote({ + itemIds: ['t1_abc123', 't3_def456'], + reasonId: '', + modNote: 'Removed for breaking rule 1', +}); +``` + *** @@ -555,22 +572,18 @@ The ID of the flair template to delete. > **deleteModNote**(`options`): `Promise`\<`boolean`\> -Delete a mod note. +Deletes a moderation note. Returns true if successful. #### Parameters ##### options -`Prettify` - -Options for the request +[`DeleteNotesOptions`](../../models/type-aliases/DeleteNotesOptions.md) #### Returns `Promise`\<`boolean`\> -True if it was deleted successfully; false otherwise. - *** @@ -1278,21 +1291,29 @@ A Listing of SubredditModeratorUser objects. > **getModNotes**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`ModNote`](../../models/classes/ModNote.md)\> -Get a list of mod notes related to a user in a subreddit. +Get a user's moderation notes within a subreddit. #### Parameters ##### options -`Prettify` - -Options for the request +[`GetModNotesOptions`](../../models/type-aliases/GetModNotesOptions.md) #### Returns [`Listing`](../../models/classes/Listing.md)\<[`ModNote`](../../models/classes/ModNote.md)\> -A listing of ModNote objects. +#### Example + +```ts +const notes = await reddit + .getModNotes({ + subreddit: 'wallstreetbets', + user: 'spez', + filter: 'NOTE', + }) + .get(25); +``` *** @@ -2378,7 +2399,7 @@ A Listing of SubredditWikiContributorUser objects. #### Call Signature -> **getWikiPage**(`subredditName`, `page`, `revisionId`?): `Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\> +> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\> Get a specific revision of a wiki page from a subreddit. @@ -2396,12 +2417,12 @@ The name of the subreddit to get the wiki page from. The name of the wiki page to get. -###### revisionId? - -`` `${string}-${string}-${string}-${string}-${string}` `` +###### revisionId The revision ID of the wiki page version to get. Leaving it empty returns the latest version. +`undefined` | `` `${string}-${string}-${string}-${string}-${string}` `` + ##### Returns `Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\> diff --git a/docs/api/redditapi/RedditClient/type-aliases/CustomPostStyles.md b/docs/api/redditapi/RedditClient/type-aliases/CustomPostStyles.md index e3a0f5b0..a4d008a2 100644 --- a/docs/api/redditapi/RedditClient/type-aliases/CustomPostStyles.md +++ b/docs/api/redditapi/RedditClient/type-aliases/CustomPostStyles.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/RedditClient/type-aliases/InviteModeratorOptions.md b/docs/api/redditapi/RedditClient/type-aliases/InviteModeratorOptions.md index 378b805a..dcddbbb7 100644 --- a/docs/api/redditapi/RedditClient/type-aliases/InviteModeratorOptions.md +++ b/docs/api/redditapi/RedditClient/type-aliases/InviteModeratorOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/RedditClient/type-aliases/MuteUserOptions.md b/docs/api/redditapi/RedditClient/type-aliases/MuteUserOptions.md index e0b9c066..8201bb80 100644 --- a/docs/api/redditapi/RedditClient/type-aliases/MuteUserOptions.md +++ b/docs/api/redditapi/RedditClient/type-aliases/MuteUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/README.md b/docs/api/redditapi/models/README.md index b5a83862..a11eecea 100644 --- a/docs/api/redditapi/models/README.md +++ b/docs/api/redditapi/models/README.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../README.md) +[**@devvit/reddit v0.14.3-dev**](../README.md) *** diff --git a/docs/api/redditapi/models/classes/AuthorFlairSettings.md b/docs/api/redditapi/models/classes/AuthorFlairSettings.md index e7ab1899..074dd5f0 100644 --- a/docs/api/redditapi/models/classes/AuthorFlairSettings.md +++ b/docs/api/redditapi/models/classes/AuthorFlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ButtonWidget.md b/docs/api/redditapi/models/classes/ButtonWidget.md index bfa66924..2b9a035d 100644 --- a/docs/api/redditapi/models/classes/ButtonWidget.md +++ b/docs/api/redditapi/models/classes/ButtonWidget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/CalendarWidget.md b/docs/api/redditapi/models/classes/CalendarWidget.md index 9c172353..62dea50c 100644 --- a/docs/api/redditapi/models/classes/CalendarWidget.md +++ b/docs/api/redditapi/models/classes/CalendarWidget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Comment.md b/docs/api/redditapi/models/classes/Comment.md index 7f65e2e0..1f1074a6 100644 --- a/docs/api/redditapi/models/classes/Comment.md +++ b/docs/api/redditapi/models/classes/Comment.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -14,6 +14,8 @@ > **get** **approved**(): `boolean` +Whether the comment has been approved by a moderator. + ##### Returns `boolean` @@ -28,6 +30,11 @@ > **get** **approvedAtUtc**(): `number` +The moderation approval time as Unix seconds, or `0` when unavailable. + +Use [approved](#approved) to check the current approval state. Convert a +nonzero value to a `Date` with `new Date(comment.approvedAtUtc * 1000)`. + ##### Returns `number` @@ -42,6 +49,8 @@ > **get** **authorFlair**(): `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) +The author's subreddit flair, or `undefined` when unavailable. + ##### Returns `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) @@ -56,6 +65,8 @@ > **get** **authorId**(): `undefined` \| `` `t2_${string}` `` +The creator's account identifier or `undefined` when unavailable. + ##### Returns `undefined` \| `` `t2_${string}` `` @@ -70,6 +81,15 @@ > **get** **authorName**(): `string` +The creator's username without the leading `u/`. May be `"[deleted]"` when +the author is unavailable. + +##### Example + +```ts +"Example_User" +``` + ##### Returns `string` @@ -84,6 +104,11 @@ > **get** **bannedAtUtc**(): `number` +The ban time as Unix seconds, or `0` when unavailable. + +Convert a nonzero value to a `Date` with +`new Date(comment.bannedAtUtc * 1000)`. + ##### Returns `number` @@ -98,6 +123,8 @@ > **get** **body**(): `string` +The comment body in Markdown. + ##### Returns `string` @@ -112,6 +139,8 @@ > **get** **collapsedBecauseCrowdControl**(): `boolean` +Whether Crowd Control caused the comment to be collapsed. + ##### Returns `boolean` @@ -126,6 +155,8 @@ > **get** **createdAt**(): `Date` +The date when the comment was created. + ##### Returns `Date` @@ -140,6 +171,12 @@ > **get** **distinguishedBy**(): `undefined` \| `string` +The comment's distinction category. + +For example, a comment distinguished by a moderator or administrator +returns `"moderator"` or `"admin"`. `undefined` means no distinction is +available. + ##### Returns `undefined` \| `string` @@ -154,6 +191,8 @@ > **get** **edited**(): `boolean` +Whether the comment body has been edited since it was created. + ##### Returns `boolean` @@ -182,6 +221,8 @@ > **get** **ignoringReports**(): `boolean` +Whether reports on the comment are being ignored. + ##### Returns `boolean` @@ -196,6 +237,8 @@ > **get** **locked**(): `boolean` +Whether the comment is locked and new replies are disabled. + ##### Returns `boolean` @@ -228,6 +271,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **modReports**(): [`ModeratorReport`](../type-aliases/ModeratorReport.md)[] +Moderator reports and authors, or an empty array when unavailable. + ##### Returns [`ModeratorReport`](../type-aliases/ModeratorReport.md)[] @@ -242,6 +287,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **numReports**(): `number` +The number of reports, or `0` when none are available. + ##### Returns `number` @@ -256,6 +303,11 @@ Use [modReports](#modreports) to retain each report's author. > **get** **parentId**(): `` `t1_${string}` `` \| `` `t3_${string}` `` +The identifier of the comment's parent. + +A top-level comment returns the containing post's `T3`. A reply returns its +parent comment's `T1`. + ##### Returns `` `t1_${string}` `` \| `` `t3_${string}` `` @@ -270,6 +322,14 @@ Use [modReports](#modreports) to retain each report's author. > **get** **permalink**(): `string` +The comment's path relative to `https://www.reddit.com`. + +##### Example + +```ts +"/r/wallstreetbets/comments/abc123/example_post/def456/" +``` + ##### Returns `string` @@ -284,6 +344,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **postId**(): `` `t3_${string}` `` +The identifier of the post containing the comment. + ##### Returns `` `t3_${string}` `` @@ -298,6 +360,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **removed**(): `boolean` +Whether the comment has been removed by a moderator. + ##### Returns `boolean` @@ -312,6 +376,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **replies**(): [`Listing`](Listing.md)\<`Comment`\> +The comment's direct replies. + ##### Returns [`Listing`](Listing.md)\<`Comment`\> @@ -326,6 +392,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **score**(): `number` +The comment's upvotes minus downvotes, or `0` when unavailable. + ##### Returns `number` @@ -340,6 +408,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **spam**(): `boolean` +Whether the comment has been marked as spam by a moderator. + ##### Returns `boolean` @@ -354,6 +424,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **stickied**(): `boolean` +Whether the comment is pinned to the top of its comment thread. + ##### Returns `boolean` @@ -368,6 +440,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **subredditId**(): `` `t5_${string}` `` +The subreddit identifier where the comment was created. + ##### Returns `` `t5_${string}` `` @@ -382,6 +456,15 @@ Use [modReports](#modreports) to retain each report's author. > **get** **subredditName**(): `string` +The name of the subreddit that contains the comment, without the leading +`r/`. + +##### Example + +```ts +"AskReddit" +``` + ##### Returns `string` @@ -396,6 +479,14 @@ Use [modReports](#modreports) to retain each report's author. > **get** **url**(): `string` +The absolute `https://www.reddit.com` URL for the comment. + +##### Example + +```ts +"https://www.reddit.com/r/wallstreetbets/comments/abc123/post/def456/" +``` + ##### Returns `string` @@ -410,6 +501,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **userReportReasons**(): `string`[] +User report reasons, or an empty array when none are available. + ##### Returns `string`[] @@ -422,19 +515,13 @@ Use [modReports](#modreports) to retain each report's author. > **addRemovalNote**(`opts`): `Promise`\<`void`\> -Add a mod note for why the comment was removed +Adds a moderator note explaining why the comment was removed. #### Parameters ##### opts -###### modNote? - -`string` - -###### reasonId - -`string` +`Readonly`\<`Omit`\<[`AddRemovalNoteOptions`](../type-aliases/AddRemovalNoteOptions.md), `"itemIds"`\>\> #### Returns @@ -448,6 +535,8 @@ Add a mod note for why the comment was removed > **approve**(): `Promise`\<`void`\> +Approves the comment and updates this instance's moderation state. + #### Returns `Promise`\<`void`\> @@ -460,6 +549,10 @@ Add a mod note for why the comment was removed > **delete**(): `Promise`\<`void`\> +Deletes the comment as the app account. + +The `runAs` option is ignored when editing a comment. + #### Returns `Promise`\<`void`\> @@ -472,12 +565,16 @@ Add a mod note for why the comment was removed > **distinguish**(`makeSticky`): `Promise`\<`void`\> +Distinguishes the comment as a moderator and updates this instance. + #### Parameters ##### makeSticky `boolean` = `false` +Whether to pin the comment to the top of its thread. + #### Returns `Promise`\<`void`\> @@ -490,12 +587,16 @@ Add a mod note for why the comment was removed > **distinguishAsAdmin**(`makeSticky`): `Promise`\<`void`\> +Distinguishes the comment as an employee and updates this instance. + #### Parameters ##### makeSticky `boolean` = `false` +Whether to pin the comment to the top of its thread. + #### Returns `Promise`\<`void`\> @@ -508,6 +609,11 @@ Add a mod note for why the comment was removed > **edit**(`opts`): `Promise`\<`Comment`\> +Replaces the comment body as the app account, then updates the cached body +and edited state from the response. + +The `runAs` option is ignored when editing a comment. + #### Parameters ##### opts @@ -537,14 +643,10 @@ Filters the comment. When a comment is filtered, it is added to the ModQueue for `FilterOptions` -The options for this filter action. - #### Returns `Promise`\<`void`\> -A Promise that resolves if the comment was filtered successfully. - *** @@ -553,6 +655,8 @@ A Promise that resolves if the comment was filtered successfully. > **getAuthor**(): `Promise`\<`undefined` \| [`User`](User.md)\> +Fetches the author's account, or `undefined` if it is unavailable. + #### Returns `Promise`\<`undefined` \| [`User`](User.md)\> @@ -565,6 +669,8 @@ A Promise that resolves if the comment was filtered successfully. > **ignoreReports**(): `Promise`\<`void`\> +Ignores reports and updates this instance's report-ignore state. + #### Returns `Promise`\<`void`\> @@ -577,6 +683,8 @@ A Promise that resolves if the comment was filtered successfully. > **isApproved**(): `boolean` +The comment's approval state. + #### Returns `boolean` @@ -589,6 +697,8 @@ A Promise that resolves if the comment was filtered successfully. > **isDistinguished**(): `boolean` +The comment's distinguished category state. + #### Returns `boolean` @@ -601,6 +711,8 @@ A Promise that resolves if the comment was filtered successfully. > **isEdited**(): `boolean` +The comment's edited state. + #### Returns `boolean` @@ -613,6 +725,8 @@ A Promise that resolves if the comment was filtered successfully. > **isIgnoringReports**(): `boolean` +The comment's report-ignore state. + #### Returns `boolean` @@ -625,6 +739,8 @@ A Promise that resolves if the comment was filtered successfully. > **isLocked**(): `boolean` +The comment's locked state. + #### Returns `boolean` @@ -637,6 +753,8 @@ A Promise that resolves if the comment was filtered successfully. > **isRemoved**(): `boolean` +The comment's removal state. + #### Returns `boolean` @@ -649,6 +767,8 @@ A Promise that resolves if the comment was filtered successfully. > **isSpam**(): `boolean` +The comment's spam state. + #### Returns `boolean` @@ -661,6 +781,8 @@ A Promise that resolves if the comment was filtered successfully. > **isStickied**(): `boolean` +The comment's stickied state. + #### Returns `boolean` @@ -673,6 +795,8 @@ A Promise that resolves if the comment was filtered successfully. > **lock**(): `Promise`\<`void`\> +Disables new replies and updates this instance's locked state. + #### Returns `Promise`\<`void`\> @@ -685,12 +809,16 @@ A Promise that resolves if the comment was filtered successfully. > **remove**(`isSpam`): `Promise`\<`void`\> +Removes the comment and updates this instance's moderation state. + #### Parameters ##### isSpam `boolean` = `false` +Whether to classify the removed comment as spam. + #### Returns `Promise`\<`void`\> @@ -703,6 +831,8 @@ A Promise that resolves if the comment was filtered successfully. > **reply**(`opts`): `Promise`\<`Comment`\> +Creates a direct reply to the comment. + #### Parameters ##### opts @@ -721,8 +851,8 @@ A Promise that resolves if the comment was filtered successfully. > **showComment**(): `Promise`\<`void`\> -Marks that this comment should not be collapsed by the crowd control system. -It can still be collapsed for other reasons. +Prevents Crowd Control from collapsing the comment. Other rules can still +collapse it. #### Returns @@ -736,8 +866,8 @@ It can still be collapsed for other reasons. > **snoozeReports**(`reason`): `Promise`\<`void`\> -Snooze subsequent reports with the given reason from the same users for the next 7 days. -Only works for free-form reports. +Snoozes subsequent reports with the same reason from the same users for +seven days. This only works for free-form reports. #### Parameters @@ -759,6 +889,8 @@ The report reason to snooze. > **toJSON**(): `Pick`\<`Comment`, `"id"` \| `"subredditName"` \| `"postId"` \| `"body"` \| `"permalink"` \| `"createdAt"` \| `"url"` \| `"authorName"` \| `"subredditId"` \| `"score"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"edited"` \| `"locked"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"parentId"` \| `"replies"` \| `"numReports"` \| `"collapsedBecauseCrowdControl"`\> +Returns the public fields included when the comment is serialized. + #### Returns `Pick`\<`Comment`, `"id"` \| `"subredditName"` \| `"postId"` \| `"body"` \| `"permalink"` \| `"createdAt"` \| `"url"` \| `"authorName"` \| `"subredditId"` \| `"score"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"edited"` \| `"locked"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"parentId"` \| `"replies"` \| `"numReports"` \| `"collapsedBecauseCrowdControl"`\> @@ -771,6 +903,9 @@ The report reason to snooze. > **undistinguish**(): `Promise`\<`void`\> +Removes the distinction category and sticky status and updates this +instance. + #### Returns `Promise`\<`void`\> @@ -783,6 +918,8 @@ The report reason to snooze. > **unignoreReports**(): `Promise`\<`void`\> +Stops ignoring reports and updates this instance's cached state. + #### Returns `Promise`\<`void`\> @@ -795,6 +932,8 @@ The report reason to snooze. > **unlock**(): `Promise`\<`void`\> +Enables new replies and updates this instance's locked state. + #### Returns `Promise`\<`void`\> @@ -807,8 +946,8 @@ The report reason to snooze. > **unsnoozeReports**(`reason`): `Promise`\<`void`\> -Unsnooze reports with the given reason. -Only works for free-form reports. +Unsnoozes reports with the given reason. This only works for free-form +reports. #### Parameters diff --git a/docs/api/redditapi/models/classes/CommunityListWidget.md b/docs/api/redditapi/models/classes/CommunityListWidget.md index 551f2270..56ecfb45 100644 --- a/docs/api/redditapi/models/classes/CommunityListWidget.md +++ b/docs/api/redditapi/models/classes/CommunityListWidget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/CustomWidget.md b/docs/api/redditapi/models/classes/CustomWidget.md index 4e261bea..5cc02371 100644 --- a/docs/api/redditapi/models/classes/CustomWidget.md +++ b/docs/api/redditapi/models/classes/CustomWidget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Flair.md b/docs/api/redditapi/models/classes/Flair.md index 8185b64f..55f1ff10 100644 --- a/docs/api/redditapi/models/classes/Flair.md +++ b/docs/api/redditapi/models/classes/Flair.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/FlairTemplate.md b/docs/api/redditapi/models/classes/FlairTemplate.md index 85624f73..e70461c4 100644 --- a/docs/api/redditapi/models/classes/FlairTemplate.md +++ b/docs/api/redditapi/models/classes/FlairTemplate.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ImageWidget.md b/docs/api/redditapi/models/classes/ImageWidget.md index b59872bc..4704c38a 100644 --- a/docs/api/redditapi/models/classes/ImageWidget.md +++ b/docs/api/redditapi/models/classes/ImageWidget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Listing.md b/docs/api/redditapi/models/classes/Listing.md index a2e86677..76219b00 100644 --- a/docs/api/redditapi/models/classes/Listing.md +++ b/docs/api/redditapi/models/classes/Listing.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ModMailService.md b/docs/api/redditapi/models/classes/ModMailService.md index b822f59d..ecc7bd2b 100644 --- a/docs/api/redditapi/models/classes/ModMailService.md +++ b/docs/api/redditapi/models/classes/ModMailService.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ModNote.md b/docs/api/redditapi/models/classes/ModNote.md index da79ded3..f05fea34 100644 --- a/docs/api/redditapi/models/classes/ModNote.md +++ b/docs/api/redditapi/models/classes/ModNote.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Post.md b/docs/api/redditapi/models/classes/Post.md index 18745b61..3d51ec76 100644 --- a/docs/api/redditapi/models/classes/Post.md +++ b/docs/api/redditapi/models/classes/Post.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -14,6 +14,8 @@ > **get** **approved**(): `boolean` +Whether the post has been approved by a moderator. + ##### Returns `boolean` @@ -28,6 +30,11 @@ > **get** **approvedAtUtc**(): `number` +The moderation approval time as Unix seconds, or `0` when unavailable. + +Use [approved](#approved) to check the current approval state. Convert a nonzero +value to a `Date` with `new Date(post.approvedAtUtc * 1000)`. + ##### Returns `number` @@ -42,6 +49,8 @@ > **get** **archived**(): `boolean` +Whether the post is archived. + ##### Returns `boolean` @@ -56,6 +65,8 @@ > **get** **authorFlair**(): `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) +The author's subreddit flair, or `undefined` when unavailable. + ##### Returns `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) @@ -70,6 +81,8 @@ > **get** **authorId**(): `undefined` \| `` `t2_${string}` `` +The creator's account identifier, or `undefined` when unavailable. + ##### Returns `undefined` \| `` `t2_${string}` `` @@ -84,6 +97,8 @@ > **get** **authorName**(): `string` +The creator's username without the leading `u/`. + ##### Returns `string` @@ -98,6 +113,11 @@ > **get** **bannedAtUtc**(): `number` +The ban time as Unix seconds, or `0` when unavailable. + +Convert a nonzero value to a `Date` with +`new Date(post.bannedAtUtc * 1000)`. + ##### Returns `number` @@ -112,6 +132,8 @@ > **get** **body**(): `undefined` \| `string` +The post body in Markdown. `undefined` if absent. + ##### Returns `undefined` \| `string` @@ -126,6 +148,8 @@ > **get** **bodyHtml**(): `undefined` \| `string` +The post body rendered as HTML, or `undefined` when unavailable. + ##### Returns `undefined` \| `string` @@ -140,6 +164,15 @@ > **get** **comments**(): [`Listing`](Listing.md)\<[`Comment`](Comment.md)\> +A listing of the post's top-level comments. Each comment exposes its +replies separately. + +##### Example + +```ts +const comments = await post.comments.get(25); +``` + ##### Returns [`Listing`](Listing.md)\<[`Comment`](Comment.md)\> @@ -154,6 +187,8 @@ > **get** **createdAt**(): `Date` +The date when the post was created. + ##### Returns `Date` @@ -168,7 +203,8 @@ > **get** **crosspostParentId**(): `undefined` \| `` `t3_${string}` `` -The ID of the original post this was crossposted from. Undefined if this post is not a crosspost. +The original post's identifier when this post is a crosspost. `undefined` +if not a crosspost or parent is unavailable. ##### Returns @@ -184,6 +220,11 @@ The ID of the original post this was crossposted from. Undefined if this post is > **get** **distinguishedBy**(): `undefined` \| `string` +The post's distinction category. + +For example, a post distinguished by a moderator or employee returns +`"moderator"` or `"admin"`. `undefined` means no distinction is available. + ##### Returns `undefined` \| `string` @@ -198,6 +239,8 @@ The ID of the original post this was crossposted from. Undefined if this post is > **get** **edited**(): `boolean` +Whether the post body has been edited since it was created. + ##### Returns `boolean` @@ -212,6 +255,8 @@ The ID of the original post this was crossposted from. Undefined if this post is > **get** **flair**(): `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) +The post flair, or `undefined` when unavailable. + ##### Returns `undefined` \| [`CommonFlair`](../type-aliases/CommonFlair.md) @@ -226,7 +271,11 @@ The ID of the original post this was crossposted from. Undefined if this post is > **get** **gallery**(): [`GalleryMedia`](../type-aliases/GalleryMedia.md)[] -Get the media in the post. Empty if the post doesn't have any media. +Get the image or GIF metadata in the post. Empty if the post doesn't have +any media. + +Gallery posts can contain multiple entries. For other posts, one entry from +the first preview image or GIF variant. ##### Returns @@ -242,6 +291,8 @@ Get the media in the post. Empty if the post doesn't have any media. > **get** **hidden**(): `boolean` +Whether the post is hidden from listings. + ##### Returns `boolean` @@ -270,6 +321,8 @@ Get the media in the post. Empty if the post doesn't have any media. > **get** **ignoringReports**(): `boolean` +Whether reports on the post are being ignored. + ##### Returns `boolean` @@ -284,6 +337,8 @@ Get the media in the post. Empty if the post doesn't have any media. > **get** **locked**(): `boolean` +Whether the post is locked and new comments are disabled. + ##### Returns `boolean` @@ -316,6 +371,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **modReports**(): [`ModeratorReport`](../type-aliases/ModeratorReport.md)[] +Moderator reports and authors, or an empty array when unavailable. + ##### Returns [`ModeratorReport`](../type-aliases/ModeratorReport.md)[] @@ -330,6 +387,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **nsfw**(): `boolean` +Whether the post is marked not safe for work (NSFW). + ##### Returns `boolean` @@ -344,6 +403,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **numberOfComments**(): `number` +The number of comments, or `0` when none are available. + ##### Returns `number` @@ -358,6 +419,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **numberOfReports**(): `number` +The number of reports, or `0` when none are available. + ##### Returns `number` @@ -372,6 +435,14 @@ Use [modReports](#modreports) to retain each report's author. > **get** **permalink**(): `string` +The post's path relative to `https://www.reddit.com`. + +##### Example + +```ts +"/r/wallstreetbets/comments/abc123/post/" +``` + ##### Returns `string` @@ -386,7 +457,8 @@ Use [modReports](#modreports) to retain each report's author. > **get** **pollData**(): `undefined` \| [`PollData`](../type-aliases/PollData.md) -Poll data for the post, if the post is a poll. Undefined otherwise. +The post's poll options, vote totals, and voting end time. `undefined` if +the post is not a poll. ##### Returns @@ -402,6 +474,8 @@ Poll data for the post, if the post is a poll. Undefined otherwise. > **get** **quarantined**(): `boolean` +Whether the post is quarantined. + ##### Returns `boolean` @@ -416,6 +490,8 @@ Poll data for the post, if the post is a poll. Undefined otherwise. > **get** **removed**(): `boolean` +Whether the post has been removed by a moderator. + ##### Returns `boolean` @@ -430,7 +506,8 @@ Poll data for the post, if the post is a poll. Undefined otherwise. > **get** **removedBy**(): `undefined` \| `string` -Who removed this object (username) +The username of the account that removed the post, without the leading +`u/`, or `undefined` when unavailable. ##### Returns @@ -446,17 +523,18 @@ Who removed this object (username) > **get** **removedByCategory**(): `undefined` \| `string` -who/what removed this object. It will return one of the following: -- "anti_evil_ops": object is removed by a aeops member -- "author": object is removed by author of the post -- "automod_filtered": object is filtered by automod -- "community_ops": object is removed by a community team member -- "content_takedown": object is removed due to content violation -- "copyright_takedown": object is removed due to copyright violation -- "deleted": object is deleted -- "moderator": object is removed by a mod of the sub -- "reddit": object is removed by anyone else -- undefined: object is not removed +Identifies who or what removed the post: + +- `"anti_evil_ops"`: Reddit Anti-Evil Operations. +- `"author"`: The post's author. +- `"automod_filtered"`: AutoModerator filtering. +- `"community_ops"`: Reddit Community Operations. +- `"content_takedown"`: A content-policy takedown. +- `"copyright_takedown"`: A copyright takedown. +- `"deleted"`: The post was deleted. +- `"moderator"`: A subreddit moderator. +- `"reddit"`: Any other remover. +- `undefined`: No removal category is available. ##### Returns @@ -472,6 +550,8 @@ who/what removed this object. It will return one of the following: > **get** **score**(): `number` +The post's upvotes minus downvotes, or `0` when unavailable. + ##### Returns `number` @@ -486,6 +566,11 @@ who/what removed this object. It will return one of the following: > **get** **secureMedia**(): `undefined` \| [`SecureMedia`](../type-aliases/SecureMedia.md) +Metadata for embedded or Reddit-hosted media, including oEmbed or Reddit +video data. + +Returns `undefined` when the post has no secure media metadata. + ##### Returns `undefined` \| [`SecureMedia`](../type-aliases/SecureMedia.md) @@ -500,6 +585,8 @@ who/what removed this object. It will return one of the following: > **get** **spam**(): `boolean` +Whether the post has been marked as spam by a moderator. + ##### Returns `boolean` @@ -514,6 +601,8 @@ who/what removed this object. It will return one of the following: > **get** **spoiler**(): `boolean` +Whether the post's content is hidden until the user explicitly opens it. + ##### Returns `boolean` @@ -528,6 +617,8 @@ who/what removed this object. It will return one of the following: > **get** **stickied**(): `boolean` +Whether the post is presented before other posts in its subreddit. + ##### Returns `boolean` @@ -542,6 +633,8 @@ who/what removed this object. It will return one of the following: > **get** **subredditId**(): `` `t5_${string}` `` +The subreddit identifier where the post was created. + ##### Returns `` `t5_${string}` `` @@ -556,6 +649,8 @@ who/what removed this object. It will return one of the following: > **get** **subredditName**(): `string` +The owning subreddit's name without the leading `r/`. + ##### Returns `string` @@ -570,6 +665,11 @@ who/what removed this object. It will return one of the following: > **get** **thumbnail**(): `undefined` \| \{ `height`: `number`; `url`: `string`; `width`: `number`; \} +The post's preview thumbnail URL and dimensions in pixels. + +`undefined` means no thumbnail is available or the source field contains a +placeholder such as `"self"` or `"nsfw"`. + ##### Returns `undefined` \| \{ `height`: `number`; `url`: `string`; `width`: `number`; \} @@ -584,6 +684,8 @@ who/what removed this object. It will return one of the following: > **get** **title**(): `string` +The title displayed for the post. + ##### Returns `string` @@ -598,6 +700,17 @@ who/what removed this object. It will return one of the following: > **get** **url**(): `string` +The post URL. + +This is the submitted URL for a link post or the full-size media URL for an +image or video post. Use [permalink](#permalink) for the relative path. + +##### Example + +```ts +"https://www.reddit.com/r/wallstreetbets/comments/abc123/post/" +``` + ##### Returns `string` @@ -612,6 +725,8 @@ who/what removed this object. It will return one of the following: > **get** **userReportReasons**(): `string`[] +User report reasons, or an empty array when none are available. + ##### Returns `string`[] @@ -624,6 +739,8 @@ who/what removed this object. It will return one of the following: > **addComment**(`opts`): `Promise`\<[`Comment`](Comment.md)\> +Creates a top-level comment on the post. + #### Parameters ##### opts @@ -642,19 +759,13 @@ who/what removed this object. It will return one of the following: > **addRemovalNote**(`opts`): `Promise`\<`void`\> -Add a mod note for why the post was removed +Adds a moderator note explaining why the post was removed. #### Parameters ##### opts -###### modNote? - -`string` - -###### reasonId - -`string` +`Readonly`\<`Omit`\<[`AddRemovalNoteOptions`](../type-aliases/AddRemovalNoteOptions.md), `"itemIds"`\>\> #### Returns @@ -668,6 +779,8 @@ Add a mod note for why the post was removed > **approve**(): `Promise`\<`void`\> +Approves the post and updates this instance's moderation state. + #### Returns `Promise`\<`void`\> @@ -680,6 +793,8 @@ Add a mod note for why the post was removed > **crosspost**(`opts`): `Promise`\<`Post`\> +Creates a crosspost of this post in another subreddit. + #### Parameters ##### opts @@ -698,6 +813,8 @@ Add a mod note for why the post was removed > **delete**(): `Promise`\<`void`\> +Deletes the post as the app account. + #### Returns `Promise`\<`void`\> @@ -710,6 +827,8 @@ Add a mod note for why the post was removed > **distinguish**(): `Promise`\<`void`\> +Distinguishes the post as a moderator and updates this instance. + #### Returns `Promise`\<`void`\> @@ -722,6 +841,8 @@ Add a mod note for why the post was removed > **distinguishAsAdmin**(): `Promise`\<`void`\> +Distinguishes the post as an administrator and updates this instance. + #### Returns `Promise`\<`void`\> @@ -734,6 +855,9 @@ Add a mod note for why the post was removed > **edit**(`opts`): `Promise`\<`void`\> +Replaces the post body as the app account, then updates the cached body and +edited state from the response. + #### Parameters ##### opts @@ -763,14 +887,10 @@ Filters a post. When a post is filtered, it is added to the ModQueue for review, `FilterOptions` -The options for this filter action. - #### Returns `Promise`\<`void`\> -A Promise that resolves if the post was filtered successfully. - *** @@ -779,6 +899,8 @@ A Promise that resolves if the post was filtered successfully. > **getAuthor**(): `Promise`\<`undefined` \| [`User`](User.md)\> +Fetches the creator's account, or `undefined` if it is unavailable. + #### Returns `Promise`\<`undefined` \| [`User`](User.md)\> @@ -825,6 +947,8 @@ Get the custom styles for a custom post. > **getDuplicates**(`opts`): [`Listing`](Listing.md)\<`Post`\> +A listing of other posts that reference the same URL. + #### Parameters ##### opts @@ -835,6 +959,12 @@ Get the custom styles for a custom post. [`Listing`](Listing.md)\<`Post`\> +#### Example + +```ts +const duplicates = await post.getDuplicates().get(25); +``` + *** @@ -871,7 +1001,7 @@ const enrichedThumbnail = await post.getEnrichedThumbnail(); > **getPostData**(): `Promise`\<`undefined` \| `JsonObject`\> -Get the postData for the custom post. +Get the post data for the custom post. #### Returns @@ -892,6 +1022,8 @@ const postData = await post.getPostData(); > **hide**(): `Promise`\<`void`\> +Hides the post from the app account and updates this instance. + #### Returns `Promise`\<`void`\> @@ -904,6 +1036,8 @@ const postData = await post.getPostData(); > **ignoreReports**(): `Promise`\<`void`\> +Ignores reports and updates this instance's report-ignore state. + #### Returns `Promise`\<`void`\> @@ -916,6 +1050,8 @@ const postData = await post.getPostData(); > **isApproved**(): `boolean` +The post's approval state. + #### Returns `boolean` @@ -928,6 +1064,8 @@ const postData = await post.getPostData(); > **isArchived**(): `boolean` +The post's archived state. + #### Returns `boolean` @@ -940,6 +1078,8 @@ const postData = await post.getPostData(); > **isDistinguishedBy**(): `undefined` \| `string` +The post's distinction category. + #### Returns `undefined` \| `string` @@ -952,6 +1092,8 @@ const postData = await post.getPostData(); > **isEdited**(): `boolean` +The post's edited state. + #### Returns `boolean` @@ -964,6 +1106,8 @@ const postData = await post.getPostData(); > **isHidden**(): `boolean` +The post's hidden state. + #### Returns `boolean` @@ -976,6 +1120,8 @@ const postData = await post.getPostData(); > **isIgnoringReports**(): `boolean` +The post's report-ignore state. + #### Returns `boolean` @@ -988,6 +1134,8 @@ const postData = await post.getPostData(); > **isLocked**(): `boolean` +The post's locked state. + #### Returns `boolean` @@ -1000,6 +1148,8 @@ const postData = await post.getPostData(); > **isNsfw**(): `boolean` +The post's NSFW state. + #### Returns `boolean` @@ -1012,6 +1162,8 @@ const postData = await post.getPostData(); > **isQuarantined**(): `boolean` +The post's quarantine state. + #### Returns `boolean` @@ -1024,6 +1176,8 @@ const postData = await post.getPostData(); > **isRemoved**(): `boolean` +The post's removal state. + #### Returns `boolean` @@ -1036,6 +1190,8 @@ const postData = await post.getPostData(); > **isSpam**(): `boolean` +The post's spam state. + #### Returns `boolean` @@ -1048,6 +1204,8 @@ const postData = await post.getPostData(); > **isSpoiler**(): `boolean` +The post's spoiler state. + #### Returns `boolean` @@ -1060,6 +1218,8 @@ const postData = await post.getPostData(); > **isStickied**(): `boolean` +The post's stickied state. + #### Returns `boolean` @@ -1072,6 +1232,8 @@ const postData = await post.getPostData(); > **lock**(): `Promise`\<`void`\> +Disables new comments and updates this instance's locked state. + #### Returns `Promise`\<`void`\> @@ -1084,6 +1246,8 @@ const postData = await post.getPostData(); > **markAsNsfw**(): `Promise`\<`void`\> +Marks the post as NSFW and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1096,6 +1260,8 @@ const postData = await post.getPostData(); > **markAsSpoiler**(): `Promise`\<`void`\> +Marks the post as a spoiler and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1108,7 +1274,10 @@ const postData = await post.getPostData(); > **mergePostData**(`postData`): `Promise`\<`void`\> -Merge the postData on a custom post with the postData specified in the input. This performs a shallow merge. +Shallow-merge `postData` with any existing post data. + +Existing top-level properties are preserved unless the input replaces +them. Nested objects are replaced rather than deeply merged. #### Parameters @@ -1116,22 +1285,21 @@ Merge the postData on a custom post with the postData specified in the input. Th `JsonObject` -Represents the postData to be merged with the existing postData. - #### Returns `Promise`\<`void`\> #### Throws -Throws an error if the postData could not be merged. +If the post data could not be updated. #### Example ```ts const post = await reddit.getPostById(context.postId); -// Existing postData: { currentScore: 55, settings: { theme: 'dark', fontSize: 12 } } +// Existing data: +// { currentScore: 55, settings: { theme: 'dark', fontSize: 12 } } await post.mergePostData({ settings: { fontSize: 14 } }); // Result: { currentScore: 55, settings: { fontSize: 14 } } @@ -1145,12 +1313,16 @@ await post.mergePostData({ settings: { fontSize: 14 } }); > **remove**(`isSpam`): `Promise`\<`void`\> +Removes the post and updates this instance's moderation state. + #### Parameters ##### isSpam `boolean` = `false` +Whether to classify the removed post as spam. + #### Returns `Promise`\<`void`\> @@ -1165,15 +1337,15 @@ await post.mergePostData({ settings: { fontSize: 14 } }); **`Experimental`** -Set the custom styles for a custom post. +Updates a custom post's styles. + +Unspecified properties retain their existing values. Passing `undefined` +removes all custom styles. #### Parameters ##### styles -The styles to set for the post. If a value isn't specified, its previous value - will be preserved. If `undefined` is passed, all custom styles will be removed. - `undefined` | `CustomPostStylesInput` #### Returns @@ -1188,8 +1360,7 @@ The styles to set for the post. If a value isn't specified, its previous value > **setPostData**(`postData`): `Promise`\<`void`\> -Set the postData for the custom post. This will replace the existing -postData with the postData specified in the input. +Replace the post data stored on a custom post. #### Parameters @@ -1229,7 +1400,7 @@ await post.setPostData({ > **setSuggestedCommentSort**(`suggestedSort`): `Promise`\<`void`\> -Set the suggested sort for comments on a Post. +Sets the suggested default sort for the post's comments. #### Parameters @@ -1243,13 +1414,13 @@ Set the suggested sort for comments on a Post. #### Throws -Throws an error if the suggested sort could not be set. +If the suggested sort is rejected. #### Example ```ts const post = await reddit.getPostById(context.postId); -await post.setSuggestedCommentSort("NEW"); +await post.setSuggestedCommentSort('NEW'); ``` *** @@ -1260,7 +1431,11 @@ await post.setSuggestedCommentSort("NEW"); > **setTextFallback**(`opts`): `Promise`\<`void`\> -Set a text fallback for the custom post. +Replaces the content shown when a custom post cannot be rendered. Eg, on +`old.reddit.com`. + +The fallback may be plain text, Markdown, or rich text. This instance's +body and edited state are updated from the response. #### Parameters @@ -1268,20 +1443,17 @@ Set a text fallback for the custom post. `Readonly`\<[`CustomPostTextFallbackOptions`](../type-aliases/CustomPostTextFallbackOptions.md)\> -A text or a richtext to render in a fallback - #### Returns `Promise`\<`void`\> #### Throws -Throws an error if the fallback could not be set. +If the fallback could not be updated. #### Example ```ts -// from a menu action, form, scheduler, trigger, custom post click event, etc const newTextFallback = { text: 'This is an updated text fallback' }; const post = await context.reddit.getPostById(context.postId); await post.setTextFallback(newTextFallback); @@ -1295,8 +1467,8 @@ await post.setTextFallback(newTextFallback); > **snoozeReports**(`reason`): `Promise`\<`void`\> -Snooze subsequent reports with the given reason from the same users for the next 7 days. -Only works for free-form reports. +Snoozes subsequent reports with the same reason from the same users for +seven days. This only works for free-form reports. #### Parameters @@ -1318,10 +1490,16 @@ The report reason to snooze. > **sticky**(`position`?): `Promise`\<`void`\> +Pins the post in a sticky slot. + #### Parameters ##### position? +The sticky slot. If omitted, the bottom-most available +slot is used. Use 1 or 2 for subreddit posts. 3 and 4 are reserved for +profile pins. + `1` | `2` | `3` | `4` #### Returns @@ -1336,6 +1514,8 @@ The report reason to snooze. > **toJSON**(): `Pick`\<`Post`, `"flair"` \| `"spoiler"` \| `"id"` \| `"subredditName"` \| `"body"` \| `"permalink"` \| `"title"` \| `"createdAt"` \| `"nsfw"` \| `"url"` \| `"authorId"` \| `"authorName"` \| `"subredditId"` \| `"bodyHtml"` \| `"thumbnail"` \| `"score"` \| `"numberOfComments"` \| `"numberOfReports"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"removedBy"` \| `"removedByCategory"` \| `"archived"` \| `"edited"` \| `"locked"` \| `"quarantined"` \| `"hidden"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"secureMedia"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"crosspostParentId"`\> +JSON representation of public fields. + #### Returns `Pick`\<`Post`, `"flair"` \| `"spoiler"` \| `"id"` \| `"subredditName"` \| `"body"` \| `"permalink"` \| `"title"` \| `"createdAt"` \| `"nsfw"` \| `"url"` \| `"authorId"` \| `"authorName"` \| `"subredditId"` \| `"bodyHtml"` \| `"thumbnail"` \| `"score"` \| `"numberOfComments"` \| `"numberOfReports"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"removedBy"` \| `"removedByCategory"` \| `"archived"` \| `"edited"` \| `"locked"` \| `"quarantined"` \| `"hidden"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"secureMedia"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"crosspostParentId"`\> @@ -1348,6 +1528,8 @@ The report reason to snooze. > **undistinguish**(): `Promise`\<`void`\> +Removes the post's distinction and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1360,6 +1542,8 @@ The report reason to snooze. > **unhide**(): `Promise`\<`void`\> +Unhides the post for the app account and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1372,6 +1556,8 @@ The report reason to snooze. > **unignoreReports**(): `Promise`\<`void`\> +Stops ignoring reports and updates this instance's cached state. + #### Returns `Promise`\<`void`\> @@ -1384,6 +1570,8 @@ The report reason to snooze. > **unlock**(): `Promise`\<`void`\> +Enables new comments and updates this instance's locked state. + #### Returns `Promise`\<`void`\> @@ -1396,6 +1584,8 @@ The report reason to snooze. > **unmarkAsNsfw**(): `Promise`\<`void`\> +Removes the NSFW designation and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1408,6 +1598,8 @@ The report reason to snooze. > **unmarkAsSpoiler**(): `Promise`\<`void`\> +Removes the spoiler designation and updates this instance. + #### Returns `Promise`\<`void`\> @@ -1420,8 +1612,8 @@ The report reason to snooze. > **unsnoozeReports**(`reason`): `Promise`\<`void`\> -Unsnooze reports with the given reason. -Only works for free-form reports. +Unsnoozes reports with the given reason. This only works for free-form +reports. #### Parameters @@ -1443,6 +1635,9 @@ The report reason to unsnooze. > **unsticky**(): `Promise`\<`void`\> +Unpins the post without updating this instance's cached [stickied](#stickied) +value. + #### Returns `Promise`\<`void`\> @@ -1455,7 +1650,7 @@ The report reason to unsnooze. > **updateCrowdControlLevel**(`level`): `Promise`\<`void`\> -Updates the crowd control level of the post to hide comments accordingly. +Sets which comments Crowd Control collapses on this post. #### Parameters @@ -1463,7 +1658,7 @@ Updates the crowd control level of the post to hide comments accordingly. [`CrowdControlLevel`](../type-aliases/CrowdControlLevel.md) -The crowd control level to set. See [CrowdControlLevel](../type-aliases/CrowdControlLevel.md) for more information. +See [CrowdControlLevel](../type-aliases/CrowdControlLevel.md) for the available levels. #### Returns diff --git a/docs/api/redditapi/models/classes/PostFlairSettings.md b/docs/api/redditapi/models/classes/PostFlairSettings.md index 1a745dcd..e3cf50b2 100644 --- a/docs/api/redditapi/models/classes/PostFlairSettings.md +++ b/docs/api/redditapi/models/classes/PostFlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/PostFlairWidget.md b/docs/api/redditapi/models/classes/PostFlairWidget.md index b3b5ca75..bff73864 100644 --- a/docs/api/redditapi/models/classes/PostFlairWidget.md +++ b/docs/api/redditapi/models/classes/PostFlairWidget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/PrivateMessage.md b/docs/api/redditapi/models/classes/PrivateMessage.md index 923b9c41..32c52031 100644 --- a/docs/api/redditapi/models/classes/PrivateMessage.md +++ b/docs/api/redditapi/models/classes/PrivateMessage.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Rule.md b/docs/api/redditapi/models/classes/Rule.md index 6d3db479..2aa23bf9 100644 --- a/docs/api/redditapi/models/classes/Rule.md +++ b/docs/api/redditapi/models/classes/Rule.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Subreddit.md b/docs/api/redditapi/models/classes/Subreddit.md index d95842ba..e84fc779 100644 --- a/docs/api/redditapi/models/classes/Subreddit.md +++ b/docs/api/redditapi/models/classes/Subreddit.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditBannedUser.md b/docs/api/redditapi/models/classes/SubredditBannedUser.md index 29381ee5..fa6fa088 100644 --- a/docs/api/redditapi/models/classes/SubredditBannedUser.md +++ b/docs/api/redditapi/models/classes/SubredditBannedUser.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditContributorUser.md b/docs/api/redditapi/models/classes/SubredditContributorUser.md index 37058949..293d8e59 100644 --- a/docs/api/redditapi/models/classes/SubredditContributorUser.md +++ b/docs/api/redditapi/models/classes/SubredditContributorUser.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditDescription.md b/docs/api/redditapi/models/classes/SubredditDescription.md index a3eddac5..82a9c8ba 100644 --- a/docs/api/redditapi/models/classes/SubredditDescription.md +++ b/docs/api/redditapi/models/classes/SubredditDescription.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditModeratorUser.md b/docs/api/redditapi/models/classes/SubredditModeratorUser.md index aec55ef8..73ef12ed 100644 --- a/docs/api/redditapi/models/classes/SubredditModeratorUser.md +++ b/docs/api/redditapi/models/classes/SubredditModeratorUser.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditMutedUser.md b/docs/api/redditapi/models/classes/SubredditMutedUser.md index 9a50dbe6..2aa18922 100644 --- a/docs/api/redditapi/models/classes/SubredditMutedUser.md +++ b/docs/api/redditapi/models/classes/SubredditMutedUser.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditRulesWidget.md b/docs/api/redditapi/models/classes/SubredditRulesWidget.md index 8c8de90a..6556a1ba 100644 --- a/docs/api/redditapi/models/classes/SubredditRulesWidget.md +++ b/docs/api/redditapi/models/classes/SubredditRulesWidget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditWikiBannedUser.md b/docs/api/redditapi/models/classes/SubredditWikiBannedUser.md index 419db350..b7eb82c6 100644 --- a/docs/api/redditapi/models/classes/SubredditWikiBannedUser.md +++ b/docs/api/redditapi/models/classes/SubredditWikiBannedUser.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditWikiContributorUser.md b/docs/api/redditapi/models/classes/SubredditWikiContributorUser.md index 3aa5d5d0..edafc276 100644 --- a/docs/api/redditapi/models/classes/SubredditWikiContributorUser.md +++ b/docs/api/redditapi/models/classes/SubredditWikiContributorUser.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditWikiSettings.md b/docs/api/redditapi/models/classes/SubredditWikiSettings.md index e0ef0d13..1e48c6b1 100644 --- a/docs/api/redditapi/models/classes/SubredditWikiSettings.md +++ b/docs/api/redditapi/models/classes/SubredditWikiSettings.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/TextAreaWidget.md b/docs/api/redditapi/models/classes/TextAreaWidget.md index 86b19a06..e66e5106 100644 --- a/docs/api/redditapi/models/classes/TextAreaWidget.md +++ b/docs/api/redditapi/models/classes/TextAreaWidget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/User.md b/docs/api/redditapi/models/classes/User.md index b9a79ba8..a6f0951c 100644 --- a/docs/api/redditapi/models/classes/User.md +++ b/docs/api/redditapi/models/classes/User.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Widget.md b/docs/api/redditapi/models/classes/Widget.md index cca79560..d2ef468c 100644 --- a/docs/api/redditapi/models/classes/Widget.md +++ b/docs/api/redditapi/models/classes/Widget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPage.md b/docs/api/redditapi/models/classes/WikiPage.md index 63c7bc09..c2d7ac21 100644 --- a/docs/api/redditapi/models/classes/WikiPage.md +++ b/docs/api/redditapi/models/classes/WikiPage.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPageRevision.md b/docs/api/redditapi/models/classes/WikiPageRevision.md index b76a3899..e1b6f22e 100644 --- a/docs/api/redditapi/models/classes/WikiPageRevision.md +++ b/docs/api/redditapi/models/classes/WikiPageRevision.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPageSettings.md b/docs/api/redditapi/models/classes/WikiPageSettings.md index d24fefb7..94b41d57 100644 --- a/docs/api/redditapi/models/classes/WikiPageSettings.md +++ b/docs/api/redditapi/models/classes/WikiPageSettings.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/AboutLocations.md b/docs/api/redditapi/models/enumerations/AboutLocations.md index 3dbf06c5..ae67a3f0 100644 --- a/docs/api/redditapi/models/enumerations/AboutLocations.md +++ b/docs/api/redditapi/models/enumerations/AboutLocations.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/FlairType.md b/docs/api/redditapi/models/enumerations/FlairType.md index 56a83357..2ae049d8 100644 --- a/docs/api/redditapi/models/enumerations/FlairType.md +++ b/docs/api/redditapi/models/enumerations/FlairType.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/ModMailActionType.md b/docs/api/redditapi/models/enumerations/ModMailActionType.md index 115c31f3..0fbae754 100644 --- a/docs/api/redditapi/models/enumerations/ModMailActionType.md +++ b/docs/api/redditapi/models/enumerations/ModMailActionType.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/ModMailConversationState.md b/docs/api/redditapi/models/enumerations/ModMailConversationState.md index 6ba8f452..21bacf6b 100644 --- a/docs/api/redditapi/models/enumerations/ModMailConversationState.md +++ b/docs/api/redditapi/models/enumerations/ModMailConversationState.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/SocialLinkType.md b/docs/api/redditapi/models/enumerations/SocialLinkType.md index 4f61c949..c91cd932 100644 --- a/docs/api/redditapi/models/enumerations/SocialLinkType.md +++ b/docs/api/redditapi/models/enumerations/SocialLinkType.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md b/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md index 55be96df..689afb7e 100644 --- a/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md +++ b/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getModerationLog.md b/docs/api/redditapi/models/functions/getModerationLog.md index 8dd1fc4d..5c452a2b 100644 --- a/docs/api/redditapi/models/functions/getModerationLog.md +++ b/docs/api/redditapi/models/functions/getModerationLog.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditInfoById.md b/docs/api/redditapi/models/functions/getSubredditInfoById.md index ab02c85c..f0fa07a7 100644 --- a/docs/api/redditapi/models/functions/getSubredditInfoById.md +++ b/docs/api/redditapi/models/functions/getSubredditInfoById.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditInfoByName.md b/docs/api/redditapi/models/functions/getSubredditInfoByName.md index 3e3c64da..c91a7e44 100644 --- a/docs/api/redditapi/models/functions/getSubredditInfoByName.md +++ b/docs/api/redditapi/models/functions/getSubredditInfoByName.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditLeaderboard.md b/docs/api/redditapi/models/functions/getSubredditLeaderboard.md index 715421a1..f3670efb 100644 --- a/docs/api/redditapi/models/functions/getSubredditLeaderboard.md +++ b/docs/api/redditapi/models/functions/getSubredditLeaderboard.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditStyles.md b/docs/api/redditapi/models/functions/getSubredditStyles.md index ecb58f78..32d22e92 100644 --- a/docs/api/redditapi/models/functions/getSubredditStyles.md +++ b/docs/api/redditapi/models/functions/getSubredditStyles.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getVaultByAddress.md b/docs/api/redditapi/models/functions/getVaultByAddress.md index ec6eefd2..0df2fe04 100644 --- a/docs/api/redditapi/models/functions/getVaultByAddress.md +++ b/docs/api/redditapi/models/functions/getVaultByAddress.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getVaultByUserId.md b/docs/api/redditapi/models/functions/getVaultByUserId.md index adb5fcae..e4f8f230 100644 --- a/docs/api/redditapi/models/functions/getVaultByUserId.md +++ b/docs/api/redditapi/models/functions/getVaultByUserId.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/interfaces/ModAction.md b/docs/api/redditapi/models/interfaces/ModAction.md index ba3b19fc..6fda581b 100644 --- a/docs/api/redditapi/models/interfaces/ModAction.md +++ b/docs/api/redditapi/models/interfaces/ModAction.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md b/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md index 6e599dfe..955bd39f 100644 --- a/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md +++ b/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md b/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md index e3d4adec..37d18e9b 100644 --- a/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md +++ b/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md @@ -1,7 +1,42 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** # Type Alias: AddRemovalNoteOptions -> **AddRemovalNoteOptions** = `Prettify`\<`PostRemovalNoteRequest`\> +> **AddRemovalNoteOptions** = `object` + +Options for adding a note that explains why posts or comments were removed. + +## Properties + + + +### itemIds + +> **itemIds**: `string`[] + +The IDs of the removed posts or comments. + +*** + + + +### modNote? + +> `optional` **modNote**: `string` + +The note explaining the removal. The maximum length is 100 characters. + +The plugin omits this field when it is `undefined` or an empty string. + +*** + + + +### reasonId + +> **reasonId**: `string` + +The removal reason identifier, or an empty string when no removal reason is +used. diff --git a/docs/api/redditapi/models/type-aliases/AddWidgetData.md b/docs/api/redditapi/models/type-aliases/AddWidgetData.md index 6bdf27a8..3c75febb 100644 --- a/docs/api/redditapi/models/type-aliases/AddWidgetData.md +++ b/docs/api/redditapi/models/type-aliases/AddWidgetData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md b/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md index b8c53fff..afcb3357 100644 --- a/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md +++ b/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md b/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md index ea4d694f..73278c15 100644 --- a/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BanUserOptions.md b/docs/api/redditapi/models/type-aliases/BanUserOptions.md index e24071e6..17a128a7 100644 --- a/docs/api/redditapi/models/type-aliases/BanUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/BanUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md b/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md index a3406705..4c767686 100644 --- a/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md +++ b/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BannerHeight.md b/docs/api/redditapi/models/type-aliases/BannerHeight.md index 9d599e4f..28eadc4e 100644 --- a/docs/api/redditapi/models/type-aliases/BannerHeight.md +++ b/docs/api/redditapi/models/type-aliases/BannerHeight.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md b/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md index f44af271..9158aa83 100644 --- a/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md +++ b/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentSort.md b/docs/api/redditapi/models/type-aliases/CommentSort.md index f73e0972..e04d2ff8 100644 --- a/docs/api/redditapi/models/type-aliases/CommentSort.md +++ b/docs/api/redditapi/models/type-aliases/CommentSort.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md b/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md index 2050e7d0..0beb273d 100644 --- a/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md +++ b/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md @@ -1,7 +1,41 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** # Type Alias: CommentSubmissionOptions > **CommentSubmissionOptions** = \{ `runAs`: `"USER"` \| `"APP"`; `text`: `string`; \} \| \{ `richtext`: `object` \| `RichTextBuilder`; `runAs`: `"USER"` \| `"APP"`; \} + +Options for submitting a comment body. + +## Type declaration + +\{ `runAs`: `"USER"` \| `"APP"`; `text`: `string`; \} + +### runAs? + +> `optional` **runAs**: `"USER"` \| `"APP"` + +The account used to create the comment. Defaults to the app account. +This option is ignored by [Comment.edit](../classes/Comment.md#edit). + +### text + +> **text**: `string` + +The comment body in Markdown. + +\{ `richtext`: `object` \| `RichTextBuilder`; `runAs`: `"USER"` \| `"APP"`; \} + +### richtext + +> **richtext**: `object` \| `RichTextBuilder` + +The comment body as rich text. + +### runAs? + +> `optional` **runAs**: `"USER"` \| `"APP"` + +The account used to create the comment. Defaults to the app account. +This option is ignored by [Comment.edit](../classes/Comment.md#edit). diff --git a/docs/api/redditapi/models/type-aliases/CommonFlair.md b/docs/api/redditapi/models/type-aliases/CommonFlair.md index 6a2d7e61..8ccca91b 100644 --- a/docs/api/redditapi/models/type-aliases/CommonFlair.md +++ b/docs/api/redditapi/models/type-aliases/CommonFlair.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md b/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md index 337d3835..ab54c080 100644 --- a/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -14,6 +14,8 @@ > `optional` **flairId**: `string` +The flair template to apply to the new post. + *** @@ -22,6 +24,8 @@ > `optional` **flairText**: `string` +The flair text to apply to the new post. + *** @@ -30,6 +34,8 @@ > `optional` **nsfw**: `boolean` +Whether to mark the new post as NSFW. + *** @@ -38,6 +44,8 @@ > `optional` **runAs**: `"USER"` \| `"APP"` +The account that creates the post. Defaults to the app account. + *** @@ -46,6 +54,8 @@ > `optional` **sendreplies**: `boolean` +Whether the author receives notifications for new comments. + *** @@ -54,6 +64,8 @@ > `optional` **spoiler**: `boolean` +Whether to mark the new post as a spoiler. + *** @@ -61,3 +73,5 @@ ### title > **title**: `string` + +The title of the new post. diff --git a/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md b/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md index b1a394aa..2bad9c5e 100644 --- a/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md +++ b/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationData.md b/docs/api/redditapi/models/type-aliases/ConversationData.md index f66c313e..2d2ec28d 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationData.md +++ b/docs/api/redditapi/models/type-aliases/ConversationData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationResponse.md b/docs/api/redditapi/models/type-aliases/ConversationResponse.md index 4539b1a9..e8c1da85 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationResponse.md +++ b/docs/api/redditapi/models/type-aliases/ConversationResponse.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md b/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md index f68bb446..f18c66dd 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md +++ b/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationUserData.md b/docs/api/redditapi/models/type-aliases/ConversationUserData.md index 33d74d41..50245ab5 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationUserData.md +++ b/docs/api/redditapi/models/type-aliases/ConversationUserData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md b/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md index bc16b3e7..6fc51d17 100644 --- a/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md b/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md index 8ee01662..5ea0022e 100644 --- a/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md @@ -1,7 +1,59 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** # Type Alias: CreateModNoteOptions -> **CreateModNoteOptions** = `Prettify`\<`PostNotesRequest` & `object`\> +> **CreateModNoteOptions** = `object` + +Options for adding a moderation note to a user. + +## Properties + + + +### label? + +> `optional` **label**: [`UserNoteLabel`](UserNoteLabel.md) + +A label that categorizes the moderation note. + +*** + + + +### note + +> **note**: `string` + +The text of the moderation note. The maximum length is 250 characters. + +*** + + + +### redditId? + +> `optional` **redditId**: `T1` \| `T3` + +The comment or post associated with the moderation note. + +*** + + + +### subreddit + +> **subreddit**: `string` + +The subreddit name without the leading `r/`. + +*** + + + +### user + +> **user**: `string` + +The username without the leading `u/`. diff --git a/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md b/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md index b02c5596..e3d8449f 100644 --- a/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md b/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md index e040b7f0..070f87ae 100644 --- a/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md b/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md index 6a14dfe9..7d63410a 100644 --- a/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CrosspostOptions.md b/docs/api/redditapi/models/type-aliases/CrosspostOptions.md index 58b41430..b6c20497 100644 --- a/docs/api/redditapi/models/type-aliases/CrosspostOptions.md +++ b/docs/api/redditapi/models/type-aliases/CrosspostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -6,6 +6,8 @@ > **CrosspostOptions** = [`CommonSubmitPostOptions`](CommonSubmitPostOptions.md) & `Required`\<[`SubredditOptions`](SubredditOptions.md)\> & `object` +Options for creating a crosspost. + ## Type declaration ### postId diff --git a/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md b/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md index 1938c8cd..7eb69cdf 100644 --- a/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md +++ b/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -6,8 +6,11 @@ > **CrowdControlLevel** = `"OFF"` \| `"LENIENT"` \| `"MEDIUM"` \| `"STRICT"` -Crowd control level for posts. Determines which comments should be collapsed due to crowd control. -OFF: Anyone with a Reddit account can comment freely. -LENIENT: Collapse comments from people who have negative karma in your community. -MEDIUM: Collapse comments from new Reddit users and people with negative karma in your community. -STRICT: Collapse comments from people who haven’t joined your community, new Reddit users, and people with negative karma in your community +Crowd Control threshold for comments on a post. Determines which comments +should be collapsed by default. + +OFF: Do not collapse or filter comments through Crowd Control. +LENIENT: Collapse or filter comments from accounts with negative community + karma. +MEDIUM: LENIENT but also applies to new accounts. +STRICT: MEDIUM but applies to accounts that have not joined the community. diff --git a/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md b/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md index 6e59faf5..a2fe3d6e 100644 --- a/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md +++ b/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md b/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md index 3dcdb238..47610e94 100644 --- a/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md +++ b/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -14,10 +14,13 @@ > **text**: `string` -May also include markdown. See https://www.reddit.com/r/reddit.com/wiki/markdown/ +The fallback content as plaintext or Markdown. See +https://www.reddit.com/r/reddit.com/wiki/markdown/. \{ `richtext`: [`CustomPostRichTextFallback`](CustomPostRichTextFallback.md); \} ### richtext > **richtext**: [`CustomPostRichTextFallback`](CustomPostRichTextFallback.md) + +The fallback content as richtext. diff --git a/docs/api/redditapi/models/type-aliases/CustomizationFlag.md b/docs/api/redditapi/models/type-aliases/CustomizationFlag.md index f6747175..93d65d8a 100644 --- a/docs/api/redditapi/models/type-aliases/CustomizationFlag.md +++ b/docs/api/redditapi/models/type-aliases/CustomizationFlag.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md b/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md index 6eb604fa..e1e23da4 100644 --- a/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md +++ b/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md @@ -1,7 +1,39 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** # Type Alias: DeleteNotesOptions -> **DeleteNotesOptions** = `Prettify`\<`DeleteNotesRequest`\> +> **DeleteNotesOptions** = `object` + +Options for deleting a moderation note. + +## Properties + + + +### noteId + +> **noteId**: `string` + +The unique moderation note identifier, including its `ModNote_` prefix. + +*** + + + +### subreddit + +> **subreddit**: `string` + +The subreddit name without the leading `r/`. + +*** + + + +### user + +> **user**: `string` + +The username without the leading `u/`. diff --git a/docs/api/redditapi/models/type-aliases/EditCommentOptions.md b/docs/api/redditapi/models/type-aliases/EditCommentOptions.md index 0be1521d..5b81e009 100644 --- a/docs/api/redditapi/models/type-aliases/EditCommentOptions.md +++ b/docs/api/redditapi/models/type-aliases/EditCommentOptions.md @@ -1,7 +1,9 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** # Type Alias: EditCommentOptions > **EditCommentOptions** = [`CommentSubmissionOptions`](CommentSubmissionOptions.md) + +Options for replacing a comment body. diff --git a/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md b/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md index 78f94b2d..68ed62c8 100644 --- a/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md +++ b/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md b/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md index e9219607..661a16ed 100644 --- a/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md +++ b/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -6,7 +6,7 @@ > **EnrichedThumbnail** = `object` -Contains data about a post's thumbnail. Also contains a blurred version if the thumbnail is NSFW. +Contains a post's thumbnail and, for NSFW content, its blurred version. ## Properties @@ -26,7 +26,7 @@ Attribution text for the thumbnail > **image**: `object` -The image used for the thumbnail. May have different resolution from Post.thumbnail +The thumbnail image. Its resolution can differ from [Post.thumbnail](../classes/Post.md#thumbnail). #### height diff --git a/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md b/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md index 13ffe104..d2c44ebd 100644 --- a/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md +++ b/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/FlairSettings.md b/docs/api/redditapi/models/type-aliases/FlairSettings.md index 3c500eaf..c0e569c6 100644 --- a/docs/api/redditapi/models/type-aliases/FlairSettings.md +++ b/docs/api/redditapi/models/type-aliases/FlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/FlairTextColor.md b/docs/api/redditapi/models/type-aliases/FlairTextColor.md index 52d1ccf3..bd496072 100644 --- a/docs/api/redditapi/models/type-aliases/FlairTextColor.md +++ b/docs/api/redditapi/models/type-aliases/FlairTextColor.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GalleryMedia.md b/docs/api/redditapi/models/type-aliases/GalleryMedia.md index c04bc125..873d5dd7 100644 --- a/docs/api/redditapi/models/type-aliases/GalleryMedia.md +++ b/docs/api/redditapi/models/type-aliases/GalleryMedia.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -24,7 +24,7 @@ Represents media that the post may contain. > **status**: [`GalleryMediaStatus`](GalleryMediaStatus.md) -Status of the media. Media that were successfully uplaoded will have GalleryMediaStatus.VALID status +The media processing status. Successful uploads have `VALID` status. *** diff --git a/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md b/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md index 6aa3ff76..09afebe9 100644 --- a/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md +++ b/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md index 6c87f487..3c75ddda 100644 --- a/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md b/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md index e0157d21..f9c018fd 100644 --- a/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md b/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md index 9dc16c8b..8b3a4ee6 100644 --- a/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationResponse.md b/docs/api/redditapi/models/type-aliases/GetConversationResponse.md index 4d67e46f..b671bf51 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationResponse.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md b/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md index daf899c3..8c76b912 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md b/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md index fe91840e..eccc05e5 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md b/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md index 0ecf5a69..a0b0e14a 100644 --- a/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -18,13 +18,13 @@ Only return duplicates that are crossposting this post. > **postId**: `T3` -Post ID with t3_ prefix (e.g. `t3_abc123`). The prefix is stripped internally. +The post identifier. ### show? > `optional` **show**: `string` -Adding the string "all" will show all results regardless of user preferences. +Use `"all"` to include results hidden by the account's preferences. ### sort? diff --git a/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md index 52bf0e8f..877facdf 100644 --- a/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md b/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md index 19f30206..b5d99258 100644 --- a/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md @@ -1,7 +1,62 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** # Type Alias: GetModNotesOptions -> **GetModNotesOptions** = `Prettify`\<`Pick`\<`GetNotesRequest`, `"subreddit"` \| `"user"`\> & `object` & `Pick`\<[`ListingFetchOptions`](ListingFetchOptions.md), `"limit"` \| `"before"`\>\> +> **GetModNotesOptions** = `object` + +Options for retrieving a user's moderation notes from a subreddit. + +## Properties + + + +### before? + +> `optional` **before**: `string` + +The pagination cursor before which results should be returned. + +*** + + + +### filter? + +> `optional` **filter**: [`ModNoteType`](ModNoteType.md) + +The type of moderation notes to return. Defaults to all types. + +*** + + + +### limit? + +> `optional` **limit**: `number` + +The maximum total number of moderation notes to return. + +Accepts at most 100 notes per request. Omit this option to allow the +listing to paginate beyond the first 100 notes. + +*** + + + +### subreddit + +> **subreddit**: `string` + +The subreddit name without the leading `r/`. + +*** + + + +### user + +> **user**: `string` + +The username without the leading `u/`. diff --git a/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md b/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md index 65191106..025fe607 100644 --- a/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md b/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md index 46a67fa4..2a40d2c1 100644 --- a/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md b/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md index d687fba2..f4bdb377 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetPostsOptions.md index 4bcfea7c..c34db174 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md b/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md index 2b905671..55c4f64d 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md b/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md index 765f933c..5443fdba 100644 --- a/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md index 231e02a2..df886081 100644 --- a/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md b/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md index d01b0f4b..bd9662d8 100644 --- a/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetSubscribedSubredditsForCurrentUserOptions.md b/docs/api/redditapi/models/type-aliases/GetSubscribedSubredditsForCurrentUserOptions.md index 09444ee7..d015f405 100644 --- a/docs/api/redditapi/models/type-aliases/GetSubscribedSubredditsForCurrentUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetSubscribedSubredditsForCurrentUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md index e600d575..f54847fb 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md index 8605b13d..846d9b58 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md b/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md index 8ace2723..d8b5ed69 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md b/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md index 0a1b76b2..a1d12877 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetWikiPageOptions.md b/docs/api/redditapi/models/type-aliases/GetWikiPageOptions.md index c1476582..dfb88783 100644 --- a/docs/api/redditapi/models/type-aliases/GetWikiPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ImagePosition.md b/docs/api/redditapi/models/type-aliases/ImagePosition.md index dbe581d0..82b9ba8e 100644 --- a/docs/api/redditapi/models/type-aliases/ImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/ImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md b/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md index c6de1599..f79f00b7 100644 --- a/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/LinkFlair.md b/docs/api/redditapi/models/type-aliases/LinkFlair.md index 4f887081..efb81a53 100644 --- a/docs/api/redditapi/models/type-aliases/LinkFlair.md +++ b/docs/api/redditapi/models/type-aliases/LinkFlair.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md b/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md index d74eee68..0cd6c4f5 100644 --- a/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md +++ b/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md b/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md index fdb2103e..ef7e8f40 100644 --- a/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md +++ b/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MenuPosition.md b/docs/api/redditapi/models/type-aliases/MenuPosition.md index 9a4bbf0f..fff66a54 100644 --- a/docs/api/redditapi/models/type-aliases/MenuPosition.md +++ b/docs/api/redditapi/models/type-aliases/MenuPosition.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MessageData.md b/docs/api/redditapi/models/type-aliases/MessageData.md index 96426018..c11e64ff 100644 --- a/docs/api/redditapi/models/type-aliases/MessageData.md +++ b/docs/api/redditapi/models/type-aliases/MessageData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionData.md b/docs/api/redditapi/models/type-aliases/ModActionData.md index 1d883b97..52f92141 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionData.md +++ b/docs/api/redditapi/models/type-aliases/ModActionData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionTarget.md b/docs/api/redditapi/models/type-aliases/ModActionTarget.md index 9783e42d..540b00fe 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionTarget.md +++ b/docs/api/redditapi/models/type-aliases/ModActionTarget.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionType.md b/docs/api/redditapi/models/type-aliases/ModActionType.md index bb1c42f3..9873c1d1 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionType.md +++ b/docs/api/redditapi/models/type-aliases/ModActionType.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModLogOptions.md b/docs/api/redditapi/models/type-aliases/ModLogOptions.md index 02e5a059..f001d755 100644 --- a/docs/api/redditapi/models/type-aliases/ModLogOptions.md +++ b/docs/api/redditapi/models/type-aliases/ModLogOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModNoteType.md b/docs/api/redditapi/models/type-aliases/ModNoteType.md index 59c5c94c..d6caa03a 100644 --- a/docs/api/redditapi/models/type-aliases/ModNoteType.md +++ b/docs/api/redditapi/models/type-aliases/ModNoteType.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModeratorPermission.md b/docs/api/redditapi/models/type-aliases/ModeratorPermission.md index b28f969a..57479eb2 100644 --- a/docs/api/redditapi/models/type-aliases/ModeratorPermission.md +++ b/docs/api/redditapi/models/type-aliases/ModeratorPermission.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModeratorReport.md b/docs/api/redditapi/models/type-aliases/ModeratorReport.md index 7bbde087..37fd3436 100644 --- a/docs/api/redditapi/models/type-aliases/ModeratorReport.md +++ b/docs/api/redditapi/models/type-aliases/ModeratorReport.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MoreObject.md b/docs/api/redditapi/models/type-aliases/MoreObject.md index 6c8f428e..6e7859e5 100644 --- a/docs/api/redditapi/models/type-aliases/MoreObject.md +++ b/docs/api/redditapi/models/type-aliases/MoreObject.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Oembed.md b/docs/api/redditapi/models/type-aliases/Oembed.md index 76e37377..a9ded707 100644 --- a/docs/api/redditapi/models/type-aliases/Oembed.md +++ b/docs/api/redditapi/models/type-aliases/Oembed.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -6,9 +6,9 @@ > **Oembed** = `object` -oEmbed is a format for allowing an embedded representation of a URL on third party sites. -The simple API allows a website to display embedded content (such as photos or videos) -when a user posts a link to that resource, without having to parse the resource directly. +oEmbed is a format for allowing an embedded representation of a URL on +third-party sites. The API lets a website display embedded content, such as +photos or videos, without parsing the resource directly. See: https://oembed.com/ ## Properties @@ -29,7 +29,13 @@ The name of the author/owner of the resource. E.g. "Reddit" > `optional` **authorUrl**: `string` -A URL for the author/owner of the resource. E.g. "https://www.youtube.com/@Reddit" +A URL for the resource's author or owner. + +#### Example + +```ts +"https://www.youtube.com/@Reddit" +``` *** @@ -39,7 +45,7 @@ A URL for the author/owner of the resource. E.g. "https://www.youtube.com/@Reddi > `optional` **height**: `number` -The width in pixels required to display the HTML. +The height in pixels required to display the HTML. *** @@ -49,7 +55,9 @@ The width in pixels required to display the HTML. > **html**: `string` -The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. +The HTML required to embed a video player. It should have no padding or +margins. Consider loading it in a separate-origin iframe to avoid XSS +vulnerabilities. *** @@ -119,7 +127,7 @@ A text title, describing the resource. > **type**: `string` -The resource type. Valid values, along with value-specific parameters, are described below. E.g. "video" +The resource type and its type-specific parameters, such as `"video"`. *** @@ -139,4 +147,4 @@ The oEmbed version number. This must be 1.0. > `optional` **width**: `number` -The height in pixels required to display the HTML. +The width in pixels required to display the HTML. diff --git a/docs/api/redditapi/models/type-aliases/Participant.md b/docs/api/redditapi/models/type-aliases/Participant.md index f98af573..eb8244be 100644 --- a/docs/api/redditapi/models/type-aliases/Participant.md +++ b/docs/api/redditapi/models/type-aliases/Participant.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PollData.md b/docs/api/redditapi/models/type-aliases/PollData.md index e3d3e2f9..c9d2d696 100644 --- a/docs/api/redditapi/models/type-aliases/PollData.md +++ b/docs/api/redditapi/models/type-aliases/PollData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -26,7 +26,7 @@ Options in the poll. > **totalVoteCount**: `number` -Total number of votes cast in the poll. Aggregated across all PollOption objects. +Total votes cast across all of the poll's options. *** diff --git a/docs/api/redditapi/models/type-aliases/PollOption.md b/docs/api/redditapi/models/type-aliases/PollOption.md index 801ff170..0887dd4b 100644 --- a/docs/api/redditapi/models/type-aliases/PollOption.md +++ b/docs/api/redditapi/models/type-aliases/PollOption.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md b/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md index 477c4c57..f3933218 100644 --- a/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostCapabilities.md b/docs/api/redditapi/models/type-aliases/PostCapabilities.md index 62ab93b3..f9e48a89 100644 --- a/docs/api/redditapi/models/type-aliases/PostCapabilities.md +++ b/docs/api/redditapi/models/type-aliases/PostCapabilities.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md b/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md index 412a54f8..37953180 100644 --- a/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md +++ b/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostTextOptions.md b/docs/api/redditapi/models/type-aliases/PostTextOptions.md index 6f61bc8a..74ad4b06 100644 --- a/docs/api/redditapi/models/type-aliases/PostTextOptions.md +++ b/docs/api/redditapi/models/type-aliases/PostTextOptions.md @@ -1,7 +1,27 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** # Type Alias: PostTextOptions > **PostTextOptions** = \{ `text`: `string`; \} \| \{ `richtext`: `object` \| `RichTextBuilder`; \} + +Options for replacing a post body. + +## Type declaration + +\{ `text`: `string`; \} + +### text + +> **text**: `string` + +The post body in Markdown. + +\{ `richtext`: `object` \| `RichTextBuilder`; \} + +### richtext + +> **richtext**: `object` \| `RichTextBuilder` + +The post body as rich text. diff --git a/docs/api/redditapi/models/type-aliases/PostType.md b/docs/api/redditapi/models/type-aliases/PostType.md index 25d67c70..ea5a21de 100644 --- a/docs/api/redditapi/models/type-aliases/PostType.md +++ b/docs/api/redditapi/models/type-aliases/PostType.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RedditVideo.md b/docs/api/redditapi/models/type-aliases/RedditVideo.md index db1cb09f..c38c5b01 100644 --- a/docs/api/redditapi/models/type-aliases/RedditVideo.md +++ b/docs/api/redditapi/models/type-aliases/RedditVideo.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -26,7 +26,13 @@ The bitrate of the video in kilobits per second. E.g. 450 > `optional` **dashUrl**: `string` -The URL to the DASH playlist file. E.g. "https://v.redd.it/abc123/DASHPlaylist.mpd" +The URL to the DASH playlist file. + +#### Example + +```ts +"https://v.redd.it/abc123/DASHPlaylist.mpd" +``` *** @@ -46,7 +52,13 @@ The duration of the video in seconds. E.g. 30 > `optional` **fallbackUrl**: `string` -The direct URL to the video. E.g. "https://v.redd.it/abc123/DASH_1080.mp4?source=fallback" +The direct URL to the video. + +#### Example + +```ts +"https://v.redd.it/abc123/DASH_1080.mp4?source=fallback" +``` *** @@ -66,7 +78,13 @@ The height of the video in pixels. E.g. 1080 > `optional` **hlsUrl**: `string` -The URL to the HLS playlist file. E.g. "https://v.redd.it/abc123/HLSPlaylist.m3u8" +The URL to the HLS playlist file. + +#### Example + +```ts +"https://v.redd.it/abc123/HLSPlaylist.m3u8" +``` *** @@ -86,7 +104,13 @@ If `true`, the video is a GIF > `optional` **scrubberMediaUrl**: `string` -The URL to the scrubber media file. E.g. "https://v.redd.it/abc123/DASH_96.mp4" +The URL to the scrubber media file. + +#### Example + +```ts +"https://v.redd.it/abc123/DASH_96.mp4" +``` *** diff --git a/docs/api/redditapi/models/type-aliases/RelationshipType.md b/docs/api/redditapi/models/type-aliases/RelationshipType.md index b4a09f66..c788870c 100644 --- a/docs/api/redditapi/models/type-aliases/RelationshipType.md +++ b/docs/api/redditapi/models/type-aliases/RelationshipType.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RemovalReason.md b/docs/api/redditapi/models/type-aliases/RemovalReason.md index 5a9e6dbd..318a5344 100644 --- a/docs/api/redditapi/models/type-aliases/RemovalReason.md +++ b/docs/api/redditapi/models/type-aliases/RemovalReason.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md b/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md index b15bf8ed..5f2dc889 100644 --- a/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md +++ b/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md b/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md index f15c7936..675778a9 100644 --- a/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md +++ b/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md @@ -1,7 +1,9 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** # Type Alias: ReplyToCommentOptions > **ReplyToCommentOptions** = [`CommentSubmissionOptions`](CommentSubmissionOptions.md) + +Options for replying to a comment. diff --git a/docs/api/redditapi/models/type-aliases/SearchPostsOptions.md b/docs/api/redditapi/models/type-aliases/SearchPostsOptions.md index 5a85a1c7..1c108b68 100644 --- a/docs/api/redditapi/models/type-aliases/SearchPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/SearchPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** @@ -24,7 +24,8 @@ How to sort the search results. Defaults to `relevance`. > `optional` **subredditName**: `string` -The subreddit to search without 'r/' prefix. If specified, will restrict the search to posts in this subreddit +The subreddit to search without the `r/` prefix. If specified, restricts +the search to posts in this subreddit. ### timeframe? diff --git a/docs/api/redditapi/models/type-aliases/SecureMedia.md b/docs/api/redditapi/models/type-aliases/SecureMedia.md index 5c226a0d..9a79b6a1 100644 --- a/docs/api/redditapi/models/type-aliases/SecureMedia.md +++ b/docs/api/redditapi/models/type-aliases/SecureMedia.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md b/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md index 0834c65e..5dab3b53 100644 --- a/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md +++ b/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md b/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md index 5f437efc..b6ae4232 100644 --- a/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md +++ b/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetFlairOptions.md index e7252f2b..da932ac8 100644 --- a/docs/api/redditapi/models/type-aliases/SetFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md index 66453f82..fc800c66 100644 --- a/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md b/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md index 4ce009b1..0e906331 100644 --- a/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md +++ b/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md index 967a6421..c7870a33 100644 --- a/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md index 149aed2a..76cefc6f 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md b/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md index e39bcd71..a30f5920 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md b/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md index 43208365..cb841c89 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md index 5091d736..201da314 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md index f854cfbc..56faa9f0 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditData.md b/docs/api/redditapi/models/type-aliases/SubredditData.md index 4984b5cc..74b78ae8 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditData.md +++ b/docs/api/redditapi/models/type-aliases/SubredditData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditInfo.md b/docs/api/redditapi/models/type-aliases/SubredditInfo.md index 08f630f2..02df1185 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditInfo.md +++ b/docs/api/redditapi/models/type-aliases/SubredditInfo.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md index d5483176..12534a90 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md index f15ac85f..46ec7314 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md index 7d261844..51421694 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditOptions.md b/docs/api/redditapi/models/type-aliases/SubredditOptions.md index 2b1c250f..eac51586 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditSettings.md b/docs/api/redditapi/models/type-aliases/SubredditSettings.md index 2576e35e..bcfe42fb 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditSettings.md +++ b/docs/api/redditapi/models/type-aliases/SubredditSettings.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md b/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md index 68febb39..00ffbaaa 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditStyles.md b/docs/api/redditapi/models/type-aliases/SubredditStyles.md index e4d66d4d..eb8d3acf 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditStyles.md +++ b/docs/api/redditapi/models/type-aliases/SubredditStyles.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditType.md b/docs/api/redditapi/models/type-aliases/SubredditType.md index 7403c1f5..3757c43a 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditType.md +++ b/docs/api/redditapi/models/type-aliases/SubredditType.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Trophy.md b/docs/api/redditapi/models/type-aliases/Trophy.md index 1a6840b3..837d408f 100644 --- a/docs/api/redditapi/models/type-aliases/Trophy.md +++ b/docs/api/redditapi/models/type-aliases/Trophy.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md b/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md index 3d551a4e..a089da54 100644 --- a/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md +++ b/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md b/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md index 0cdf0908..b51ff893 100644 --- a/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md b/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md index bdf67fc0..c2172ac4 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md b/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md index 5cf0cd35..a9729f1b 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md +++ b/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md b/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md index c98ed65e..687f183e 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserFlair.md b/docs/api/redditapi/models/type-aliases/UserFlair.md index 73033748..46475c7b 100644 --- a/docs/api/redditapi/models/type-aliases/UserFlair.md +++ b/docs/api/redditapi/models/type-aliases/UserFlair.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md b/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md index 5cde7a56..3449d6c3 100644 --- a/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserNote.md b/docs/api/redditapi/models/type-aliases/UserNote.md index fa2dcf12..77554d38 100644 --- a/docs/api/redditapi/models/type-aliases/UserNote.md +++ b/docs/api/redditapi/models/type-aliases/UserNote.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserNoteLabel.md b/docs/api/redditapi/models/type-aliases/UserNoteLabel.md index 83c63402..5671916d 100644 --- a/docs/api/redditapi/models/type-aliases/UserNoteLabel.md +++ b/docs/api/redditapi/models/type-aliases/UserNoteLabel.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserSocialLink.md b/docs/api/redditapi/models/type-aliases/UserSocialLink.md index 5361273d..77155a88 100644 --- a/docs/api/redditapi/models/type-aliases/UserSocialLink.md +++ b/docs/api/redditapi/models/type-aliases/UserSocialLink.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Vault.md b/docs/api/redditapi/models/type-aliases/Vault.md index bf34c674..6c56f6b5 100644 --- a/docs/api/redditapi/models/type-aliases/Vault.md +++ b/docs/api/redditapi/models/type-aliases/Vault.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Visibility.md b/docs/api/redditapi/models/type-aliases/Visibility.md index 1747947f..80120828 100644 --- a/docs/api/redditapi/models/type-aliases/Visibility.md +++ b/docs/api/redditapi/models/type-aliases/Visibility.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WikiEditMode.md b/docs/api/redditapi/models/type-aliases/WikiEditMode.md index 3b1fd3c4..42006ed4 100644 --- a/docs/api/redditapi/models/type-aliases/WikiEditMode.md +++ b/docs/api/redditapi/models/type-aliases/WikiEditMode.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md b/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md index bb519df4..1aad44d4 100644 --- a/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md +++ b/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WikiVersion.md b/docs/api/redditapi/models/type-aliases/WikiVersion.md index 2aa44a42..78ae23fe 100644 --- a/docs/api/redditapi/models/type-aliases/WikiVersion.md +++ b/docs/api/redditapi/models/type-aliases/WikiVersion.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WikiVersionOptions.md b/docs/api/redditapi/models/type-aliases/WikiVersionOptions.md index e9527ebc..38a8b5c4 100644 --- a/docs/api/redditapi/models/type-aliases/WikiVersionOptions.md +++ b/docs/api/redditapi/models/type-aliases/WikiVersionOptions.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WithUserData.md b/docs/api/redditapi/models/type-aliases/WithUserData.md index db517e90..37245a2c 100644 --- a/docs/api/redditapi/models/type-aliases/WithUserData.md +++ b/docs/api/redditapi/models/type-aliases/WithUserData.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/variables/GalleryMediaStatus.md b/docs/api/redditapi/models/variables/GalleryMediaStatus.md index 6c648fb5..7cf11296 100644 --- a/docs/api/redditapi/models/variables/GalleryMediaStatus.md +++ b/docs/api/redditapi/models/variables/GalleryMediaStatus.md @@ -1,4 +1,4 @@ -[**@devvit/reddit v0.14.1-dev**](../../README.md) +[**@devvit/reddit v0.14.3-dev**](../../README.md) *** diff --git a/versioned_docs/version-0.14/api/public-api/README.md b/versioned_docs/version-0.14/api/public-api/README.md index 816308d0..1db5dc1c 100644 --- a/versioned_docs/version-0.14/api/public-api/README.md +++ b/versioned_docs/version-0.14/api/public-api/README.md @@ -148,7 +148,6 @@ - [~~Data~~](type-aliases/Data.md) - [DeleteNotesOptions](type-aliases/DeleteNotesOptions.md) - [DevvitDebug](type-aliases/DevvitDebug.md) -- [Dispatch](type-aliases/Dispatch.md) - [Document](type-aliases/Document.md) - [DocumentNode](type-aliases/DocumentNode.md) - [EditCommentOptions](type-aliases/EditCommentOptions.md) @@ -324,6 +323,7 @@ - [ScheduledJobOptions](type-aliases/ScheduledJobOptions.md) - [ScheduledJobType](type-aliases/ScheduledJobType.md) - [Scheduler](type-aliases/Scheduler.md) +- [SearchPostsOptions](type-aliases/SearchPostsOptions.md) - [SecureMedia](type-aliases/SecureMedia.md) - [SelectField](type-aliases/SelectField.md) - [SendPrivateMessageAsSubredditOptions](type-aliases/SendPrivateMessageAsSubredditOptions.md) diff --git a/versioned_docs/version-0.14/api/public-api/classes/RedditAPIClient.md b/versioned_docs/version-0.14/api/public-api/classes/RedditAPIClient.md index 4adb7100..60aff6bf 100644 --- a/versioned_docs/version-0.14/api/public-api/classes/RedditAPIClient.md +++ b/versioned_docs/version-0.14/api/public-api/classes/RedditAPIClient.md @@ -3492,6 +3492,46 @@ The name of the subreddit to revoke the invite for. e.g. 'memes' *** + + +### searchPosts() + +> **searchPosts**(`options`): [`Listing`](Listing.md)\<[`Post`](Post.md)\> + +Search for posts in a subreddit. + +#### Parameters + +##### options + +[`SearchPostsOptions`](../type-aliases/SearchPostsOptions.md) + +Options for the search + +#### Returns + +[`Listing`](Listing.md)\<[`Post`](Post.md)\> + +A Listing of Post objects. + +#### Example + +```ts +const posts = await reddit.searchPosts({ + query: 'developer platform', + subredditName: 'devvit', + sort: 'new', + timeframe: 'month', + limit: 100, +}).all(); +``` + +#### Inherited from + +[`RedditClient`](RedditClient.md).[`searchPosts`](RedditClient.md#searchposts) + +*** + ### sendPrivateMessage() diff --git a/versioned_docs/version-0.14/api/public-api/classes/RedditClient.md b/versioned_docs/version-0.14/api/public-api/classes/RedditClient.md index 8381abe7..78b792bd 100644 --- a/versioned_docs/version-0.14/api/public-api/classes/RedditClient.md +++ b/versioned_docs/version-0.14/api/public-api/classes/RedditClient.md @@ -3044,6 +3044,42 @@ The name of the subreddit to revoke the invite for. e.g. 'memes' *** + + +### searchPosts() + +> **searchPosts**(`options`): [`Listing`](Listing.md)\<[`Post`](Post.md)\> + +Search for posts in a subreddit. + +#### Parameters + +##### options + +[`SearchPostsOptions`](../type-aliases/SearchPostsOptions.md) + +Options for the search + +#### Returns + +[`Listing`](Listing.md)\<[`Post`](Post.md)\> + +A Listing of Post objects. + +#### Example + +```ts +const posts = await reddit.searchPosts({ + query: 'developer platform', + subredditName: 'devvit', + sort: 'new', + timeframe: 'month', + limit: 100, +}).all(); +``` + +*** + ### sendPrivateMessage() diff --git a/versioned_docs/version-0.14/api/public-api/classes/Subreddit.md b/versioned_docs/version-0.14/api/public-api/classes/Subreddit.md index d9ef1ae3..7ebbd3dc 100644 --- a/versioned_docs/version-0.14/api/public-api/classes/Subreddit.md +++ b/versioned_docs/version-0.14/api/public-api/classes/Subreddit.md @@ -1338,6 +1338,26 @@ const userFlairList = response.users *** + + +### searchPosts() + +> **searchPosts**(`options`): [`Listing`](Listing.md)\<[`Post`](Post.md)\> + +Search for posts in this subreddit. + +#### Parameters + +##### options + +`Omit`\<[`SearchPostsOptions`](../type-aliases/SearchPostsOptions.md), `"subredditName"`\> + +#### Returns + +[`Listing`](Listing.md)\<[`Post`](Post.md)\> + +*** + ### setModeratorPermissions() diff --git a/versioned_docs/version-0.14/api/public-api/type-aliases/Dispatch.md b/versioned_docs/version-0.14/api/public-api/type-aliases/Dispatch.md deleted file mode 100644 index ccf5bc0f..00000000 --- a/versioned_docs/version-0.14/api/public-api/type-aliases/Dispatch.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@devvit/public-api v0.14.1-dev**](../README.md) - -*** - -# Type Alias: Dispatch()\ - -> **Dispatch**\<`A`\> = (`value`) => `void` - -## Type Parameters - -### A - -`A` - -## Parameters - -### value - -`A` - -## Returns - -`void` diff --git a/versioned_docs/version-0.14/api/public-api/type-aliases/SearchPostsOptions.md b/versioned_docs/version-0.14/api/public-api/type-aliases/SearchPostsOptions.md new file mode 100644 index 00000000..1bd09983 --- /dev/null +++ b/versioned_docs/version-0.14/api/public-api/type-aliases/SearchPostsOptions.md @@ -0,0 +1,33 @@ +[**@devvit/public-api v0.14.1-dev**](../README.md) + +*** + +# Type Alias: SearchPostsOptions + +> **SearchPostsOptions** = [`ListingFetchOptions`](ListingFetchOptions.md) & `object` + +## Type declaration + +### query + +> **query**: `string` + +Search query. + +### sort? + +> `optional` **sort**: `"relevance"` \| `"hot"` \| `"top"` \| `"new"` \| `"comments"` + +How to sort the search results. Defaults to `relevance`. + +### subredditName? + +> `optional` **subredditName**: `string` + +The subreddit to search without 'r/' prefix. If specified, will restrict the search to posts in this subreddit + +### timeframe? + +> `optional` **timeframe**: `"hour"` \| `"day"` \| `"week"` \| `"month"` \| `"year"` \| `"all"` + +Limit search results to a timeframe. Defaults to `all`. diff --git a/versioned_docs/version-0.14/api/redditapi/RedditClient/classes/RedditClient.md b/versioned_docs/version-0.14/api/redditapi/RedditClient/classes/RedditClient.md index 041d4f22..47a679d8 100644 --- a/versioned_docs/version-0.14/api/redditapi/RedditClient/classes/RedditClient.md +++ b/versioned_docs/version-0.14/api/redditapi/RedditClient/classes/RedditClient.md @@ -3040,6 +3040,42 @@ The name of the subreddit to revoke the invite for. e.g. 'memes' *** + + +### searchPosts() + +> **searchPosts**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md)\> + +Search for posts in a subreddit. + +#### Parameters + +##### options + +[`SearchPostsOptions`](../../models/type-aliases/SearchPostsOptions.md) + +Options for the search + +#### Returns + +[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md)\> + +A Listing of Post objects. + +#### Example + +```ts +const posts = await reddit.searchPosts({ + query: 'developer platform', + subredditName: 'devvit', + sort: 'new', + timeframe: 'month', + limit: 100, +}).all(); +``` + +*** + ### sendPrivateMessage() diff --git a/versioned_docs/version-0.14/api/redditapi/models/README.md b/versioned_docs/version-0.14/api/redditapi/models/README.md index 95f82bef..b5a83862 100644 --- a/versioned_docs/version-0.14/api/redditapi/models/README.md +++ b/versioned_docs/version-0.14/api/redditapi/models/README.md @@ -144,6 +144,7 @@ - [RemovalReason](type-aliases/RemovalReason.md) - [RemoveRelationshipOptions](type-aliases/RemoveRelationshipOptions.md) - [ReplyToCommentOptions](type-aliases/ReplyToCommentOptions.md) +- [SearchPostsOptions](type-aliases/SearchPostsOptions.md) - [SecureMedia](type-aliases/SecureMedia.md) - [SendPrivateMessageAsSubredditOptions](type-aliases/SendPrivateMessageAsSubredditOptions.md) - [SendPrivateMessageOptions](type-aliases/SendPrivateMessageOptions.md) diff --git a/versioned_docs/version-0.14/api/redditapi/models/classes/Subreddit.md b/versioned_docs/version-0.14/api/redditapi/models/classes/Subreddit.md index e60a8af2..d95842ba 100644 --- a/versioned_docs/version-0.14/api/redditapi/models/classes/Subreddit.md +++ b/versioned_docs/version-0.14/api/redditapi/models/classes/Subreddit.md @@ -1326,6 +1326,26 @@ const userFlairList = response.users *** + + +### searchPosts() + +> **searchPosts**(`options`): [`Listing`](Listing.md)\<[`Post`](Post.md)\> + +Search for posts in this subreddit. + +#### Parameters + +##### options + +`Omit`\<[`SearchPostsOptions`](../type-aliases/SearchPostsOptions.md), `"subredditName"`\> + +#### Returns + +[`Listing`](Listing.md)\<[`Post`](Post.md)\> + +*** + ### setModeratorPermissions() diff --git a/versioned_docs/version-0.14/api/redditapi/models/type-aliases/SearchPostsOptions.md b/versioned_docs/version-0.14/api/redditapi/models/type-aliases/SearchPostsOptions.md new file mode 100644 index 00000000..5a85a1c7 --- /dev/null +++ b/versioned_docs/version-0.14/api/redditapi/models/type-aliases/SearchPostsOptions.md @@ -0,0 +1,33 @@ +[**@devvit/reddit v0.14.1-dev**](../../README.md) + +*** + +# Type Alias: SearchPostsOptions + +> **SearchPostsOptions** = [`ListingFetchOptions`](ListingFetchOptions.md) & `object` + +## Type declaration + +### query + +> **query**: `string` + +Search query. + +### sort? + +> `optional` **sort**: `"relevance"` \| `"hot"` \| `"top"` \| `"new"` \| `"comments"` + +How to sort the search results. Defaults to `relevance`. + +### subredditName? + +> `optional` **subredditName**: `string` + +The subreddit to search without 'r/' prefix. If specified, will restrict the search to posts in this subreddit + +### timeframe? + +> `optional` **timeframe**: `"hour"` \| `"day"` \| `"week"` \| `"month"` \| `"year"` \| `"all"` + +Limit search results to a timeframe. Defaults to `all`.