diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/README.md b/docs/api/public-api/@devvit/namespaces/Devvit/README.md index 104b50ae..3b5a1cb1 100644 --- a/docs/api/public-api/@devvit/namespaces/Devvit/README.md +++ b/docs/api/public-api/@devvit/namespaces/Devvit/README.md @@ -1,24 +1,9 @@ -[**@devvit/public-api v0.12.25-dev**](../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../README.md) *** # Devvit -## Namespaces - -- [Blocks](namespaces/Blocks/README.md) - ## Type Aliases -- [BlockComponent](type-aliases/BlockComponent.md) -- [BlockComponentProps](type-aliases/BlockComponentProps.md) -- [Context](type-aliases/Context.md) -- [CustomPostComponent](type-aliases/CustomPostComponent.md) -- [ElementChildren](type-aliases/ElementChildren.md) -- [Fragment](type-aliases/Fragment.md) -- [StringChild](type-aliases/StringChild.md) -- [StringChildren](type-aliases/StringChildren.md) - -## Functions - -- [createElement](functions/createElement.md) +- [~~Context~~](type-aliases/Context.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/functions/createElement.md b/docs/api/public-api/@devvit/namespaces/Devvit/functions/createElement.md deleted file mode 100644 index 97a0d4bc..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/functions/createElement.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) - -*** - -# Function: createElement() - -> **createElement**(`type`, `props`, ...`children`): [`BlockElement`](../../../../type-aliases/BlockElement.md) - -## Parameters - -### type - -keyof [`IntrinsicElements`](../namespaces/Blocks/interfaces/IntrinsicElements.md) - -### props - -`undefined` | \{\} - -### children - -...`Children`[] - -## Returns - -[`BlockElement`](../../../../type-aliases/BlockElement.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/README.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/README.md deleted file mode 100644 index 4a068bd0..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/README.md +++ /dev/null @@ -1,57 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../README.md) - -*** - -# Blocks - -## Interfaces - -- [IntrinsicElements](interfaces/IntrinsicElements.md) - -## Type Aliases - -- [Actionable](type-aliases/Actionable.md) -- [ActionHandlers](type-aliases/ActionHandlers.md) -- [Alignment](type-aliases/Alignment.md) -- [AvatarBackground](type-aliases/AvatarBackground.md) -- [AvatarFacing](type-aliases/AvatarFacing.md) -- [AvatarProps](type-aliases/AvatarProps.md) -- [AvatarSize](type-aliases/AvatarSize.md) -- [BaseProps](type-aliases/BaseProps.md) -- [ButtonAppearance](type-aliases/ButtonAppearance.md) -- [ButtonProps](type-aliases/ButtonProps.md) -- [ButtonSize](type-aliases/ButtonSize.md) -- [ColorString](type-aliases/ColorString.md) -- [ContainerBorderWidth](type-aliases/ContainerBorderWidth.md) -- [ContainerCornerRadius](type-aliases/ContainerCornerRadius.md) -- [ContainerGap](type-aliases/ContainerGap.md) -- [ContainerPadding](type-aliases/ContainerPadding.md) -- [HasElementChildren](type-aliases/HasElementChildren.md) -- [HasStringChildren](type-aliases/HasStringChildren.md) -- [HorizontalAlignment](type-aliases/HorizontalAlignment.md) -- [IconProps](type-aliases/IconProps.md) -- [IconSize](type-aliases/IconSize.md) -- [ImageProps](type-aliases/ImageProps.md) -- [ImageResizeMode](type-aliases/ImageResizeMode.md) -- [IntrinsicElementsType](type-aliases/IntrinsicElementsType.md) -- [OnPressEventHandler](type-aliases/OnPressEventHandler.md) -- [OnWebViewEventHandler](type-aliases/OnWebViewEventHandler.md) -- [RootHeight](type-aliases/RootHeight.md) -- [RootProps](type-aliases/RootProps.md) -- [SizePercent](type-aliases/SizePercent.md) -- [SizePixels](type-aliases/SizePixels.md) -- [SizeString](type-aliases/SizeString.md) -- [SpacerProps](type-aliases/SpacerProps.md) -- [SpacerShape](type-aliases/SpacerShape.md) -- [SpacerSize](type-aliases/SpacerSize.md) -- [StackProps](type-aliases/StackProps.md) -- [TextOutline](type-aliases/TextOutline.md) -- [TextOverflow](type-aliases/TextOverflow.md) -- [TextProps](type-aliases/TextProps.md) -- [TextSize](type-aliases/TextSize.md) -- [TextStyle](type-aliases/TextStyle.md) -- [TextWeight](type-aliases/TextWeight.md) -- [Thickness](type-aliases/Thickness.md) -- [VerticalAlignment](type-aliases/VerticalAlignment.md) -- [WebViewActionable](type-aliases/WebViewActionable.md) -- [WebViewProps](type-aliases/WebViewProps.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/interfaces/IntrinsicElements.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/interfaces/IntrinsicElements.md deleted file mode 100644 index 04752e5e..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/interfaces/IntrinsicElements.md +++ /dev/null @@ -1,93 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Interface: IntrinsicElements - -## Properties - - - -### avatar - -> **avatar**: [`AvatarProps`](../type-aliases/AvatarProps.md) - -*** - - - -### blocks - -> **blocks**: [`RootProps`](../type-aliases/RootProps.md) - -*** - - - -### button - -> **button**: [`ButtonProps`](../type-aliases/ButtonProps.md) - -*** - - - -### hstack - -> **hstack**: [`StackProps`](../type-aliases/StackProps.md) - -*** - - - -### icon - -> **icon**: [`IconProps`](../type-aliases/IconProps.md) - -*** - - - -### image - -> **image**: [`ImageProps`](../type-aliases/ImageProps.md) - -*** - - - -### spacer - -> **spacer**: [`SpacerProps`](../type-aliases/SpacerProps.md) - -*** - - - -### text - -> **text**: [`TextProps`](../type-aliases/TextProps.md) - -*** - - - -### vstack - -> **vstack**: [`StackProps`](../type-aliases/StackProps.md) - -*** - - - -### webview - -> **webview**: [`WebViewProps`](../type-aliases/WebViewProps.md) - -*** - - - -### zstack - -> **zstack**: [`StackProps`](../type-aliases/StackProps.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ActionHandlers.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ActionHandlers.md deleted file mode 100644 index 8f1ec72b..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ActionHandlers.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ActionHandlers - -> **ActionHandlers** = keyof [`Actionable`](Actionable.md) & [`WebViewActionable`](WebViewActionable.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Actionable.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Actionable.md deleted file mode 100644 index 33ffc57d..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Actionable.md +++ /dev/null @@ -1,15 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: Actionable - -> **Actionable** = `object` - -## Properties - - - -### onPress? - -> `optional` **onPress**: [`OnPressEventHandler`](OnPressEventHandler.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Alignment.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Alignment.md deleted file mode 100644 index e4b47029..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Alignment.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: Alignment - -> **Alignment** = `` `${VerticalAlignment}` `` \| `` `${HorizontalAlignment}` `` \| `` `${VerticalAlignment} ${HorizontalAlignment}` `` \| `` `${HorizontalAlignment} ${VerticalAlignment}` `` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarBackground.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarBackground.md deleted file mode 100644 index dc0afcb4..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarBackground.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: AvatarBackground - -> **AvatarBackground** = `"light"` \| `"dark"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarFacing.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarFacing.md deleted file mode 100644 index 8e5274d0..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarFacing.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: AvatarFacing - -> **AvatarFacing** = `"left"` \| `"right"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarProps.md deleted file mode 100644 index 955bb4be..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarProps.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: AvatarProps - -> **AvatarProps** = [`BaseProps`](BaseProps.md) & [`Actionable`](Actionable.md) & `object` - -## Type declaration - -### background? - -> `optional` **background**: [`AvatarBackground`](AvatarBackground.md) - -### facing? - -> `optional` **facing**: [`AvatarFacing`](AvatarFacing.md) - -### size? - -> `optional` **size**: [`AvatarSize`](AvatarSize.md) - -### thingId - -> **thingId**: `string` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarSize.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarSize.md deleted file mode 100644 index dfe58338..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/AvatarSize.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: AvatarSize - -> **AvatarSize** = `"xxsmall"` \| `"xsmall"` \| `"small"` \| `"medium"` \| `"large"` \| `"xlarge"` \| `"xxlarge"` \| `"xxxlarge"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/BaseProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/BaseProps.md deleted file mode 100644 index d9fbf34c..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/BaseProps.md +++ /dev/null @@ -1,96 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: BaseProps - -> **BaseProps** = `object` - -## Properties - - - -### grow? - -> `optional` **grow**: `boolean` - -*** - - - -### height? - -> `optional` **height**: [`SizeString`](SizeString.md) - -*** - - - -### id? - -> `optional` **id**: `string` - -This optional field provides a unique identifier for the element. This is useful for ensuring -re-use of elements across renders. See the `key` field for more information. Unlike key, id -is global. You cannot have two elements with the same id in the same tree. - -*** - - - -### key? - -> `optional` **key**: `string` - -This optional field provides some efficiencies around re-ordering elements in a list. Rather -Than re-rendering the entire list, the client can use the key to determine if the element has -changed. In the example below, if a and b were swapped, the client would know to reuse the -existing elements from b, rather than re-creating an expensive tree of elements. - -Unlike id, key is local to the parent element. This means that the same key can be used in different -parts of the tree without conflict. - - - hi world - ...deeply nested content... - - -*** - - - -### maxHeight? - -> `optional` **maxHeight**: [`SizeString`](SizeString.md) - -*** - - - -### maxWidth? - -> `optional` **maxWidth**: [`SizeString`](SizeString.md) - -*** - - - -### minHeight? - -> `optional` **minHeight**: [`SizeString`](SizeString.md) - -*** - - - -### minWidth? - -> `optional` **minWidth**: [`SizeString`](SizeString.md) - -*** - - - -### width? - -> `optional` **width**: [`SizeString`](SizeString.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonAppearance.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonAppearance.md deleted file mode 100644 index ea15de66..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonAppearance.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ButtonAppearance - -> **ButtonAppearance** = `"secondary"` \| `"primary"` \| `"plain"` \| `"bordered"` \| `"media"` \| `"destructive"` \| `"caution"` \| `"success"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonProps.md deleted file mode 100644 index 3a1369cf..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonProps.md +++ /dev/null @@ -1,37 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ButtonProps - -> **ButtonProps** = [`BaseProps`](BaseProps.md) & [`HasStringChildren`](HasStringChildren.md) & [`Actionable`](Actionable.md) & `object` - -## Type declaration - -### appearance? - -> `optional` **appearance**: [`ButtonAppearance`](ButtonAppearance.md) - -### darkTextColor? - -> `optional` **darkTextColor**: [`ColorString`](ColorString.md) - -### disabled? - -> `optional` **disabled**: `boolean` - -### icon? - -> `optional` **icon**: [`IconName`](../../../../../../type-aliases/IconName.md) - -### lightTextColor? - -> `optional` **lightTextColor**: [`ColorString`](ColorString.md) - -### size? - -> `optional` **size**: [`ButtonSize`](ButtonSize.md) - -### textColor? - -> `optional` **textColor**: [`ColorString`](ColorString.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonSize.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonSize.md deleted file mode 100644 index 8c429f90..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ButtonSize.md +++ /dev/null @@ -1,12 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ButtonSize - -> **ButtonSize** = `"small"` \| `"medium"` \| `"large"` - -Affects the button height. -small = 32px; -medium = 40px; -large = 48px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ColorString.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ColorString.md deleted file mode 100644 index c5d76c41..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ColorString.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ColorString - -> **ColorString** = `string` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerBorderWidth.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerBorderWidth.md deleted file mode 100644 index 7ab5d899..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerBorderWidth.md +++ /dev/null @@ -1,10 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ContainerBorderWidth - -> **ContainerBorderWidth** = [`Thickness`](Thickness.md) - -thin = 1px; -thick = 2px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerCornerRadius.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerCornerRadius.md deleted file mode 100644 index 8b6c355f..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerCornerRadius.md +++ /dev/null @@ -1,11 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ContainerCornerRadius - -> **ContainerCornerRadius** = `"none"` \| `"small"` \| `"medium"` \| `"large"` \| `"full"` - -small = 8px; -medium = 16px; -large = 24px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerGap.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerGap.md deleted file mode 100644 index a2b10a3e..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerGap.md +++ /dev/null @@ -1,11 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ContainerGap - -> **ContainerGap** = `"none"` \| `"small"` \| `"medium"` \| `"large"` - -small = 8px; -medium = 16px; -large = 32px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerPadding.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerPadding.md deleted file mode 100644 index 2d52775d..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ContainerPadding.md +++ /dev/null @@ -1,12 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ContainerPadding - -> **ContainerPadding** = `"none"` \| `"xsmall"` \| `"small"` \| `"medium"` \| `"large"` - -xsmall = 4px; -small = 8px; -medium = 16px; -large = 32px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HasElementChildren.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HasElementChildren.md deleted file mode 100644 index 6de2b57b..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HasElementChildren.md +++ /dev/null @@ -1,15 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: HasElementChildren - -> **HasElementChildren** = `object` - -## Properties - - - -### children? - -> `optional` **children**: [`ElementChildren`](../../../type-aliases/ElementChildren.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HasStringChildren.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HasStringChildren.md deleted file mode 100644 index a65c0a6b..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HasStringChildren.md +++ /dev/null @@ -1,15 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: HasStringChildren - -> **HasStringChildren** = `object` - -## Properties - - - -### children? - -> `optional` **children**: [`StringChildren`](../../../type-aliases/StringChildren.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HorizontalAlignment.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HorizontalAlignment.md deleted file mode 100644 index 0b83afd5..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/HorizontalAlignment.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: HorizontalAlignment - -> **HorizontalAlignment** = `"start"` \| `"center"` \| `"end"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IconProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IconProps.md deleted file mode 100644 index 6601d513..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IconProps.md +++ /dev/null @@ -1,29 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: IconProps - -> **IconProps** = [`BaseProps`](BaseProps.md) & [`HasStringChildren`](HasStringChildren.md) & [`Actionable`](Actionable.md) & `object` - -## Type declaration - -### color? - -> `optional` **color**: [`ColorString`](ColorString.md) - -### darkColor? - -> `optional` **darkColor**: [`ColorString`](ColorString.md) - -### lightColor? - -> `optional` **lightColor**: [`ColorString`](ColorString.md) - -### name - -> **name**: [`IconName`](../../../../../../type-aliases/IconName.md) - -### size? - -> `optional` **size**: [`IconSize`](IconSize.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IconSize.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IconSize.md deleted file mode 100644 index 63e379e5..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IconSize.md +++ /dev/null @@ -1,12 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: IconSize - -> **IconSize** = `"xsmall"` \| `"small"` \| `"medium"` \| `"large"` - -xsmall = 12px; -small = 16px; -medium = 20px; -large = 24px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ImageProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ImageProps.md deleted file mode 100644 index f56c1e4d..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ImageProps.md +++ /dev/null @@ -1,29 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ImageProps - -> **ImageProps** = [`BaseProps`](BaseProps.md) & [`Actionable`](Actionable.md) & `object` - -## Type declaration - -### description? - -> `optional` **description**: `string` - -### imageHeight - -> **imageHeight**: [`SizePixels`](SizePixels.md) \| `number` - -### imageWidth - -> **imageWidth**: [`SizePixels`](SizePixels.md) \| `number` - -### resizeMode? - -> `optional` **resizeMode**: [`ImageResizeMode`](ImageResizeMode.md) - -### url - -> **url**: `string` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ImageResizeMode.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ImageResizeMode.md deleted file mode 100644 index b78e3302..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/ImageResizeMode.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: ImageResizeMode - -> **ImageResizeMode** = `"none"` \| `"fit"` \| `"fill"` \| `"cover"` \| `"scale-down"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IntrinsicElementsType.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IntrinsicElementsType.md deleted file mode 100644 index 411ab5bf..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/IntrinsicElementsType.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: IntrinsicElementsType - -> **IntrinsicElementsType** = keyof [`IntrinsicElements`](../interfaces/IntrinsicElements.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/OnPressEventHandler.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/OnPressEventHandler.md deleted file mode 100644 index 04e7dbb7..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/OnPressEventHandler.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: OnPressEventHandler() - -> **OnPressEventHandler** = (`data`) => `void` \| `Promise`\<`void`\> - -## Parameters - -### data - -[`JSONObject`](../../../../../../type-aliases/JSONObject.md) - -## Returns - -`void` \| `Promise`\<`void`\> diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/OnWebViewEventHandler.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/OnWebViewEventHandler.md deleted file mode 100644 index 271f8f11..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/OnWebViewEventHandler.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: OnWebViewEventHandler() - -> **OnWebViewEventHandler** = \<`T`\>(`message`) => `void` \| `Promise`\<`void`\> - -## Type Parameters - -### T - -`T` *extends* [`JSONValue`](../../../../../../type-aliases/JSONValue.md) - -## Parameters - -### message - -`T` - -## Returns - -`void` \| `Promise`\<`void`\> diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/RootHeight.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/RootHeight.md deleted file mode 100644 index 7877bff0..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/RootHeight.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: RootHeight - -> **RootHeight** = `"regular"` \| `"tall"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/RootProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/RootProps.md deleted file mode 100644 index b9e7abd7..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/RootProps.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: RootProps - -> **RootProps** = [`HasElementChildren`](HasElementChildren.md) & `object` - -## Type declaration - -### height? - -> `optional` **height**: [`RootHeight`](RootHeight.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizePercent.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizePercent.md deleted file mode 100644 index 367d322d..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizePercent.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: SizePercent - -> **SizePercent** = `` `${number}%` `` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizePixels.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizePixels.md deleted file mode 100644 index b80f2182..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizePixels.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: SizePixels - -> **SizePixels** = `` `${number}px` `` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizeString.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizeString.md deleted file mode 100644 index f4d40921..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SizeString.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: SizeString - -> **SizeString** = [`SizePixels`](SizePixels.md) \| [`SizePercent`](SizePercent.md) \| `number` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerProps.md deleted file mode 100644 index 5c46d3be..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerProps.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: SpacerProps - -> **SpacerProps** = [`BaseProps`](BaseProps.md) & `object` - -## Type declaration - -### shape? - -> `optional` **shape**: [`SpacerShape`](SpacerShape.md) - -### size? - -> `optional` **size**: [`SpacerSize`](SpacerSize.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerShape.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerShape.md deleted file mode 100644 index acda4a72..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerShape.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: SpacerShape - -> **SpacerShape** = `"invisible"` \| `"thin"` \| `"square"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerSize.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerSize.md deleted file mode 100644 index 2fb453a5..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/SpacerSize.md +++ /dev/null @@ -1,12 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: SpacerSize - -> **SpacerSize** = `"xsmall"` \| `"small"` \| `"medium"` \| `"large"` - -xsmall = 4px; -small = 8px; -medium = 16px; -large = 32px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/StackProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/StackProps.md deleted file mode 100644 index 4b4da7dd..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/StackProps.md +++ /dev/null @@ -1,57 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: StackProps - -> **StackProps** = [`BaseProps`](BaseProps.md) & [`HasElementChildren`](HasElementChildren.md) & [`Actionable`](Actionable.md) & `object` - -## Type declaration - -### alignment? - -> `optional` **alignment**: [`Alignment`](Alignment.md) - -### backgroundColor? - -> `optional` **backgroundColor**: [`ColorString`](ColorString.md) - -### border? - -> `optional` **border**: [`ContainerBorderWidth`](ContainerBorderWidth.md) - -### borderColor? - -> `optional` **borderColor**: [`ColorString`](ColorString.md) - -### cornerRadius? - -> `optional` **cornerRadius**: [`ContainerCornerRadius`](ContainerCornerRadius.md) - -### darkBackgroundColor? - -> `optional` **darkBackgroundColor**: [`ColorString`](ColorString.md) - -### darkBorderColor? - -> `optional` **darkBorderColor**: [`ColorString`](ColorString.md) - -### gap? - -> `optional` **gap**: [`ContainerGap`](ContainerGap.md) - -### lightBackgroundColor? - -> `optional` **lightBackgroundColor**: [`ColorString`](ColorString.md) - -### lightBorderColor? - -> `optional` **lightBorderColor**: [`ColorString`](ColorString.md) - -### padding? - -> `optional` **padding**: [`ContainerPadding`](ContainerPadding.md) - -### reverse? - -> `optional` **reverse**: `boolean` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextOutline.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextOutline.md deleted file mode 100644 index 3b4876a0..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextOutline.md +++ /dev/null @@ -1,10 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: TextOutline - -> **TextOutline** = [`Thickness`](Thickness.md) - -thin = 1px; -thick = 2px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextOverflow.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextOverflow.md deleted file mode 100644 index 3d1ad955..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextOverflow.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: TextOverflow - -> **TextOverflow** = `"clip"` \| `"ellipsis"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextProps.md deleted file mode 100644 index 86234161..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextProps.md +++ /dev/null @@ -1,53 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: TextProps - -> **TextProps** = [`BaseProps`](BaseProps.md) & [`HasStringChildren`](HasStringChildren.md) & [`Actionable`](Actionable.md) & `object` - -## Type declaration - -### alignment? - -> `optional` **alignment**: [`Alignment`](Alignment.md) - -### color? - -> `optional` **color**: [`ColorString`](ColorString.md) - -### darkColor? - -> `optional` **darkColor**: [`ColorString`](ColorString.md) - -### lightColor? - -> `optional` **lightColor**: [`ColorString`](ColorString.md) - -### outline? - -> `optional` **outline**: [`TextOutline`](TextOutline.md) - -### overflow? - -> `optional` **overflow**: [`TextOverflow`](TextOverflow.md) - -### selectable? - -> `optional` **selectable**: `boolean` - -### size? - -> `optional` **size**: [`TextSize`](TextSize.md) - -### style? - -> `optional` **style**: [`TextStyle`](TextStyle.md) - -### weight? - -> `optional` **weight**: [`TextWeight`](TextWeight.md) - -### wrap? - -> `optional` **wrap**: `boolean` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextSize.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextSize.md deleted file mode 100644 index 95717ad6..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextSize.md +++ /dev/null @@ -1,14 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: TextSize - -> **TextSize** = `"xsmall"` \| `"small"` \| `"medium"` \| `"large"` \| `"xlarge"` \| `"xxlarge"` - -xsmall = 10px; -small = 12px; -medium = 14px; -large = 16px; -xlarge = 18px; -xxlarge = 24px; diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextStyle.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextStyle.md deleted file mode 100644 index 80bfe95b..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextStyle.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: TextStyle - -> **TextStyle** = `"body"` \| `"metadata"` \| `"heading"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextWeight.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextWeight.md deleted file mode 100644 index df4adcb0..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/TextWeight.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: TextWeight - -> **TextWeight** = `"regular"` \| `"bold"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Thickness.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Thickness.md deleted file mode 100644 index b7a331bf..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/Thickness.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: Thickness - -> **Thickness** = `"none"` \| `"thin"` \| `"thick"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/VerticalAlignment.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/VerticalAlignment.md deleted file mode 100644 index 78e33fc2..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/VerticalAlignment.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: VerticalAlignment - -> **VerticalAlignment** = `"top"` \| `"middle"` \| `"bottom"` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/WebViewActionable.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/WebViewActionable.md deleted file mode 100644 index b92b8f33..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/WebViewActionable.md +++ /dev/null @@ -1,15 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: WebViewActionable - -> **WebViewActionable** = `object` - -## Properties - - - -### onMessage? - -> `optional` **onMessage**: [`OnWebViewEventHandler`](OnWebViewEventHandler.md) diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/WebViewProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/WebViewProps.md deleted file mode 100644 index 1e8da2c5..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/WebViewProps.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../../../README.md) - -*** - -# Type Alias: WebViewProps - -> **WebViewProps** = [`BaseProps`](BaseProps.md) & [`WebViewActionable`](WebViewActionable.md) & `object` - -## Type declaration - -### url - -> **url**: `string` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/BlockComponent.md b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/BlockComponent.md deleted file mode 100644 index f84a231d..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/BlockComponent.md +++ /dev/null @@ -1,27 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) - -*** - -# Type Alias: BlockComponent()\ - -> **BlockComponent**\<`P`\> = (`props`, `context`) => `JSX.Element` - -## Type Parameters - -### P - -`P` = \{\} - -## Parameters - -### props - -[`BlockComponentProps`](BlockComponentProps.md)\<`P`\> - -### context - -[`Context`](Context.md) - -## Returns - -`JSX.Element` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/BlockComponentProps.md b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/BlockComponentProps.md deleted file mode 100644 index d16b61cd..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/BlockComponentProps.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) - -*** - -# Type Alias: BlockComponentProps\ - -> **BlockComponentProps**\<`P`\> = `P` & `object` - -## Type declaration - -### children? - -> `optional` **children**: `JSX.Children` - -## Type Parameters - -### P - -`P` = \{\} 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 d01ba4f9..b688d098 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,9 +1,13 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** -# Type Alias: Context +# Type Alias: ~~Context~~ > **Context** = [`ContextAPIClients`](../../../../type-aliases/ContextAPIClients.md) & [`BaseContext`](../../../../type-aliases/BaseContext.md) The current app context of the event or render. + +## Deprecated + +- Please switch to the `Context` type exported by public-api. diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/CustomPostComponent.md b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/CustomPostComponent.md deleted file mode 100644 index b39761fb..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/CustomPostComponent.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) - -*** - -# Type Alias: CustomPostComponent() - -> **CustomPostComponent** = (`context`) => `JSX.Element` - -## Parameters - -### context - -[`Context`](Context.md) - -## Returns - -`JSX.Element` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/ElementChildren.md b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/ElementChildren.md deleted file mode 100644 index 024f47d7..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/ElementChildren.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) - -*** - -# Type Alias: ElementChildren - -> **ElementChildren** = `JSX.Element` \| `JSX.Children` \| `undefined` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/Fragment.md b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/Fragment.md deleted file mode 100644 index c574bab1..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/Fragment.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) - -*** - -# Type Alias: Fragment - -> **Fragment** = `JSX.Fragment` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/StringChild.md b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/StringChild.md deleted file mode 100644 index 4c691d17..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/StringChild.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) - -*** - -# Type Alias: StringChild - -> **StringChild** = [`Fragment`](Fragment.md) \| `string` \| `number` diff --git a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/StringChildren.md b/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/StringChildren.md deleted file mode 100644 index a5f68327..00000000 --- a/docs/api/public-api/@devvit/namespaces/Devvit/type-aliases/StringChildren.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) - -*** - -# Type Alias: StringChildren - -> **StringChildren** = [`StringChild`](StringChild.md) \| ([`StringChild`](StringChild.md) \| [`StringChild`](StringChild.md)[])[] \| `undefined` diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/README.md b/docs/api/public-api/@devvit/namespaces/EventTypes/README.md index 1b9a6c1e..9ba5204f 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.12.25-dev**](../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../README.md) *** @@ -8,6 +8,11 @@ Code generated by ts-proto. DO NOT EDIT. +## Enumerations + +- [DeletionReason](enumerations/DeletionReason.md) +- [EventSource](enumerations/EventSource.md) + ## Interfaces - [AccountDelete](interfaces/AccountDelete.md) @@ -21,6 +26,7 @@ Code generated by ts-proto. DO NOT EDIT. - [CommentReport](interfaces/CommentReport.md) - [CommentSubmit](interfaces/CommentSubmit.md) - [CommentUpdate](interfaces/CommentUpdate.md) +- [MentionInCommentCreate](interfaces/MentionInCommentCreate.md) - [PostApprove](interfaces/PostApprove.md) - [PostCreate](interfaces/PostCreate.md) - [PostDelete](interfaces/PostDelete.md) @@ -46,6 +52,7 @@ Code generated by ts-proto. DO NOT EDIT. - [CommentReport](variables/CommentReport.md) - [CommentSubmit](variables/CommentSubmit.md) - [CommentUpdate](variables/CommentUpdate.md) +- [MentionInCommentCreate](variables/MentionInCommentCreate.md) - [PostApprove](variables/PostApprove.md) - [PostCreate](variables/PostCreate.md) - [PostDelete](variables/PostDelete.md) @@ -64,19 +71,3 @@ Code generated by ts-proto. DO NOT EDIT. - [deletionReasonToJSON](functions/deletionReasonToJSON.md) - [eventSourceFromJSON](functions/eventSourceFromJSON.md) - [eventSourceToJSON](functions/eventSourceToJSON.md) - -## References - - - -### DeletionReason - -Re-exports [DeletionReason](../../../enumerations/DeletionReason.md) - -*** - - - -### EventSource - -Re-exports [EventSource](../../../enumerations/EventSource.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 new file mode 100644 index 00000000..13f09c33 --- /dev/null +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/DeletionReason.md @@ -0,0 +1,61 @@ +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) + +*** + +# Enumeration: DeletionReason + +## Enumeration Members + + + +### EXPLICIT\_CONTENT + +> **EXPLICIT\_CONTENT**: `5` + +*** + + + +### LEGAL + +> **LEGAL**: `2` + +*** + + + +### OTHER + +> **OTHER**: `3` + +*** + + + +### SPAM + +> **SPAM**: `1` + +*** + + + +### UNKNOWN + +> **UNKNOWN**: `4` + +*** + + + +### UNRECOGNIZED + +> **UNRECOGNIZED**: `-1` + +*** + + + +### UNSPECIFIED\_DELETION\_REASON + +> **UNSPECIFIED\_DELETION\_REASON**: `0` diff --git a/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/EventSource.md b/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/EventSource.md new file mode 100644 index 00000000..55a85ac3 --- /dev/null +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/enumerations/EventSource.md @@ -0,0 +1,45 @@ +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) + +*** + +# Enumeration: EventSource + +## Enumeration Members + + + +### ADMIN + +> **ADMIN**: `2` + +*** + + + +### MODERATOR + +> **MODERATOR**: `3` + +*** + + + +### UNKNOWN\_EVENT\_SOURCE + +> **UNKNOWN\_EVENT\_SOURCE**: `0` + +*** + + + +### UNRECOGNIZED + +> **UNRECOGNIZED**: `-1` + +*** + + + +### USER + +> **USER**: `1` 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 6bf7d997..012e18ce 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonFromJSON.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/deletionReasonFromJSON.md @@ -1,10 +1,10 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** # Function: deletionReasonFromJSON() -> **deletionReasonFromJSON**(`object`): [`DeletionReason`](../../../../enumerations/DeletionReason.md) +> **deletionReasonFromJSON**(`object`): [`DeletionReason`](../enumerations/DeletionReason.md) ## Parameters @@ -14,4 +14,4 @@ ## Returns -[`DeletionReason`](../../../../enumerations/DeletionReason.md) +[`DeletionReason`](../enumerations/DeletionReason.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 950ab941..8ddbd570 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -10,7 +10,7 @@ ### object -[`DeletionReason`](../../../../enumerations/DeletionReason.md) +[`DeletionReason`](../enumerations/DeletionReason.md) ## Returns 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 5c9c9dea..b0cafd62 100644 --- a/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceFromJSON.md +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/functions/eventSourceFromJSON.md @@ -1,10 +1,10 @@ -[**@devvit/public-api v0.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** # Function: eventSourceFromJSON() -> **eventSourceFromJSON**(`object`): [`EventSource`](../../../../enumerations/EventSource.md) +> **eventSourceFromJSON**(`object`): [`EventSource`](../enumerations/EventSource.md) ## Parameters @@ -14,4 +14,4 @@ ## Returns -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.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 281107fa..3716bcc0 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -10,7 +10,7 @@ ### object -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ## Returns 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 668ea8da..dd634cfe 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 03e27185..133af756 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 d23bba7e..88f47077 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 0f063642..b1e6bc1a 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 87404eff..929ff0ae 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 8489bae9..95c652e0 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -42,7 +42,7 @@ ### source -> **source**: [`EventSource`](../../../../enumerations/EventSource.md) +> **source**: [`EventSource`](../enumerations/EventSource.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 6ccf47d4..a1aa0268 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 e28afee6..81c262aa 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -58,7 +58,7 @@ ### reason -> **reason**: [`DeletionReason`](../../../../enumerations/DeletionReason.md) +> **reason**: [`DeletionReason`](../enumerations/DeletionReason.md) *** @@ -66,7 +66,7 @@ ### source -> **source**: [`EventSource`](../../../../enumerations/EventSource.md) +> **source**: [`EventSource`](../enumerations/EventSource.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 d4a9a529..a5b81e7f 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 a9c6e68d..77c5b566 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 782c99fc..a3727fb8 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 new file mode 100644 index 00000000..dd67ae4d --- /dev/null +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/interfaces/MentionInCommentCreate.md @@ -0,0 +1,45 @@ +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) + +*** + +# Interface: MentionInCommentCreate + +## Properties + + + +### author? + +> `optional` **author**: `UserV2` + +*** + + + +### comment? + +> `optional` **comment**: `CommentV2` + +*** + + + +### mentions? + +> `optional` **mentions**: `Mentions` + +*** + + + +### post? + +> `optional` **post**: `PostV2` + +*** + + + +### subreddit? + +> `optional` **subreddit**: `SubredditV2` 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 7d4bfcf4..d29e6342 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -34,7 +34,7 @@ ### source -> **source**: [`EventSource`](../../../../enumerations/EventSource.md) +> **source**: [`EventSource`](../enumerations/EventSource.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 7ac93b20..12e11948 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 8e63bdf3..0aced423 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -42,7 +42,7 @@ ### reason -> **reason**: [`DeletionReason`](../../../../enumerations/DeletionReason.md) +> **reason**: [`DeletionReason`](../enumerations/DeletionReason.md) *** @@ -50,7 +50,7 @@ ### source -> **source**: [`EventSource`](../../../../enumerations/EventSource.md) +> **source**: [`EventSource`](../enumerations/EventSource.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 edf8215b..78454fb5 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 95a901e9..a42393ea 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 1788b393..ee02c8a5 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 e07033f7..2620d14a 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 7f5c3bf4..018d5fad 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 4867f8ed..a394a4c4 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 fa90cbf0..ad31b19f 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 ceb5dbb9..c7710541 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 352a8d3a..2b9ec41b 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 773c297c..573ab17d 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 263e1cd1..6458cad0 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 4820a5eb..f0dda8f1 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 5b3ed4dc..ce5f0248 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 8cbb2ab1..fa673505 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -548,7 +548,7 @@ rename to text? ###### source? -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ###### subreddit? @@ -1190,7 +1190,7 @@ rename to text? ###### source? -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ###### subreddit? 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 9d1085d9..e769d215 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 67c4d948..29d50135 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -128,11 +128,11 @@ ###### reason? -[`DeletionReason`](../../../../enumerations/DeletionReason.md) +[`DeletionReason`](../enumerations/DeletionReason.md) ###### source? -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ###### subreddit? @@ -354,11 +354,11 @@ ###### reason? -[`DeletionReason`](../../../../enumerations/DeletionReason.md) +[`DeletionReason`](../enumerations/DeletionReason.md) ###### source? -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ###### subreddit? 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 c045c5a3..9db92a2e 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 d3e34032..60062feb 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 e4180602..9cf92cb1 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 new file mode 100644 index 00000000..10fa83d3 --- /dev/null +++ b/docs/api/public-api/@devvit/namespaces/EventTypes/variables/MentionInCommentCreate.md @@ -0,0 +1,1263 @@ +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) + +*** + +# Variable: MentionInCommentCreate + +> **MentionInCommentCreate**: `object` + +## Type declaration + + + +### $type + +> **$type**: `"devvit.events.v1alpha.MentionInCommentCreate"` + + + +### create() + +#### Parameters + +##### base? + +###### author? + +\{ `banned`: `boolean`; `description`: `string`; `flair`: \{ `backgroundColor`: `string`; `cssClass`: `string`; `enabled`: `boolean`; `subredditId`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; `userId`: `string`; \}; `iconImage`: `string`; `id`: `string`; `isGold`: `boolean`; `karma`: `number`; `name`: `string`; `snoovatarImage`: `string`; `spam`: `boolean`; `suspended`: `boolean`; `url`: `string`; \} + +###### author.banned? + +`boolean` + +###### author.description? + +`string` + +###### author.flair? + +\{ `backgroundColor`: `string`; `cssClass`: `string`; `enabled`: `boolean`; `subredditId`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; `userId`: `string`; \} + +###### author.flair.backgroundColor? + +`string` + +###### author.flair.cssClass? + +`string` + +###### author.flair.enabled? + +`boolean` + +###### author.flair.subredditId? + +`string` + +###### author.flair.templateId? + +`string` + +###### author.flair.text? + +`string` + +###### author.flair.textColor? + +`string` + +###### author.flair.userId? + +`string` + +###### author.iconImage? + +`string` + +###### author.id? + +`string` + +###### author.isGold? + +`boolean` + +###### author.karma? + +`number` + +###### author.name? + +`string` + +###### author.snoovatarImage? + +`string` + +###### author.spam? + +`boolean` + +###### author.suspended? + +`boolean` + +###### author.url? + +`string` + +###### comment? + +\{ `author`: `string`; `body`: `string`; `collapsedBecauseCrowdControl`: `boolean`; `createdAt`: `number`; `deleted`: `boolean`; `downvotes`: `number`; `elementTypes`: `string`[]; `gilded`: `boolean`; `hasMedia`: `boolean`; `id`: `string`; `languageCode`: `string`; `lastModifiedAt`: `number`; `mediaUrls`: `string`[]; `numReports`: `number`; `parentId`: `string`; `permalink`: `string`; `postId`: `string`; `score`: `number`; `spam`: `boolean`; `subredditId`: `string`; `upvotes`: `number`; \} + +###### comment.author? + +`string` + +###### comment.body? + +`string` + +###### comment.collapsedBecauseCrowdControl? + +`boolean` + +###### comment.createdAt? + +`number` + +###### comment.deleted? + +`boolean` + +###### comment.downvotes? + +`number` + +###### comment.elementTypes? + +`string`[] + +###### comment.gilded? + +`boolean` + +###### comment.hasMedia? + +`boolean` + +###### comment.id? + +`string` + +###### comment.languageCode? + +`string` + +###### comment.lastModifiedAt? + +`number` + +###### comment.mediaUrls? + +`string`[] + +###### comment.numReports? + +`number` + +###### comment.parentId? + +`string` + +###### comment.permalink? + +`string` + +###### comment.postId? + +`string` + +###### comment.score? + +`number` + +###### comment.spam? + +`boolean` + +###### comment.subredditId? + +`string` + +###### comment.upvotes? + +`number` + +###### mentions? + +\{ `items`: `object`[]; \} + +###### mentions.items? + +`object`[] + +###### post? + +\{ `authorFlair`: \{ `backgroundColor`: `string`; `cssClass`: `string`; `enabled`: `boolean`; `subredditId`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; `userId`: `string`; \}; `authorId`: `string`; `createdAt`: `number`; `crosspostParentId`: `string`; `crowdControlLevel`: `CrowdControlLevel`; `deleted`: `boolean`; `distinguished`: `DistinguishType`; `downvotes`: `number`; `galleryImages`: `string`[]; `gildings`: `number`; `id`: `string`; `ignoreReports`: `boolean`; `isApproved`: `boolean`; `isArchived`: `boolean`; `isClubContent`: `boolean`; `isGallery`: `boolean`; `isImage`: `boolean`; `isLocked`: `boolean`; `isMeta`: `boolean`; `isMultiMedia`: `boolean`; `isPoll`: `boolean`; `isPromoted`: `boolean`; `isSelf`: `boolean`; `isSpoiler`: `boolean`; `isSticky`: `boolean`; `isVideo`: `boolean`; `languageCode`: `string`; `linkFlair`: \{ `backgroundColor`: `string`; `cssClass`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; \}; `media`: \{ `oembed`: \{ `authorName`: `string`; `authorUrl`: `string`; `description`: `string`; `height`: `number`; `html`: `string`; `providerName`: `string`; `providerUrl`: `string`; `thumbnailHeight`: `number`; `thumbnailUrl`: `string`; `thumbnailWidth`: `number`; `title`: `string`; `type`: `string`; `version`: `string`; `width`: `number`; \}; `redditVideo`: \{ `bitrateKbps`: `number`; `dashUrl`: `string`; `duration`: `number`; `fallbackUrl`: `string`; `height`: `number`; `hlsUrl`: `string`; `isGif`: `boolean`; `scrubberMediaUrl`: `string`; `transcodingStatus`: `string`; `width`: `number`; \}; `type`: `string`; \}; `mediaUrls`: `string`[]; `nsfw`: `boolean`; `numComments`: `number`; `numReports`: `number`; `permalink`: `string`; `score`: `number`; `selftext`: `string`; `spam`: `boolean`; `subredditId`: `string`; `thumbnail`: `string`; `title`: `string`; `type`: `string`; `unlisted`: `boolean`; `updatedAt`: `number`; `upvotes`: `number`; `url`: `string`; \} + +###### post.authorFlair? + +\{ `backgroundColor`: `string`; `cssClass`: `string`; `enabled`: `boolean`; `subredditId`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; `userId`: `string`; \} + +###### post.authorFlair.backgroundColor? + +`string` + +###### post.authorFlair.cssClass? + +`string` + +###### post.authorFlair.enabled? + +`boolean` + +###### post.authorFlair.subredditId? + +`string` + +###### post.authorFlair.templateId? + +`string` + +###### post.authorFlair.text? + +`string` + +###### post.authorFlair.textColor? + +`string` + +###### post.authorFlair.userId? + +`string` + +###### post.authorId? + +`string` + +###### post.createdAt? + +`number` + +###### post.crosspostParentId? + +`string` + +###### post.crowdControlLevel? + +`CrowdControlLevel` + +###### post.deleted? + +`boolean` + +###### post.distinguished? + +`DistinguishType` + +###### post.downvotes? + +`number` + +###### post.galleryImages? + +`string`[] + +###### post.gildings? + +`number` + +###### post.id? + +`string` + +###### post.ignoreReports? + +`boolean` + +###### post.isApproved? + +`boolean` + +###### post.isArchived? + +`boolean` + +###### post.isClubContent? + +`boolean` + +###### post.isGallery? + +`boolean` + +###### post.isImage? + +`boolean` + +Indicates if the post contains a single image rather than a gallery of multiple images, which is indicated by the is_gallery field. + +###### post.isLocked? + +`boolean` + +###### post.isMeta? + +`boolean` + +###### post.isMultiMedia? + +`boolean` + +###### post.isPoll? + +`boolean` + +###### post.isPromoted? + +`boolean` + +###### post.isSelf? + +`boolean` + +###### post.isSpoiler? + +`boolean` + +###### post.isSticky? + +`boolean` + +###### post.isVideo? + +`boolean` + +###### post.languageCode? + +`string` + +###### post.linkFlair? + +\{ `backgroundColor`: `string`; `cssClass`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; \} + +###### post.linkFlair.backgroundColor? + +`string` + +###### post.linkFlair.cssClass? + +`string` + +###### post.linkFlair.templateId? + +`string` + +###### post.linkFlair.text? + +`string` + +###### post.linkFlair.textColor? + +`string` + +###### post.media? + +\{ `oembed`: \{ `authorName`: `string`; `authorUrl`: `string`; `description`: `string`; `height`: `number`; `html`: `string`; `providerName`: `string`; `providerUrl`: `string`; `thumbnailHeight`: `number`; `thumbnailUrl`: `string`; `thumbnailWidth`: `number`; `title`: `string`; `type`: `string`; `version`: `string`; `width`: `number`; \}; `redditVideo`: \{ `bitrateKbps`: `number`; `dashUrl`: `string`; `duration`: `number`; `fallbackUrl`: `string`; `height`: `number`; `hlsUrl`: `string`; `isGif`: `boolean`; `scrubberMediaUrl`: `string`; `transcodingStatus`: `string`; `width`: `number`; \}; `type`: `string`; \} + +###### post.media.oembed? + +\{ `authorName`: `string`; `authorUrl`: `string`; `description`: `string`; `height`: `number`; `html`: `string`; `providerName`: `string`; `providerUrl`: `string`; `thumbnailHeight`: `number`; `thumbnailUrl`: `string`; `thumbnailWidth`: `number`; `title`: `string`; `type`: `string`; `version`: `string`; `width`: `number`; \} + +###### post.media.oembed.authorName? + +`string` + +###### post.media.oembed.authorUrl? + +`string` + +###### post.media.oembed.description? + +`string` + +###### post.media.oembed.height? + +`number` + +###### post.media.oembed.html? + +`string` + +###### post.media.oembed.providerName? + +`string` + +###### post.media.oembed.providerUrl? + +`string` + +###### post.media.oembed.thumbnailHeight? + +`number` + +###### post.media.oembed.thumbnailUrl? + +`string` + +###### post.media.oembed.thumbnailWidth? + +`number` + +###### post.media.oembed.title? + +`string` + +###### post.media.oembed.type? + +`string` + +###### post.media.oembed.version? + +`string` + +###### post.media.oembed.width? + +`number` + +###### post.media.redditVideo? + +\{ `bitrateKbps`: `number`; `dashUrl`: `string`; `duration`: `number`; `fallbackUrl`: `string`; `height`: `number`; `hlsUrl`: `string`; `isGif`: `boolean`; `scrubberMediaUrl`: `string`; `transcodingStatus`: `string`; `width`: `number`; \} + +###### post.media.redditVideo.bitrateKbps? + +`number` + +###### post.media.redditVideo.dashUrl? + +`string` + +###### post.media.redditVideo.duration? + +`number` + +###### post.media.redditVideo.fallbackUrl? + +`string` + +###### post.media.redditVideo.height? + +`number` + +###### post.media.redditVideo.hlsUrl? + +`string` + +###### post.media.redditVideo.isGif? + +`boolean` + +###### post.media.redditVideo.scrubberMediaUrl? + +`string` + +###### post.media.redditVideo.transcodingStatus? + +`string` + +###### post.media.redditVideo.width? + +`number` + +###### post.media.type? + +`string` + +###### post.mediaUrls? + +`string`[] + +###### post.nsfw? + +`boolean` + +###### post.numComments? + +`number` + +###### post.numReports? + +`number` + +###### post.permalink? + +`string` + +###### post.score? + +`number` + +###### post.selftext? + +`string` + +rename to text? + +###### post.spam? + +`boolean` + +###### post.subredditId? + +`string` + +###### post.thumbnail? + +`string` + +###### post.title? + +`string` + +###### post.type? + +`string` + +###### post.unlisted? + +`boolean` + +###### post.updatedAt? + +`number` + +###### post.upvotes? + +`number` + +###### post.url? + +`string` + +###### subreddit? + +\{ `description`: `string`; `id`: `string`; `name`: `string`; `nsfw`: `boolean`; `permalink`: `string`; `quarantined`: `boolean`; `rating`: `SubredditRating`; `spam`: `boolean`; `subscribersCount`: `number`; `title`: `string`; `topics`: `string`[]; `type`: `SubredditType`; \} + +###### subreddit.description? + +`string` + +###### subreddit.id? + +`string` + +###### subreddit.name? + +`string` + +###### subreddit.nsfw? + +`boolean` + +###### subreddit.permalink? + +`string` + +###### subreddit.quarantined? + +`boolean` + +###### subreddit.rating? + +`SubredditRating` + +###### subreddit.spam? + +`boolean` + +###### subreddit.subscribersCount? + +`number` + +###### subreddit.title? + +`string` + +###### subreddit.topics? + +`string`[] + +###### subreddit.type? + +`SubredditType` + +#### Returns + +[`MentionInCommentCreate`](../interfaces/MentionInCommentCreate.md) + + + +### decode() + +#### Parameters + +##### input + +`Uint8Array`\<`ArrayBufferLike`\> | `Reader` + +##### length? + +`number` + +#### Returns + +[`MentionInCommentCreate`](../interfaces/MentionInCommentCreate.md) + + + +### encode() + +#### Parameters + +##### message + +[`MentionInCommentCreate`](../interfaces/MentionInCommentCreate.md) + +##### writer? + +`Writer` + +#### Returns + +`Writer` + + + +### fromJSON() + +#### Parameters + +##### object + +`any` + +#### Returns + +[`MentionInCommentCreate`](../interfaces/MentionInCommentCreate.md) + + + +### fromPartial() + +#### Parameters + +##### object + +###### author? + +\{ `banned`: `boolean`; `description`: `string`; `flair`: \{ `backgroundColor`: `string`; `cssClass`: `string`; `enabled`: `boolean`; `subredditId`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; `userId`: `string`; \}; `iconImage`: `string`; `id`: `string`; `isGold`: `boolean`; `karma`: `number`; `name`: `string`; `snoovatarImage`: `string`; `spam`: `boolean`; `suspended`: `boolean`; `url`: `string`; \} + +###### author.banned? + +`boolean` + +###### author.description? + +`string` + +###### author.flair? + +\{ `backgroundColor`: `string`; `cssClass`: `string`; `enabled`: `boolean`; `subredditId`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; `userId`: `string`; \} + +###### author.flair.backgroundColor? + +`string` + +###### author.flair.cssClass? + +`string` + +###### author.flair.enabled? + +`boolean` + +###### author.flair.subredditId? + +`string` + +###### author.flair.templateId? + +`string` + +###### author.flair.text? + +`string` + +###### author.flair.textColor? + +`string` + +###### author.flair.userId? + +`string` + +###### author.iconImage? + +`string` + +###### author.id? + +`string` + +###### author.isGold? + +`boolean` + +###### author.karma? + +`number` + +###### author.name? + +`string` + +###### author.snoovatarImage? + +`string` + +###### author.spam? + +`boolean` + +###### author.suspended? + +`boolean` + +###### author.url? + +`string` + +###### comment? + +\{ `author`: `string`; `body`: `string`; `collapsedBecauseCrowdControl`: `boolean`; `createdAt`: `number`; `deleted`: `boolean`; `downvotes`: `number`; `elementTypes`: `string`[]; `gilded`: `boolean`; `hasMedia`: `boolean`; `id`: `string`; `languageCode`: `string`; `lastModifiedAt`: `number`; `mediaUrls`: `string`[]; `numReports`: `number`; `parentId`: `string`; `permalink`: `string`; `postId`: `string`; `score`: `number`; `spam`: `boolean`; `subredditId`: `string`; `upvotes`: `number`; \} + +###### comment.author? + +`string` + +###### comment.body? + +`string` + +###### comment.collapsedBecauseCrowdControl? + +`boolean` + +###### comment.createdAt? + +`number` + +###### comment.deleted? + +`boolean` + +###### comment.downvotes? + +`number` + +###### comment.elementTypes? + +`string`[] + +###### comment.gilded? + +`boolean` + +###### comment.hasMedia? + +`boolean` + +###### comment.id? + +`string` + +###### comment.languageCode? + +`string` + +###### comment.lastModifiedAt? + +`number` + +###### comment.mediaUrls? + +`string`[] + +###### comment.numReports? + +`number` + +###### comment.parentId? + +`string` + +###### comment.permalink? + +`string` + +###### comment.postId? + +`string` + +###### comment.score? + +`number` + +###### comment.spam? + +`boolean` + +###### comment.subredditId? + +`string` + +###### comment.upvotes? + +`number` + +###### mentions? + +\{ `items`: `object`[]; \} + +###### mentions.items? + +`object`[] + +###### post? + +\{ `authorFlair`: \{ `backgroundColor`: `string`; `cssClass`: `string`; `enabled`: `boolean`; `subredditId`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; `userId`: `string`; \}; `authorId`: `string`; `createdAt`: `number`; `crosspostParentId`: `string`; `crowdControlLevel`: `CrowdControlLevel`; `deleted`: `boolean`; `distinguished`: `DistinguishType`; `downvotes`: `number`; `galleryImages`: `string`[]; `gildings`: `number`; `id`: `string`; `ignoreReports`: `boolean`; `isApproved`: `boolean`; `isArchived`: `boolean`; `isClubContent`: `boolean`; `isGallery`: `boolean`; `isImage`: `boolean`; `isLocked`: `boolean`; `isMeta`: `boolean`; `isMultiMedia`: `boolean`; `isPoll`: `boolean`; `isPromoted`: `boolean`; `isSelf`: `boolean`; `isSpoiler`: `boolean`; `isSticky`: `boolean`; `isVideo`: `boolean`; `languageCode`: `string`; `linkFlair`: \{ `backgroundColor`: `string`; `cssClass`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; \}; `media`: \{ `oembed`: \{ `authorName`: `string`; `authorUrl`: `string`; `description`: `string`; `height`: `number`; `html`: `string`; `providerName`: `string`; `providerUrl`: `string`; `thumbnailHeight`: `number`; `thumbnailUrl`: `string`; `thumbnailWidth`: `number`; `title`: `string`; `type`: `string`; `version`: `string`; `width`: `number`; \}; `redditVideo`: \{ `bitrateKbps`: `number`; `dashUrl`: `string`; `duration`: `number`; `fallbackUrl`: `string`; `height`: `number`; `hlsUrl`: `string`; `isGif`: `boolean`; `scrubberMediaUrl`: `string`; `transcodingStatus`: `string`; `width`: `number`; \}; `type`: `string`; \}; `mediaUrls`: `string`[]; `nsfw`: `boolean`; `numComments`: `number`; `numReports`: `number`; `permalink`: `string`; `score`: `number`; `selftext`: `string`; `spam`: `boolean`; `subredditId`: `string`; `thumbnail`: `string`; `title`: `string`; `type`: `string`; `unlisted`: `boolean`; `updatedAt`: `number`; `upvotes`: `number`; `url`: `string`; \} + +###### post.authorFlair? + +\{ `backgroundColor`: `string`; `cssClass`: `string`; `enabled`: `boolean`; `subredditId`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; `userId`: `string`; \} + +###### post.authorFlair.backgroundColor? + +`string` + +###### post.authorFlair.cssClass? + +`string` + +###### post.authorFlair.enabled? + +`boolean` + +###### post.authorFlair.subredditId? + +`string` + +###### post.authorFlair.templateId? + +`string` + +###### post.authorFlair.text? + +`string` + +###### post.authorFlair.textColor? + +`string` + +###### post.authorFlair.userId? + +`string` + +###### post.authorId? + +`string` + +###### post.createdAt? + +`number` + +###### post.crosspostParentId? + +`string` + +###### post.crowdControlLevel? + +`CrowdControlLevel` + +###### post.deleted? + +`boolean` + +###### post.distinguished? + +`DistinguishType` + +###### post.downvotes? + +`number` + +###### post.galleryImages? + +`string`[] + +###### post.gildings? + +`number` + +###### post.id? + +`string` + +###### post.ignoreReports? + +`boolean` + +###### post.isApproved? + +`boolean` + +###### post.isArchived? + +`boolean` + +###### post.isClubContent? + +`boolean` + +###### post.isGallery? + +`boolean` + +###### post.isImage? + +`boolean` + +Indicates if the post contains a single image rather than a gallery of multiple images, which is indicated by the is_gallery field. + +###### post.isLocked? + +`boolean` + +###### post.isMeta? + +`boolean` + +###### post.isMultiMedia? + +`boolean` + +###### post.isPoll? + +`boolean` + +###### post.isPromoted? + +`boolean` + +###### post.isSelf? + +`boolean` + +###### post.isSpoiler? + +`boolean` + +###### post.isSticky? + +`boolean` + +###### post.isVideo? + +`boolean` + +###### post.languageCode? + +`string` + +###### post.linkFlair? + +\{ `backgroundColor`: `string`; `cssClass`: `string`; `templateId`: `string`; `text`: `string`; `textColor`: `string`; \} + +###### post.linkFlair.backgroundColor? + +`string` + +###### post.linkFlair.cssClass? + +`string` + +###### post.linkFlair.templateId? + +`string` + +###### post.linkFlair.text? + +`string` + +###### post.linkFlair.textColor? + +`string` + +###### post.media? + +\{ `oembed`: \{ `authorName`: `string`; `authorUrl`: `string`; `description`: `string`; `height`: `number`; `html`: `string`; `providerName`: `string`; `providerUrl`: `string`; `thumbnailHeight`: `number`; `thumbnailUrl`: `string`; `thumbnailWidth`: `number`; `title`: `string`; `type`: `string`; `version`: `string`; `width`: `number`; \}; `redditVideo`: \{ `bitrateKbps`: `number`; `dashUrl`: `string`; `duration`: `number`; `fallbackUrl`: `string`; `height`: `number`; `hlsUrl`: `string`; `isGif`: `boolean`; `scrubberMediaUrl`: `string`; `transcodingStatus`: `string`; `width`: `number`; \}; `type`: `string`; \} + +###### post.media.oembed? + +\{ `authorName`: `string`; `authorUrl`: `string`; `description`: `string`; `height`: `number`; `html`: `string`; `providerName`: `string`; `providerUrl`: `string`; `thumbnailHeight`: `number`; `thumbnailUrl`: `string`; `thumbnailWidth`: `number`; `title`: `string`; `type`: `string`; `version`: `string`; `width`: `number`; \} + +###### post.media.oembed.authorName? + +`string` + +###### post.media.oembed.authorUrl? + +`string` + +###### post.media.oembed.description? + +`string` + +###### post.media.oembed.height? + +`number` + +###### post.media.oembed.html? + +`string` + +###### post.media.oembed.providerName? + +`string` + +###### post.media.oembed.providerUrl? + +`string` + +###### post.media.oembed.thumbnailHeight? + +`number` + +###### post.media.oembed.thumbnailUrl? + +`string` + +###### post.media.oembed.thumbnailWidth? + +`number` + +###### post.media.oembed.title? + +`string` + +###### post.media.oembed.type? + +`string` + +###### post.media.oembed.version? + +`string` + +###### post.media.oembed.width? + +`number` + +###### post.media.redditVideo? + +\{ `bitrateKbps`: `number`; `dashUrl`: `string`; `duration`: `number`; `fallbackUrl`: `string`; `height`: `number`; `hlsUrl`: `string`; `isGif`: `boolean`; `scrubberMediaUrl`: `string`; `transcodingStatus`: `string`; `width`: `number`; \} + +###### post.media.redditVideo.bitrateKbps? + +`number` + +###### post.media.redditVideo.dashUrl? + +`string` + +###### post.media.redditVideo.duration? + +`number` + +###### post.media.redditVideo.fallbackUrl? + +`string` + +###### post.media.redditVideo.height? + +`number` + +###### post.media.redditVideo.hlsUrl? + +`string` + +###### post.media.redditVideo.isGif? + +`boolean` + +###### post.media.redditVideo.scrubberMediaUrl? + +`string` + +###### post.media.redditVideo.transcodingStatus? + +`string` + +###### post.media.redditVideo.width? + +`number` + +###### post.media.type? + +`string` + +###### post.mediaUrls? + +`string`[] + +###### post.nsfw? + +`boolean` + +###### post.numComments? + +`number` + +###### post.numReports? + +`number` + +###### post.permalink? + +`string` + +###### post.score? + +`number` + +###### post.selftext? + +`string` + +rename to text? + +###### post.spam? + +`boolean` + +###### post.subredditId? + +`string` + +###### post.thumbnail? + +`string` + +###### post.title? + +`string` + +###### post.type? + +`string` + +###### post.unlisted? + +`boolean` + +###### post.updatedAt? + +`number` + +###### post.upvotes? + +`number` + +###### post.url? + +`string` + +###### subreddit? + +\{ `description`: `string`; `id`: `string`; `name`: `string`; `nsfw`: `boolean`; `permalink`: `string`; `quarantined`: `boolean`; `rating`: `SubredditRating`; `spam`: `boolean`; `subscribersCount`: `number`; `title`: `string`; `topics`: `string`[]; `type`: `SubredditType`; \} + +###### subreddit.description? + +`string` + +###### subreddit.id? + +`string` + +###### subreddit.name? + +`string` + +###### subreddit.nsfw? + +`boolean` + +###### subreddit.permalink? + +`string` + +###### subreddit.quarantined? + +`boolean` + +###### subreddit.rating? + +`SubredditRating` + +###### subreddit.spam? + +`boolean` + +###### subreddit.subscribersCount? + +`number` + +###### subreddit.title? + +`string` + +###### subreddit.topics? + +`string`[] + +###### subreddit.type? + +`SubredditType` + +#### Returns + +[`MentionInCommentCreate`](../interfaces/MentionInCommentCreate.md) + + + +### toJSON() + +#### Parameters + +##### message + +[`MentionInCommentCreate`](../interfaces/MentionInCommentCreate.md) + +#### Returns + +`unknown` 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 798fe972..a07c4bde 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -460,7 +460,7 @@ rename to text? ###### source? -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ###### subreddit? @@ -1014,7 +1014,7 @@ rename to text? ###### source? -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ###### subreddit? 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 07a8ac27..c4dcf59a 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 d3a90bad..f7fe63a5 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** @@ -120,11 +120,11 @@ ###### reason? -[`DeletionReason`](../../../../enumerations/DeletionReason.md) +[`DeletionReason`](../enumerations/DeletionReason.md) ###### source? -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ###### subreddit? @@ -338,11 +338,11 @@ ###### reason? -[`DeletionReason`](../../../../enumerations/DeletionReason.md) +[`DeletionReason`](../enumerations/DeletionReason.md) ###### source? -[`EventSource`](../../../../enumerations/EventSource.md) +[`EventSource`](../enumerations/EventSource.md) ###### subreddit? 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 af02c9e6..9d086a56 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 2581d61b..31044441 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 246ce6a2..97d2267f 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 840742e0..7d8e9f47 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 16f502e3..03570a2a 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 a2a18685..a1509107 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 8bc90082..0eed423c 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-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 ec6d5c31..e5c6f035 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.12.25-dev**](../../../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../../../README.md) *** diff --git a/docs/api/public-api/README.md b/docs/api/public-api/README.md index 55a6f7af..11c36ed7 100644 --- a/docs/api/public-api/README.md +++ b/docs/api/public-api/README.md @@ -1,8 +1,8 @@ -**@devvit/public-api v0.12.25-dev** +**@devvit/public-api v0.13.1-dev** *** -# @devvit/public-api v0.12.25-dev +# @devvit/public-api v0.13.1-dev ## Namespaces @@ -22,19 +22,15 @@ ## Type Aliases -- [AllIconName](type-aliases/AllIconName.md) - [AppInstall](type-aliases/AppInstall.md) - [AppInstallDefinition](type-aliases/AppInstallDefinition.md) - [AppUpgrade](type-aliases/AppUpgrade.md) - [AppUpgradeDefinition](type-aliases/AppUpgradeDefinition.md) -- [AsyncError](type-aliases/AsyncError.md) -- [AsyncUseStateInitializer](type-aliases/AsyncUseStateInitializer.md) - [AutomoderatorFilterComment](type-aliases/AutomoderatorFilterComment.md) - [AutomoderatorFilterPost](type-aliases/AutomoderatorFilterPost.md) - [BaseContext](type-aliases/BaseContext.md) - [BaseField](type-aliases/BaseField.md) - [BitfieldCommand](type-aliases/BitfieldCommand.md) -- [BlockElement](type-aliases/BlockElement.md) - [BooleanField](type-aliases/BooleanField.md) - [CancelJob](type-aliases/CancelJob.md) - [CommentCreate](type-aliases/CommentCreate.md) @@ -51,7 +47,6 @@ - [Context](type-aliases/Context.md) - [ContextAPIClients](type-aliases/ContextAPIClients.md) - [ContextDebugInfo](type-aliases/ContextDebugInfo.md) -- [CustomPostType](type-aliases/CustomPostType.md) - [~~Data~~](type-aliases/Data.md) - [DevvitDebug](type-aliases/DevvitDebug.md) - [Dispatch](type-aliases/Dispatch.md) @@ -65,14 +60,12 @@ - [FormOnSubmitEventHandler](type-aliases/FormOnSubmitEventHandler.md) - [FormToFormValues](type-aliases/FormToFormValues.md) - [FormValues](type-aliases/FormValues.md) -- [IconName](type-aliases/IconName.md) - [ImageField](type-aliases/ImageField.md) - [JobContext](type-aliases/JobContext.md) - [JSONArray](type-aliases/JSONArray.md) - [JSONObject](type-aliases/JSONObject.md) - [JSONPrimitive](type-aliases/JSONPrimitive.md) - [JSONValue](type-aliases/JSONValue.md) -- [KVStore](type-aliases/KVStore.md) - [MediaAsset](type-aliases/MediaAsset.md) - [MediaPlugin](type-aliases/MediaPlugin.md) - [MenuItem](type-aliases/MenuItem.md) @@ -125,14 +118,12 @@ - [Scheduler](type-aliases/Scheduler.md) - [SelectField](type-aliases/SelectField.md) - [SetOptions](type-aliases/SetOptions.md) -- [SetStateAction](type-aliases/SetStateAction.md) - [SettingsClient](type-aliases/SettingsClient.md) - [SettingScopeType](type-aliases/SettingScopeType.md) - [SettingsFormField](type-aliases/SettingsFormField.md) - [SettingsFormFieldGroup](type-aliases/SettingsFormFieldGroup.md) - [SettingsFormFieldValidatorEvent](type-aliases/SettingsFormFieldValidatorEvent.md) - [SettingsValues](type-aliases/SettingsValues.md) -- [StateSetter](type-aliases/StateSetter.md) - [StringField](type-aliases/StringField.md) - [Toast](type-aliases/Toast.md) - [TriggerContext](type-aliases/TriggerContext.md) @@ -143,18 +134,6 @@ - [TxClientLike](type-aliases/TxClientLike.md) - [UIClient](type-aliases/UIClient.md) - [UploadMediaOptions](type-aliases/UploadMediaOptions.md) -- [UseAsyncResult](type-aliases/UseAsyncResult.md) -- [UseChannelHook](type-aliases/UseChannelHook.md) -- [UseChannelResult](type-aliases/UseChannelResult.md) -- [UseFormHook](type-aliases/UseFormHook.md) -- [UseIntervalHook](type-aliases/UseIntervalHook.md) -- [UseIntervalResult](type-aliases/UseIntervalResult.md) -- [UseStateHook](type-aliases/UseStateHook.md) -- [UseStateInitializer](type-aliases/UseStateInitializer.md) -- [UseStateResult](type-aliases/UseStateResult.md) -- [UseWebViewOnMessage](type-aliases/UseWebViewOnMessage.md) -- [UseWebViewOptions](type-aliases/UseWebViewOptions.md) -- [UseWebViewResult](type-aliases/UseWebViewResult.md) - [ValidatedBooleanField](type-aliases/ValidatedBooleanField.md) - [ValidatedFormField](type-aliases/ValidatedFormField.md) - [ValidatedNumberField](type-aliases/ValidatedNumberField.md) @@ -164,18 +143,3 @@ - [ZMember](type-aliases/ZMember.md) - [ZRangeByScoreOptions](type-aliases/ZRangeByScoreOptions.md) - [ZRangeOptions](type-aliases/ZRangeOptions.md) - -## Variables - -- [ALL\_ICON\_NAMES](variables/ALL_ICON_NAMES.md) - -## Functions - -- [fetchDevvitWeb](functions/fetchDevvitWeb.md) -- [svg](functions/svg.md) -- [useAsync](functions/useAsync.md) -- [useChannel](functions/useChannel.md) -- [useForm](functions/useForm.md) -- [useInterval](functions/useInterval.md) -- [useState](functions/useState.md) -- [useWebView](functions/useWebView.md) diff --git a/docs/api/public-api/classes/Devvit.md b/docs/api/public-api/classes/Devvit.md index 103153de..c94c0d42 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** @@ -18,53 +18,6 @@ ## Methods - - -### ~~addCustomPostType()~~ - -> `static` **addCustomPostType**(`customPostType`): `void` - -#### Parameters - -##### customPostType - -[`CustomPostType`](../type-aliases/CustomPostType.md) - -The custom post type to add. - -#### Returns - -`void` - -#### Deprecated - -Blocks is deprecated. Use [Web](https://developers.reddit.com/docs/capabilities/devvit-web/devvit_web_overview|Devvit) instead - -Add a custom post type for your app. - -#### Example - -```ts -import { Devvit, useState } from '@devvit/public-api'; - -Devvit.addCustomPostType({ - name: 'Counter', - description: 'A simple click counter post.', - render: (context) => { - const [counter, setCounter] = useState(); - - return ( - - {counter} - - - ); - }, -}); -``` - -*** - ### addMenuItem() @@ -79,6 +32,8 @@ Add a menu item to the Reddit UI. [`MenuItem`](../type-aliases/MenuItem.md) +The menu item to add. + #### Returns `void` @@ -262,14 +217,20 @@ occurs in a subreddit where the app is installed. ###### definition +The trigger definition. + ###### event `T` +The event to listen for. + ###### onEvent [`TriggerOnEventHandler`](../type-aliases/TriggerOnEventHandler.md)\<[`TriggerEventType`](../type-aliases/TriggerEventType.md)\[`T`\]\> +The function to call when the event happens. + ##### Returns *typeof* [`Devvit`](../@devvit/namespaces/Devvit/README.md) @@ -315,8 +276,6 @@ occurs in a subreddit where the app is installed. [`MultiTriggerDefinition`](../type-aliases/MultiTriggerDefinition.md)\<`Event`\> -The trigger definition. - ##### Returns *typeof* [`Devvit`](../@devvit/namespaces/Devvit/README.md) @@ -384,7 +343,7 @@ Devvit.configure({ > `static` **createForm**\<`T`\>(`form`, `onSubmit`): [`FormKey`](../type-aliases/FormKey.md) -Create a form that can be opened from menu items and custom posts. +Create a form that can be opened from menu items. #### Type Parameters diff --git a/docs/api/public-api/classes/RichTextBuilder.md b/docs/api/public-api/classes/RichTextBuilder.md index 042bd203..5222b76e 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/DeletionReason.md b/docs/api/public-api/enumerations/DeletionReason.md index 2aa1c6cd..d3e99ea9 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/EventSource.md b/docs/api/public-api/enumerations/EventSource.md index a16426ec..4cf2513a 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/enumerations/SettingScope.md b/docs/api/public-api/enumerations/SettingScope.md index 96455d35..801de527 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/functions/fetchDevvitWeb.md b/docs/api/public-api/functions/fetchDevvitWeb.md deleted file mode 100644 index 8954d3a2..00000000 --- a/docs/api/public-api/functions/fetchDevvitWeb.md +++ /dev/null @@ -1,36 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Function: fetchDevvitWeb() - -> **fetchDevvitWeb**(`ctx`, `endpoint`, `init`?): `Promise`\<`Response`\> - -Makes a fetch request to the devvit web backend server from your block app -This is a migration tool to help you migrate your block app to the new Devvit Web architecture. - -## Parameters - -### ctx - -[`BaseContext`](../type-aliases/BaseContext.md) - -the devvit context - -### endpoint - -`string` - -the endpoint to make the request to - -### init? - -`RequestInit` - -the request init options - -## Returns - -`Promise`\<`Response`\> - -a promise that resolves to the fetch response diff --git a/docs/api/public-api/functions/svg.md b/docs/api/public-api/functions/svg.md deleted file mode 100644 index 1c98dce6..00000000 --- a/docs/api/public-api/functions/svg.md +++ /dev/null @@ -1,45 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Function: svg() - -> **svg**(`strings`, ...`args`): `""` \| `` `data:image/svg+xml;charset=UTF-8,${string}` `` - -**`Experimental`** - -A helper to allow SVG functionality within image tags. - -## Parameters - -### strings - -`TemplateStringsArray` - -### args - -...(`string` \| `number`)[] - -## Returns - -`""` \| `` `data:image/svg+xml;charset=UTF-8,${string}` `` - -## Example - -```ts -import { Devvit, svg } from '@devvit/public-api'; -const App = () => { - const color = 'gold' - return ( - - - - `} - imageHeight={100} - imageWidth={100} - /> - - ) -} -``` diff --git a/docs/api/public-api/functions/useAsync.md b/docs/api/public-api/functions/useAsync.md deleted file mode 100644 index 33fb2cb7..00000000 --- a/docs/api/public-api/functions/useAsync.md +++ /dev/null @@ -1,33 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Function: useAsync() - -> **useAsync**\<`S`\>(`initializer`, `options`): [`UseAsyncResult`](../type-aliases/UseAsyncResult.md)\<`S`\> - -This is the preferred way to handle async state in Devvit. - -## Type Parameters - -### S - -`S` *extends* [`JSONValue`](../type-aliases/JSONValue.md) - -## Parameters - -### initializer - -[`AsyncUseStateInitializer`](../type-aliases/AsyncUseStateInitializer.md)\<`S`\> - -any async function that returns a JSONValue - -### options - -`AsyncOptions`\<`S`\> = `{}` - -## Returns - -[`UseAsyncResult`](../type-aliases/UseAsyncResult.md)\<`S`\> - -UseAsyncResult diff --git a/docs/api/public-api/functions/useChannel.md b/docs/api/public-api/functions/useChannel.md deleted file mode 100644 index 46b7af02..00000000 --- a/docs/api/public-api/functions/useChannel.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Function: useChannel() - -> **useChannel**\<`Message`\>(`opts`): [`UseChannelResult`](../type-aliases/UseChannelResult.md)\<`Message`\> - -## Type Parameters - -### Message - -`Message` *extends* [`JSONValue`](../type-aliases/JSONValue.md) - -## Parameters - -### opts - -`Readonly`\<`ChannelOptions`\<`Message`\>\> - -## Returns - -[`UseChannelResult`](../type-aliases/UseChannelResult.md)\<`Message`\> diff --git a/docs/api/public-api/functions/useForm.md b/docs/api/public-api/functions/useForm.md deleted file mode 100644 index c3c0e7b5..00000000 --- a/docs/api/public-api/functions/useForm.md +++ /dev/null @@ -1,27 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Function: useForm() - -> **useForm**\<`T`\>(`form`, `onSubmit`): [`FormKey`](../type-aliases/FormKey.md) - -## Type Parameters - -### T - -`T` *extends* [`Form`](../type-aliases/Form.md) \| [`FormFunction`](../type-aliases/FormFunction.md) - -## Parameters - -### form - -`T` - -### onSubmit - -(`values`) => `void` \| `Promise`\<`void`\> - -## Returns - -[`FormKey`](../type-aliases/FormKey.md) diff --git a/docs/api/public-api/functions/useInterval.md b/docs/api/public-api/functions/useInterval.md deleted file mode 100644 index b26fc795..00000000 --- a/docs/api/public-api/functions/useInterval.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Function: useInterval() - -> **useInterval**(`callback`, `requestedDelayMs`): [`UseIntervalResult`](../type-aliases/UseIntervalResult.md) - -## Parameters - -### callback - -() => `void` \| `Promise`\<`void`\> - -### requestedDelayMs - -`number` - -## Returns - -[`UseIntervalResult`](../type-aliases/UseIntervalResult.md) diff --git a/docs/api/public-api/functions/useState.md b/docs/api/public-api/functions/useState.md deleted file mode 100644 index daeb133f..00000000 --- a/docs/api/public-api/functions/useState.md +++ /dev/null @@ -1,67 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Function: useState() - -## Call Signature - -> **useState**(`initialState`): [`UseStateResult`](../type-aliases/UseStateResult.md)\<`boolean`\> - -### Parameters - -#### initialState - -[`UseStateInitializer`](../type-aliases/UseStateInitializer.md)\<`boolean`\> - -### Returns - -[`UseStateResult`](../type-aliases/UseStateResult.md)\<`boolean`\> - -## Call Signature - -> **useState**(`initialState`): [`UseStateResult`](../type-aliases/UseStateResult.md)\<`number`\> - -### Parameters - -#### initialState - -[`UseStateInitializer`](../type-aliases/UseStateInitializer.md)\<`number`\> - -### Returns - -[`UseStateResult`](../type-aliases/UseStateResult.md)\<`number`\> - -## Call Signature - -> **useState**(`initialState`): [`UseStateResult`](../type-aliases/UseStateResult.md)\<`string`\> - -### Parameters - -#### initialState - -[`UseStateInitializer`](../type-aliases/UseStateInitializer.md)\<`string`\> - -### Returns - -[`UseStateResult`](../type-aliases/UseStateResult.md)\<`string`\> - -## Call Signature - -> **useState**\<`S`\>(`initialState`): [`UseStateResult`](../type-aliases/UseStateResult.md)\<`S`\> - -### Type Parameters - -#### S - -`S` *extends* [`JSONValue`](../type-aliases/JSONValue.md) - -### Parameters - -#### initialState - -[`UseStateInitializer`](../type-aliases/UseStateInitializer.md)\<`S`\> - -### Returns - -[`UseStateResult`](../type-aliases/UseStateResult.md)\<`S`\> diff --git a/docs/api/public-api/functions/useWebView.md b/docs/api/public-api/functions/useWebView.md deleted file mode 100644 index 5c577d00..00000000 --- a/docs/api/public-api/functions/useWebView.md +++ /dev/null @@ -1,29 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Function: useWebView() - -> **useWebView**\<`From`, `To`\>(`options`): [`UseWebViewResult`](../type-aliases/UseWebViewResult.md)\<`To`\> - -Use this hook to handle a web view's visibility state and any messages sent to your app. - -## Type Parameters - -### From - -`From` *extends* [`JSONValue`](../type-aliases/JSONValue.md) = [`JSONValue`](../type-aliases/JSONValue.md) - -### To - -`To` *extends* [`JSONValue`](../type-aliases/JSONValue.md) = [`JSONValue`](../type-aliases/JSONValue.md) - -## Parameters - -### options - -[`UseWebViewOptions`](../type-aliases/UseWebViewOptions.md)\<`From`, `To`\> - -## Returns - -[`UseWebViewResult`](../type-aliases/UseWebViewResult.md)\<`To`\> diff --git a/docs/api/public-api/type-aliases/AllIconName.md b/docs/api/public-api/type-aliases/AllIconName.md deleted file mode 100644 index 44ec9cb9..00000000 --- a/docs/api/public-api/type-aliases/AllIconName.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: AllIconName - -> **AllIconName** = *typeof* [`ALL_ICON_NAMES`](../variables/ALL_ICON_NAMES.md)\[`number`\] diff --git a/docs/api/public-api/type-aliases/AppInstall.md b/docs/api/public-api/type-aliases/AppInstall.md index 8a6953ed..3a9d0adb 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AppInstallDefinition.md b/docs/api/public-api/type-aliases/AppInstallDefinition.md index 2e69a8d8..cdb5599a 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AppUpgrade.md b/docs/api/public-api/type-aliases/AppUpgrade.md index 9b557cf4..6068bd2c 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AppUpgradeDefinition.md b/docs/api/public-api/type-aliases/AppUpgradeDefinition.md index 8d61d1b2..b206cb54 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AsyncError.md b/docs/api/public-api/type-aliases/AsyncError.md deleted file mode 100644 index 4873dd55..00000000 --- a/docs/api/public-api/type-aliases/AsyncError.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: AsyncError - -> **AsyncError** = `object` - -## Properties - - - -### details - -> **details**: `string` \| `null` - -*** - - - -### message - -> **message**: `string` diff --git a/docs/api/public-api/type-aliases/AsyncUseStateInitializer.md b/docs/api/public-api/type-aliases/AsyncUseStateInitializer.md deleted file mode 100644 index fb773716..00000000 --- a/docs/api/public-api/type-aliases/AsyncUseStateInitializer.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: AsyncUseStateInitializer()\ - -> **AsyncUseStateInitializer**\<`S`\> = () => `Promise`\<`S`\> - -## Type Parameters - -### S - -`S` - -## Returns - -`Promise`\<`S`\> diff --git a/docs/api/public-api/type-aliases/AutomoderatorFilterComment.md b/docs/api/public-api/type-aliases/AutomoderatorFilterComment.md index 980e8fca..c21e75b6 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/AutomoderatorFilterPost.md b/docs/api/public-api/type-aliases/AutomoderatorFilterPost.md index 87e9daa7..b8079b9d 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BaseContext.md b/docs/api/public-api/type-aliases/BaseContext.md index f9ca849e..fade8dc8 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BaseField.md b/docs/api/public-api/type-aliases/BaseField.md index 2a97684b..b0e81e2a 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BitfieldCommand.md b/docs/api/public-api/type-aliases/BitfieldCommand.md index 3662bda3..fdf012ec 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/BlockElement.md b/docs/api/public-api/type-aliases/BlockElement.md deleted file mode 100644 index eb68f638..00000000 --- a/docs/api/public-api/type-aliases/BlockElement.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: BlockElement - -> **BlockElement** = `object` - -## Properties - - - -### children - -> **children**: `JSX.Element`[] - -*** - - - -### props - -> **props**: \{\} \| `undefined` - -*** - - - -### type - -> **type**: `JSX.ComponentFunction` \| `string` \| `undefined` diff --git a/docs/api/public-api/type-aliases/BooleanField.md b/docs/api/public-api/type-aliases/BooleanField.md index f4da40b3..4beddf8b 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CancelJob.md b/docs/api/public-api/type-aliases/CancelJob.md index 647ec29a..a0a66c64 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentCreate.md b/docs/api/public-api/type-aliases/CommentCreate.md index e23a4f18..9b69a08b 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentCreateDefinition.md b/docs/api/public-api/type-aliases/CommentCreateDefinition.md index 342ba6da..f3699027 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentDelete.md b/docs/api/public-api/type-aliases/CommentDelete.md index 0ff66e39..a66040eb 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentDeleteDefinition.md b/docs/api/public-api/type-aliases/CommentDeleteDefinition.md index 4ed944a4..f6f920c3 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentReport.md b/docs/api/public-api/type-aliases/CommentReport.md index 674b3a0a..5077be2f 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentReportDefinition.md b/docs/api/public-api/type-aliases/CommentReportDefinition.md index 2a9e917c..3655075a 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentSubmit.md b/docs/api/public-api/type-aliases/CommentSubmit.md index 54d66792..f0401e81 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentSubmitDefinition.md b/docs/api/public-api/type-aliases/CommentSubmitDefinition.md index 4ff43fab..aaf903e1 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentUpdate.md b/docs/api/public-api/type-aliases/CommentUpdate.md index 119324a5..95b39e81 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/CommentUpdateDefinition.md b/docs/api/public-api/type-aliases/CommentUpdateDefinition.md index be797e69..1deff272 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Configuration.md b/docs/api/public-api/type-aliases/Configuration.md index 6f2d409e..087bb616 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** @@ -28,16 +28,6 @@ Allows your app to use the HTTP/Fetch API *** - - -### kvStore? - -> `optional` **kvStore**: [`PluginSettings`](PluginSettings.md) \| `boolean` - -Allows your app to use the Key-Value Store - -*** - ### media? @@ -48,16 +38,6 @@ Allows media uploads from apps *** - - -### realtime? - -> `optional` **realtime**: [`PluginSettings`](PluginSettings.md) \| `boolean` - -Allows your app to use the Realtime Plugin - -*** - ### redditAPI? diff --git a/docs/api/public-api/type-aliases/Context.md b/docs/api/public-api/type-aliases/Context.md index 475dd996..d244a1c2 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ContextAPIClients.md b/docs/api/public-api/type-aliases/ContextAPIClients.md index a6056fb1..7ba9acb9 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** @@ -54,29 +54,6 @@ let component = (context) => { *** - - -### dimensions? - -> `optional` **dimensions**: `UIDimensions` - -**`Experimental`** - -Information about about a custom post's layout. Will be undefined -for non custom post surface areas such as menu items and task schedulers. - -*** - - - -### kvStore - -> **kvStore**: [`KVStore`](KVStore.md) - -A client for the Key Value Store - -*** - ### media @@ -87,16 +64,6 @@ A client for media API *** - - -### realtime - -> **realtime**: `RealtimeClient` - -A client for Realtime API - -*** - ### reddit @@ -144,307 +111,3 @@ A client for the Settings API > **ui**: [`UIClient`](UIClient.md) A client for the User Interface API - -*** - - - -### uiEnvironment? - -> `optional` **uiEnvironment**: `UIEnvironment` - -**`Experimental`** - -Additional information about client environment. -Will be undefined for non-ui contexts such as task schedulers or triggers. - -*** - - - -### ~~useChannel()~~ - -> **useChannel**: \<`Message`\>(`options`) => [`UseChannelResult`](UseChannelResult.md)\<`Message`\> - -A hook for managing a realtime pubsub channel between Block renders. -This is only available within a Block Component. - -#### Type Parameters - -##### Message - -`Message` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -#### Parameters - -##### options - -`ChannelOptions`\<`Message`\> - -#### Returns - -[`UseChannelResult`](UseChannelResult.md)\<`Message`\> - -#### Deprecated - -Using hooks from context is deprecated and will be removed in a future release. Import and use hooks directly from the public-api. -```ts -// Old: -const channel = context.useChannel(...); - -// New: -import { useChannel } from '@devvit/public-api' - -const channel = useChannel(...); -``` - -*** - - - -### ~~useForm()~~ - -> **useForm**: \<`T`\>(`form`, `onSubmit`) => [`FormKey`](FormKey.md) - -A hook for managing a form between Block renders. -This is only available within a Block Component. - -#### Type Parameters - -##### T - -`T` *extends* [`Form`](Form.md) \| [`FormFunction`](FormFunction.md) = [`Form`](Form.md) \| [`FormFunction`](FormFunction.md) - -#### Parameters - -##### form - -`T` - -##### onSubmit - -(`values`) => `void` \| `Promise`\<`void`\> - -#### Returns - -[`FormKey`](FormKey.md) - -#### Deprecated - -Using hooks from context is deprecated and will be removed in a future release. Import and use hooks directly from the public-api. -```ts -// Old: -const myForm = context.useForm(...); - -// New: -import { useForm } from '@devvit/public-api' - -const myForm = useForm(...); -``` - -*** - - - -### ~~useInterval~~ - -> **useInterval**: [`UseIntervalHook`](UseIntervalHook.md) - -A hook for managing a callback that runs on an interval between Block renders. -This is only available within a Block Component. - -#### Deprecated - -Using hooks from context is deprecated and will be removed in a future release. Import and use hooks directly from the public-api. -```ts -// Old: -const interval = context.useInterval(() => {}, 1000); - -// New: -import { useInterval } from '@devvit/public-api' - -const interval = useInterval(() => {}, 1000); -``` - -## Methods - - - -### ~~useState()~~ - -#### Call Signature - -> **useState**(`initialState`): [`UseStateResult`](UseStateResult.md)\<`boolean`\> - -A hook for managing a state between Block renders. This is only available -within a Block Component. Returns a tuple containing the current state and -a function to update it. - -```ts -const [counter, setCounter] = useState(0); -setCounter(1); // counter = 1 -setCounter((count) => count + 1) // counter = 2 -``` - -##### Parameters - -###### initialState - -`boolean` | () => `boolean` \| `Promise`\<`boolean`\> - -##### Returns - -[`UseStateResult`](UseStateResult.md)\<`boolean`\> - -##### Deprecated - -Using hooks from context is deprecated and will be removed in a future release. Import and use hooks directly from the public-api. -```ts -// Old: -const [counter, setCounter] = context.useState(0); - -// New: -import { useState } from '@devvit/public-api' - -const [counter, setCounter] = useState(0); -``` - -#### Call Signature - -> **useState**(`initialState`): [`UseStateResult`](UseStateResult.md)\<`number`\> - -A hook for managing a state between Block renders. This is only available -within a Block Component. Returns a tuple containing the current state and -a function to update it. - -```ts -const [counter, setCounter] = useState(0); -setCounter(1); // counter = 1 -setCounter((count) => count + 1) // counter = 2 -``` - -##### Parameters - -###### initialState - -`number` | () => `number` \| `Promise`\<`number`\> - -##### Returns - -[`UseStateResult`](UseStateResult.md)\<`number`\> - -##### Deprecated - -Using hooks from context is deprecated and will be removed in a future release. Import and use hooks directly from the public-api. -```ts -// Old: -const [counter, setCounter] = context.useState(0); - -// New: -import { useState } from '@devvit/public-api' - -const [counter, setCounter] = useState(0); -``` - -#### Call Signature - -> **useState**(`initialState`): [`UseStateResult`](UseStateResult.md)\<`string`\> - -A hook for managing a state between Block renders. This is only available -within a Block Component. Returns a tuple containing the current state and -a function to update it. - -```ts -const [counter, setCounter] = useState(0); -setCounter(1); // counter = 1 -setCounter((count) => count + 1) // counter = 2 -``` - -##### Parameters - -###### initialState - -`string` | () => `string` \| `Promise`\<`string`\> - -##### Returns - -[`UseStateResult`](UseStateResult.md)\<`string`\> - -##### Deprecated - -Using hooks from context is deprecated and will be removed in a future release. Import and use hooks directly from the public-api. -```ts -// Old: -const [counter, setCounter] = context.useState(0); - -// New: -import { useState } from '@devvit/public-api' - -const [counter, setCounter] = useState(0); -``` - -#### Call Signature - -> **useState**\<`S`\>(`initialState`): [`UseStateResult`](UseStateResult.md)\<`S`\> - -A hook for managing a state between Block renders. This is only available -within a Block Component. Returns a tuple containing the current state and -a function to update it. - -```ts -const [counter, setCounter] = useState(0); -setCounter(1); // counter = 1 -setCounter((count) => count + 1) // counter = 2 -``` - -##### Type Parameters - -###### S - -`S` *extends* `undefined` \| `void` \| [`JSONValue`](JSONValue.md) - -##### Parameters - -###### initialState - -A hook for managing a state between Block renders. This is only available -within a Block Component. Returns a tuple containing the current state and -a function to update it. - -```ts -const [counter, setCounter] = useState(0); -setCounter(1); // counter = 1 -setCounter((count) => count + 1) // counter = 2 -``` - -**Deprecated** - -Using hooks from context is deprecated and will be removed in a future release. Import and use hooks directly from the public-api. -```ts -// Old: -const [counter, setCounter] = context.useState(0); - -// New: -import { useState } from '@devvit/public-api' - -const [counter, setCounter] = useState(0); -``` - -`S` | () => `S` \| `Promise`\<`S`\> - -##### Returns - -[`UseStateResult`](UseStateResult.md)\<`S`\> - -##### Deprecated - -Using hooks from context is deprecated and will be removed in a future release. Import and use hooks directly from the public-api. -```ts -// Old: -const [counter, setCounter] = context.useState(0); - -// New: -import { useState } from '@devvit/public-api' - -const [counter, setCounter] = useState(0); -``` diff --git a/docs/api/public-api/type-aliases/ContextDebugInfo.md b/docs/api/public-api/type-aliases/ContextDebugInfo.md index 91c56d6d..484551d9 100644 --- a/docs/api/public-api/type-aliases/ContextDebugInfo.md +++ b/docs/api/public-api/type-aliases/ContextDebugInfo.md @@ -1,21 +1,7 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** # Type Alias: ContextDebugInfo -> **ContextDebugInfo** = `object` & `{ [key in AppDebug]?: string }` - -## Type declaration - -### effects? - -> `optional` **effects**: `EffectEmitter` - -### ~~metadata~~ - -> **metadata**: [`Metadata`](Metadata.md) - -#### Deprecated - -Use Context.metadata. +> **ContextDebugInfo** = `{ [key in AppDebug]?: string }` diff --git a/docs/api/public-api/type-aliases/CustomPostType.md b/docs/api/public-api/type-aliases/CustomPostType.md deleted file mode 100644 index 9fcce576..00000000 --- a/docs/api/public-api/type-aliases/CustomPostType.md +++ /dev/null @@ -1,47 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: CustomPostType - -> **CustomPostType** = `object` - -## Properties - - - -### description? - -> `optional` **description**: `string` - -A description of the custom post type - -*** - - - -### height? - -> `optional` **height**: [`RootHeight`](../@devvit/namespaces/Devvit/namespaces/Blocks/type-aliases/RootHeight.md) - -The fixed height of the post, defaults to 'regular' - -*** - - - -### name - -> **name**: `string` - -The name of the custom post type - -*** - - - -### render - -> **render**: [`CustomPostComponent`](../@devvit/namespaces/Devvit/type-aliases/CustomPostComponent.md) - -A function component that renders the custom post diff --git a/docs/api/public-api/type-aliases/Data.md b/docs/api/public-api/type-aliases/Data.md index 67802e22..7bb2916e 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/DevvitDebug.md b/docs/api/public-api/type-aliases/DevvitDebug.md index 221da99c..c7c3ace9 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Dispatch.md b/docs/api/public-api/type-aliases/Dispatch.md index c9e6e655..f64d8a46 100644 --- a/docs/api/public-api/type-aliases/Dispatch.md +++ b/docs/api/public-api/type-aliases/Dispatch.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Form.md b/docs/api/public-api/type-aliases/Form.md index 7b4a188d..aae0f362 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormDefinition.md b/docs/api/public-api/type-aliases/FormDefinition.md index 238112a0..8eb87c2f 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormField.md b/docs/api/public-api/type-aliases/FormField.md index 7c7e14b6..b9927b93 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormFieldGroup.md b/docs/api/public-api/type-aliases/FormFieldGroup.md index ad61bd68..c555971c 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormFunction.md b/docs/api/public-api/type-aliases/FormFunction.md index c130a365..bd06b9bc 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormKey.md b/docs/api/public-api/type-aliases/FormKey.md index 159a4872..1edd2db2 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormOnSubmitEvent.md b/docs/api/public-api/type-aliases/FormOnSubmitEvent.md index c6e7f43c..fe2adae5 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormOnSubmitEventHandler.md b/docs/api/public-api/type-aliases/FormOnSubmitEventHandler.md index 977f7e09..f30b0d81 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormToFormValues.md b/docs/api/public-api/type-aliases/FormToFormValues.md index c4422a53..2201a1d1 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/FormValues.md b/docs/api/public-api/type-aliases/FormValues.md index b18ffccf..ba1ba3a4 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/IconName.md b/docs/api/public-api/type-aliases/IconName.md deleted file mode 100644 index 8ff73a75..00000000 --- a/docs/api/public-api/type-aliases/IconName.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: IconName - -> **IconName** = `` `${AllIconName}` `` \| `` `${AllIconName}-outline` `` \| `` `${AllIconName}-fill` `` diff --git a/docs/api/public-api/type-aliases/ImageField.md b/docs/api/public-api/type-aliases/ImageField.md index 0eaf028e..2fb14ca2 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JSONArray.md b/docs/api/public-api/type-aliases/JSONArray.md index 0ff82f6c..3d7d3bfe 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JSONObject.md b/docs/api/public-api/type-aliases/JSONObject.md index 1b7bd507..414ed0bd 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JSONPrimitive.md b/docs/api/public-api/type-aliases/JSONPrimitive.md index cc47320b..a11f4191 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JSONValue.md b/docs/api/public-api/type-aliases/JSONValue.md index fa6cec96..cfd9f7d3 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/JobContext.md b/docs/api/public-api/type-aliases/JobContext.md index b77ffc0f..39238373 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/KVStore.md b/docs/api/public-api/type-aliases/KVStore.md deleted file mode 100644 index 739d393a..00000000 --- a/docs/api/public-api/type-aliases/KVStore.md +++ /dev/null @@ -1,91 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: KVStore - -> **KVStore** = `object` - -## Methods - - - -### delete() - -> **delete**(`key`): `Promise`\<`void`\> - -Deletes a key from the store if present - -#### Parameters - -##### key - -`string` - -#### Returns - -`Promise`\<`void`\> - -*** - - - -### get() - -> **get**\<`T`\>(`key`): `Promise`\<`undefined` \| `T`\> - -Retrieves a value from the store at the given key - -#### Type Parameters - -##### T - -`T` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -#### Parameters - -##### key - -`string` - -#### Returns - -`Promise`\<`undefined` \| `T`\> - -*** - - - -### list() - -> **list**(): `Promise`\<`string`[]\> - -Returns a list of keys in the store - -#### Returns - -`Promise`\<`string`[]\> - -*** - - - -### put() - -> **put**(`key`, `value`): `Promise`\<`void`\> - -Assigns a value to a key in the store - -#### Parameters - -##### key - -`string` - -##### value - -[`JSONValue`](JSONValue.md) - -#### Returns - -`Promise`\<`void`\> diff --git a/docs/api/public-api/type-aliases/MediaAsset.md b/docs/api/public-api/type-aliases/MediaAsset.md index 7a08cf69..4cb328ce 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MediaPlugin.md b/docs/api/public-api/type-aliases/MediaPlugin.md index 643bfc34..28dfea9d 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItem.md b/docs/api/public-api/type-aliases/MenuItem.md index ae0eecc3..12872bc0 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItemLocation.md b/docs/api/public-api/type-aliases/MenuItemLocation.md index 5a97ed1d..b0aa2e59 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItemOnPressEvent.md b/docs/api/public-api/type-aliases/MenuItemOnPressEvent.md index 8ec27b4f..db3065fc 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItemPostFilter.md b/docs/api/public-api/type-aliases/MenuItemPostFilter.md index 02a89292..a29a8315 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MenuItemUserType.md b/docs/api/public-api/type-aliases/MenuItemUserType.md index f44a1ef0..6924a5f0 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Metadata.md b/docs/api/public-api/type-aliases/Metadata.md index 9b280992..a307e972 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModActionDefinition.md b/docs/api/public-api/type-aliases/ModActionDefinition.md index b27ba800..f71ad07f 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** @@ -20,4 +20,4 @@ ### onEvent -> **onEvent**: [`TriggerOnEventHandler`](TriggerOnEventHandler.md)\<`protos.ModAction`\> +> **onEvent**: [`TriggerOnEventHandler`](TriggerOnEventHandler.md)\<`ModAction`\> diff --git a/docs/api/public-api/type-aliases/ModActionTrigger.md b/docs/api/public-api/type-aliases/ModActionTrigger.md index 37c77385..df0ee317 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ModMailDefinition.md b/docs/api/public-api/type-aliases/ModMailDefinition.md index 7f0920a2..dd6b6e2e 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** @@ -20,4 +20,4 @@ ### onEvent -> **onEvent**: [`TriggerOnEventHandler`](TriggerOnEventHandler.md)\<`protos.ModMail`\> +> **onEvent**: [`TriggerOnEventHandler`](TriggerOnEventHandler.md)\<`ModMail`\> diff --git a/docs/api/public-api/type-aliases/ModMailTrigger.md b/docs/api/public-api/type-aliases/ModMailTrigger.md index d984981f..7e228cfc 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/MultiTriggerDefinition.md b/docs/api/public-api/type-aliases/MultiTriggerDefinition.md index 01ec971e..284f8f88 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/NumberField.md b/docs/api/public-api/type-aliases/NumberField.md index d8f56e25..f5a31346 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/OnAutomoderatorFilterCommentDefinition.md b/docs/api/public-api/type-aliases/OnAutomoderatorFilterCommentDefinition.md index 77ce223c..8b3a15f0 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/OnAutomoderatorFilterPostDefinition.md b/docs/api/public-api/type-aliases/OnAutomoderatorFilterPostDefinition.md index 04563941..96ea01e9 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/OnTriggerRequest.md b/docs/api/public-api/type-aliases/OnTriggerRequest.md index 542585a8..4112c4f1 100644 --- a/docs/api/public-api/type-aliases/OnTriggerRequest.md +++ b/docs/api/public-api/type-aliases/OnTriggerRequest.md @@ -1,7 +1,7 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** # Type Alias: OnTriggerRequest -> **OnTriggerRequest** = [`PostFlairUpdate`](../@devvit/namespaces/EventTypes/interfaces/PostFlairUpdate.md) \| [`PostSubmit`](../@devvit/namespaces/EventTypes/interfaces/PostSubmit.md) \| [`PostCreate`](../@devvit/namespaces/EventTypes/interfaces/PostCreate.md) \| [`PostUpdate`](../@devvit/namespaces/EventTypes/interfaces/PostUpdate.md) \| [`PostReport`](../@devvit/namespaces/EventTypes/interfaces/PostReport.md) \| [`PostDelete`](../@devvit/namespaces/EventTypes/interfaces/PostDelete.md) \| [`CommentSubmit`](../@devvit/namespaces/EventTypes/interfaces/CommentSubmit.md) \| [`CommentCreate`](../@devvit/namespaces/EventTypes/interfaces/CommentCreate.md) \| [`CommentUpdate`](../@devvit/namespaces/EventTypes/interfaces/CommentUpdate.md) \| [`CommentReport`](../@devvit/namespaces/EventTypes/interfaces/CommentReport.md) \| [`CommentDelete`](../@devvit/namespaces/EventTypes/interfaces/CommentDelete.md) \| [`AppInstall`](../@devvit/namespaces/EventTypes/interfaces/AppInstall.md) \| [`AppUpgrade`](../@devvit/namespaces/EventTypes/interfaces/AppUpgrade.md) \| `protos.ModAction` \| `protos.ModMail` \| [`PostNsfwUpdate`](../@devvit/namespaces/EventTypes/interfaces/PostNsfwUpdate.md) \| [`PostSpoilerUpdate`](../@devvit/namespaces/EventTypes/interfaces/PostSpoilerUpdate.md) \| [`AutomoderatorFilterPost`](../@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterPost.md) \| [`AutomoderatorFilterComment`](../@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterComment.md) +> **OnTriggerRequest** = [`PostFlairUpdate`](../@devvit/namespaces/EventTypes/interfaces/PostFlairUpdate.md) \| [`PostSubmit`](../@devvit/namespaces/EventTypes/interfaces/PostSubmit.md) \| [`PostCreate`](../@devvit/namespaces/EventTypes/interfaces/PostCreate.md) \| [`PostUpdate`](../@devvit/namespaces/EventTypes/interfaces/PostUpdate.md) \| [`PostReport`](../@devvit/namespaces/EventTypes/interfaces/PostReport.md) \| [`PostDelete`](../@devvit/namespaces/EventTypes/interfaces/PostDelete.md) \| [`CommentSubmit`](../@devvit/namespaces/EventTypes/interfaces/CommentSubmit.md) \| [`CommentCreate`](../@devvit/namespaces/EventTypes/interfaces/CommentCreate.md) \| [`CommentUpdate`](../@devvit/namespaces/EventTypes/interfaces/CommentUpdate.md) \| [`CommentReport`](../@devvit/namespaces/EventTypes/interfaces/CommentReport.md) \| [`CommentDelete`](../@devvit/namespaces/EventTypes/interfaces/CommentDelete.md) \| [`AppInstall`](../@devvit/namespaces/EventTypes/interfaces/AppInstall.md) \| [`AppUpgrade`](../@devvit/namespaces/EventTypes/interfaces/AppUpgrade.md) \| `ModAction` \| `ModMail` \| [`PostNsfwUpdate`](../@devvit/namespaces/EventTypes/interfaces/PostNsfwUpdate.md) \| [`PostSpoilerUpdate`](../@devvit/namespaces/EventTypes/interfaces/PostSpoilerUpdate.md) \| [`AutomoderatorFilterPost`](../@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterPost.md) \| [`AutomoderatorFilterComment`](../@devvit/namespaces/EventTypes/interfaces/AutomoderatorFilterComment.md) diff --git a/docs/api/public-api/type-aliases/OnValidateHandler.md b/docs/api/public-api/type-aliases/OnValidateHandler.md index 2ab227f4..9263ad6d 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ParagraphField.md b/docs/api/public-api/type-aliases/ParagraphField.md index b0b3d6fa..9a099f38 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PartialJSONArray.md b/docs/api/public-api/type-aliases/PartialJSONArray.md index ebac1bde..7aa4b4ad 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PartialJSONObject.md b/docs/api/public-api/type-aliases/PartialJSONObject.md index 65671c1d..04056a3e 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PartialJSONPrimitive.md b/docs/api/public-api/type-aliases/PartialJSONPrimitive.md index f9acf8b5..dbcb9931 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PartialJSONValue.md b/docs/api/public-api/type-aliases/PartialJSONValue.md index b3b9edd3..bb74d2b5 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PluginSettings.md b/docs/api/public-api/type-aliases/PluginSettings.md index 10909e98..cf4a6746 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostCreate.md b/docs/api/public-api/type-aliases/PostCreate.md index 5adbfc4e..39405b86 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostCreateDefinition.md b/docs/api/public-api/type-aliases/PostCreateDefinition.md index 7d51d795..2664bcef 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostDelete.md b/docs/api/public-api/type-aliases/PostDelete.md index 11b02e7d..3c11db14 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostDeleteDefinition.md b/docs/api/public-api/type-aliases/PostDeleteDefinition.md index 39d773b5..cbb3248f 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostFlairUpdate.md b/docs/api/public-api/type-aliases/PostFlairUpdate.md index 520e0275..e34f6856 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostFlairUpdateDefinition.md b/docs/api/public-api/type-aliases/PostFlairUpdateDefinition.md index 7aa6a521..4d7ba246 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostNsfwUpdate.md b/docs/api/public-api/type-aliases/PostNsfwUpdate.md index d4c10a32..53e3f346 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostNsfwUpdateDefinition.md b/docs/api/public-api/type-aliases/PostNsfwUpdateDefinition.md index 3a40ee96..4c7e7ba2 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostReport.md b/docs/api/public-api/type-aliases/PostReport.md index 967e4af0..38699943 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostReportDefinition.md b/docs/api/public-api/type-aliases/PostReportDefinition.md index e4fbe5a6..07856e7a 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSpoilerUpdate.md b/docs/api/public-api/type-aliases/PostSpoilerUpdate.md index 05909992..21025a0a 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSpoilerUpdateDefinition.md b/docs/api/public-api/type-aliases/PostSpoilerUpdateDefinition.md index 64d94265..915b8b71 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSubmit.md b/docs/api/public-api/type-aliases/PostSubmit.md index d6bc0113..178f44b3 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostSubmitDefinition.md b/docs/api/public-api/type-aliases/PostSubmitDefinition.md index 5d0666a7..6f320d03 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostUpdate.md b/docs/api/public-api/type-aliases/PostUpdate.md index 93d7299c..6e8a00c8 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/PostUpdateDefinition.md b/docs/api/public-api/type-aliases/PostUpdateDefinition.md index 51ad17c8..3809a94c 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RedisClient.md b/docs/api/public-api/type-aliases/RedisClient.md index 4a8836ad..4a258bbe 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/RunJob.md b/docs/api/public-api/type-aliases/RunJob.md index 4f770d39..6f920b09 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledCronJob.md b/docs/api/public-api/type-aliases/ScheduledCronJob.md index e3b94554..952fb5c3 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledCronJobOptions.md b/docs/api/public-api/type-aliases/ScheduledCronJobOptions.md index 8c2ab3d4..b06ab304 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJob.md b/docs/api/public-api/type-aliases/ScheduledJob.md index 93683712..de8fbbed 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJobEvent.md b/docs/api/public-api/type-aliases/ScheduledJobEvent.md index 0575e331..16f3c9f9 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJobHandler.md b/docs/api/public-api/type-aliases/ScheduledJobHandler.md index 6d84fb0e..0ff6257f 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJobOptions.md b/docs/api/public-api/type-aliases/ScheduledJobOptions.md index a74b06f2..7f47a593 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ScheduledJobType.md b/docs/api/public-api/type-aliases/ScheduledJobType.md index bd8b002e..722cb086 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Scheduler.md b/docs/api/public-api/type-aliases/Scheduler.md index 38770e11..6604d79c 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SelectField.md b/docs/api/public-api/type-aliases/SelectField.md index c51d5aad..364eb9b8 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SetOptions.md b/docs/api/public-api/type-aliases/SetOptions.md index 9e2bf0bc..191be742 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SetStateAction.md b/docs/api/public-api/type-aliases/SetStateAction.md deleted file mode 100644 index a80c23f5..00000000 --- a/docs/api/public-api/type-aliases/SetStateAction.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: SetStateAction\ - -> **SetStateAction**\<`S`\> = `S` \| (`prevState`) => `S` - -## Type Parameters - -### S - -`S` diff --git a/docs/api/public-api/type-aliases/SettingScopeType.md b/docs/api/public-api/type-aliases/SettingScopeType.md index 47d5699f..ec6c2332 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsClient.md b/docs/api/public-api/type-aliases/SettingsClient.md index dec08702..5a16aab0 100644 --- a/docs/api/public-api/type-aliases/SettingsClient.md +++ b/docs/api/public-api/type-aliases/SettingsClient.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsFormField.md b/docs/api/public-api/type-aliases/SettingsFormField.md index 8a6fa3e5..5b71cadf 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsFormFieldGroup.md b/docs/api/public-api/type-aliases/SettingsFormFieldGroup.md index 1687ab21..a9a65576 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsFormFieldValidatorEvent.md b/docs/api/public-api/type-aliases/SettingsFormFieldValidatorEvent.md index f816a6a5..0dd4d421 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/SettingsValues.md b/docs/api/public-api/type-aliases/SettingsValues.md index 7b23802f..a600eedf 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/StateSetter.md b/docs/api/public-api/type-aliases/StateSetter.md deleted file mode 100644 index 6295d8c6..00000000 --- a/docs/api/public-api/type-aliases/StateSetter.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: StateSetter\ - -> **StateSetter**\<`S`\> = [`Dispatch`](Dispatch.md)\<[`SetStateAction`](SetStateAction.md)\<`S`\>\> - -## Type Parameters - -### S - -`S` diff --git a/docs/api/public-api/type-aliases/StringField.md b/docs/api/public-api/type-aliases/StringField.md index 3d0fb574..23ec19df 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/Toast.md b/docs/api/public-api/type-aliases/Toast.md index 92a2620a..428e6d10 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerContext.md b/docs/api/public-api/type-aliases/TriggerContext.md index 7603d86a..f3f15331 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerDefinition.md b/docs/api/public-api/type-aliases/TriggerDefinition.md index 28a1af37..e9b5cb26 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerEvent.md b/docs/api/public-api/type-aliases/TriggerEvent.md index e1a2e808..6403a3c8 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TriggerEventType.md b/docs/api/public-api/type-aliases/TriggerEventType.md index 1d5c142c..7cf7c7a2 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** @@ -140,7 +140,7 @@ Maps a TriggerEvent to a Protobuf message and type. ### ModAction -> **ModAction**: `object` & `protos.ModAction` +> **ModAction**: `object` & `ModAction` #### Type declaration @@ -154,7 +154,7 @@ Maps a TriggerEvent to a Protobuf message and type. ### ModMail -> **ModMail**: `object` & `protos.ModMail` +> **ModMail**: `object` & `ModMail` #### Type declaration diff --git a/docs/api/public-api/type-aliases/TriggerOnEventHandler.md b/docs/api/public-api/type-aliases/TriggerOnEventHandler.md index 1ee60622..e155f57f 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/TxClientLike.md b/docs/api/public-api/type-aliases/TxClientLike.md index 7ad5c6c6..d42e6e15 100644 --- a/docs/api/public-api/type-aliases/TxClientLike.md +++ b/docs/api/public-api/type-aliases/TxClientLike.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UIClient.md b/docs/api/public-api/type-aliases/UIClient.md index 697ca37a..6d507320 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** @@ -11,16 +11,6 @@ This client will only be available for capabilities that have a frontend component, such as within the Custom Post component's event handlers, a Form's `onSubmit` handler, and Menu items. -## Properties - - - -### webView - -> **webView**: `WebViewUIClient` - -Interact with WebView blocks - ## Methods diff --git a/docs/api/public-api/type-aliases/UploadMediaOptions.md b/docs/api/public-api/type-aliases/UploadMediaOptions.md index 22568600..d7085102 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/UseAsyncResult.md b/docs/api/public-api/type-aliases/UseAsyncResult.md deleted file mode 100644 index 285858b0..00000000 --- a/docs/api/public-api/type-aliases/UseAsyncResult.md +++ /dev/null @@ -1,37 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseAsyncResult\ - -> **UseAsyncResult**\<`S`\> = `object` - -## Type Parameters - -### S - -`S` - -## Properties - - - -### data - -> **data**: `S` \| `null` - -*** - - - -### error - -> **error**: [`AsyncError`](AsyncError.md) \| `null` - -*** - - - -### loading - -> **loading**: `boolean` diff --git a/docs/api/public-api/type-aliases/UseChannelHook.md b/docs/api/public-api/type-aliases/UseChannelHook.md deleted file mode 100644 index 1a15cc37..00000000 --- a/docs/api/public-api/type-aliases/UseChannelHook.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseChannelHook()\ - -> **UseChannelHook**\<`Message`\> = (`options`) => [`UseChannelResult`](UseChannelResult.md)\<`Message`\> - -## Type Parameters - -### Message - -`Message` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -## Parameters - -### options - -`ChannelOptions`\<`Message`\> - -## Returns - -[`UseChannelResult`](UseChannelResult.md)\<`Message`\> diff --git a/docs/api/public-api/type-aliases/UseChannelResult.md b/docs/api/public-api/type-aliases/UseChannelResult.md deleted file mode 100644 index 01b52c67..00000000 --- a/docs/api/public-api/type-aliases/UseChannelResult.md +++ /dev/null @@ -1,71 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseChannelResult\ - -> **UseChannelResult**\<`Message`\> = `object` - -## Type Parameters - -### Message - -`Message` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -## Properties - - - -### status - -> **status**: `ChannelStatus` - -Current subscription status - -## Methods - - - -### send() - -> **send**(`msg`): `Promise`\<`void`\> - -Publish a message to the channel - -#### Parameters - -##### msg - -`Message` - -#### Returns - -`Promise`\<`void`\> - -*** - - - -### subscribe() - -> **subscribe**(): `void` - -Subscribe to the channel - -#### Returns - -`void` - -*** - - - -### unsubscribe() - -> **unsubscribe**(): `void` - -Unsubscribe from the channel - -#### Returns - -`void` diff --git a/docs/api/public-api/type-aliases/UseFormHook.md b/docs/api/public-api/type-aliases/UseFormHook.md deleted file mode 100644 index dcee835e..00000000 --- a/docs/api/public-api/type-aliases/UseFormHook.md +++ /dev/null @@ -1,29 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseFormHook()\ - -> **UseFormHook**\<`T`\> = (`form`, `onSubmit`) => [`FormKey`](FormKey.md) - -A hook that returns a form key that can be used in the `ui.showForm` - -## Type Parameters - -### T - -`T` *extends* [`Form`](Form.md) \| [`FormFunction`](FormFunction.md) = [`Form`](Form.md) \| [`FormFunction`](FormFunction.md) - -## Parameters - -### form - -`T` - -### onSubmit - -(`values`) => `void` \| `Promise`\<`void`\> - -## Returns - -[`FormKey`](FormKey.md) diff --git a/docs/api/public-api/type-aliases/UseIntervalHook.md b/docs/api/public-api/type-aliases/UseIntervalHook.md deleted file mode 100644 index 329ff679..00000000 --- a/docs/api/public-api/type-aliases/UseIntervalHook.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseIntervalHook() - -> **UseIntervalHook** = (`callback`, `delay`) => [`UseIntervalResult`](UseIntervalResult.md) - -A hook that can used to run a callback on an interval between Block renders. Only one useInterval hook may be running at a time. - -## Parameters - -### callback - -() => `void` \| `Promise`\<`void`\> - -### delay - -`number` - -## Returns - -[`UseIntervalResult`](UseIntervalResult.md) diff --git a/docs/api/public-api/type-aliases/UseIntervalResult.md b/docs/api/public-api/type-aliases/UseIntervalResult.md deleted file mode 100644 index 6e418cc3..00000000 --- a/docs/api/public-api/type-aliases/UseIntervalResult.md +++ /dev/null @@ -1,37 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseIntervalResult - -> **UseIntervalResult** = `object` - -An object that contains functions to start and stop the interval created by the `useInterval` hook - -## Properties - - - -### start() - -> **start**: () => `void` - -Start the interval - -#### Returns - -`void` - -*** - - - -### stop() - -> **stop**: () => `void` - -Stop the interval - -#### Returns - -`void` diff --git a/docs/api/public-api/type-aliases/UseStateHook.md b/docs/api/public-api/type-aliases/UseStateHook.md deleted file mode 100644 index f004b9e7..00000000 --- a/docs/api/public-api/type-aliases/UseStateHook.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseStateHook - -> **UseStateHook** = [`Context`](Context.md)\[`"useState"`\] diff --git a/docs/api/public-api/type-aliases/UseStateInitializer.md b/docs/api/public-api/type-aliases/UseStateInitializer.md deleted file mode 100644 index c3b962e1..00000000 --- a/docs/api/public-api/type-aliases/UseStateInitializer.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseStateInitializer\ - -> **UseStateInitializer**\<`S`\> = `S` \| () => `S` \| [`AsyncUseStateInitializer`](AsyncUseStateInitializer.md)\<`S`\> - -## Type Parameters - -### S - -`S` diff --git a/docs/api/public-api/type-aliases/UseStateResult.md b/docs/api/public-api/type-aliases/UseStateResult.md deleted file mode 100644 index 4a7508f5..00000000 --- a/docs/api/public-api/type-aliases/UseStateResult.md +++ /dev/null @@ -1,15 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseStateResult\ - -> **UseStateResult**\<`S`\> = \[`S`, [`StateSetter`](StateSetter.md)\<`S`\>\] - -A tuple containing the current state and a function to update it - -## Type Parameters - -### S - -`S` diff --git a/docs/api/public-api/type-aliases/UseWebViewOnMessage.md b/docs/api/public-api/type-aliases/UseWebViewOnMessage.md deleted file mode 100644 index 8def615e..00000000 --- a/docs/api/public-api/type-aliases/UseWebViewOnMessage.md +++ /dev/null @@ -1,35 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseWebViewOnMessage()\ - -> **UseWebViewOnMessage**\<`From`, `To`\> = (`message`, `hook`) => `void` \| `Promise`\<`void`\> - -## Type Parameters - -### From - -`From` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -Message from web view to Devvit Blocks app. - -### To - -`To` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -Message from Devvit Blocks app to web view. - -## Parameters - -### message - -`From` - -### hook - -[`UseWebViewResult`](UseWebViewResult.md)\<`To`\> - -## Returns - -`void` \| `Promise`\<`void`\> diff --git a/docs/api/public-api/type-aliases/UseWebViewOptions.md b/docs/api/public-api/type-aliases/UseWebViewOptions.md deleted file mode 100644 index dfb777e5..00000000 --- a/docs/api/public-api/type-aliases/UseWebViewOptions.md +++ /dev/null @@ -1,66 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseWebViewOptions\ - -> **UseWebViewOptions**\<`From`, `To`\> = `object` - -## Type Parameters - -### From - -`From` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -Message from web view to Devvit Blocks app. - -### To - -`To` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -Message from Devvit Blocks app to web view. - -## Properties - - - -### onMessage - -> **onMessage**: [`UseWebViewOnMessage`](UseWebViewOnMessage.md)\<`From`, `To`\> - -Handle UI events originating from the web view to be handled by a Devvit app - -*** - - - -### ~~onUnmount()?~~ - -> `optional` **onUnmount**: (`hook`) => `void` \| `Promise`\<`void`\> - -The callback to run when the web view has been unmounted. Might be used to -set state, stop or resume timers, or perform other tasks now that the web view is no longer visible. - -#### Parameters - -##### hook - -[`UseWebViewResult`](UseWebViewResult.md)\<`To`\> - -#### Returns - -`void` \| `Promise`\<`void`\> - -#### Deprecated - -use the page visibility API for now. - -*** - - - -### url? - -> `optional` **url**: `string` - -Relative HTML asset filename like `foo/bar.html`. Defaults to index.html if omitted. diff --git a/docs/api/public-api/type-aliases/UseWebViewResult.md b/docs/api/public-api/type-aliases/UseWebViewResult.md deleted file mode 100644 index 7a450166..00000000 --- a/docs/api/public-api/type-aliases/UseWebViewResult.md +++ /dev/null @@ -1,63 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Type Alias: UseWebViewResult\ - -> **UseWebViewResult**\<`To`\> = `object` - -## Type Parameters - -### To - -`To` *extends* [`JSONValue`](JSONValue.md) = [`JSONValue`](JSONValue.md) - -Message from Devvit Blocks app to web view. - -## Methods - - - -### mount() - -> **mount**(): `void` - -Initiate a request for the web view to open - -#### Returns - -`void` - -*** - - - -### postMessage() - -> **postMessage**(`message`): `void` - -Send a message to the web view - -#### Parameters - -##### message - -`To` - -#### Returns - -`void` - -*** - - - -### unmount() - -> **unmount**(): `void` - -Initiate a request for the web view to be closed - -#### Returns - -`void` diff --git a/docs/api/public-api/type-aliases/ValidatedBooleanField.md b/docs/api/public-api/type-aliases/ValidatedBooleanField.md index 35b730be..e927212c 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedFormField.md b/docs/api/public-api/type-aliases/ValidatedFormField.md index c0e8a8f9..4dabddae 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedNumberField.md b/docs/api/public-api/type-aliases/ValidatedNumberField.md index 2d3168a1..c52d9785 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedParagraphField.md b/docs/api/public-api/type-aliases/ValidatedParagraphField.md index de4e450c..12922fcf 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedSelectField.md b/docs/api/public-api/type-aliases/ValidatedSelectField.md index 21bef915..a3ca2228 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ValidatedStringField.md b/docs/api/public-api/type-aliases/ValidatedStringField.md index aab5d6cd..1722dbc9 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ZMember.md b/docs/api/public-api/type-aliases/ZMember.md index 850a6e49..154f73f4 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ZRangeByScoreOptions.md b/docs/api/public-api/type-aliases/ZRangeByScoreOptions.md index 50a333b1..0330862c 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/type-aliases/ZRangeOptions.md b/docs/api/public-api/type-aliases/ZRangeOptions.md index 73d8f313..ead92531 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.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/public-api/variables/ALL_ICON_NAMES.md b/docs/api/public-api/variables/ALL_ICON_NAMES.md deleted file mode 100644 index c16700d4..00000000 --- a/docs/api/public-api/variables/ALL_ICON_NAMES.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) - -*** - -# Variable: ALL\_ICON\_NAMES - -> `const` **ALL\_ICON\_NAMES**: readonly \[`"3rd-party"`, `"a11y"`, `"activity"`, `"add-emoji"`, `"add"`, `"add-filter"`, `"add-media"`, `"add-to-feed"`, `"admin"`, `"ads"`, `"ai"`, `"align-center"`, `"align-left"`, `"align-right"`, `"all"`, `"ama"`, `"answers"`, `"appearance"`, `"approve"`, `"archived"`, `"aspect-ratio-12"`, `"aspect-ratio"`, `"aspect-rectangle"`, `"attach"`, `"audience"`, `"audio"`, `"author"`, `"automod"`, `"avatar-style"`, `"award"`, `"back"`, `"backup"`, `"ban"`, `"best"`, `"beta-advertise-2"`, `"beta-advertise-3"`, `"beta-advertise-4"`, `"beta-advertise-5"`, `"binoculars"`, `"block"`, `"blockchain"`, `"bold"`, `"boost"`, `"bot"`, `"bounce"`, `"brand-awareness"`, `"browse"`, `"browser"`, `"business"`, `"cake"`, `"calendar"`, `"camera"`, `"campaign"`, `"caret-down"`, `"caret-left"`, `"caret-right"`, `"caret-up"`, `"caret-updown"`, `"chat"`, `"chat-group"`, `"chat-new"`, `"chat-private"`, `"checkbox-dismiss"`, `"checkbox"`, `"checkmark"`, `"chrome"`, `"clear"`, `"client-list"`, `"close"`, `"closed-captioning"`, `"club-12"`, `"club"`, `"code-block"`, `"code-inline"`, `"coins-color-old"`, `"coins"`, `"collapse-left"`, `"collapse-right"`, `"collectible-expressions"`, `"collection"`, `"comment"`, `"comments"`, `"communities"`, `"community"`, `"confidence"`, `"confidence-outline-null"`, `"contest"`, `"controversial"`, `"conversion"`, `"copy-clipboard"`, `"crop"`, `"crosspost"`, `"crowd-control"`, `"custom-feed"`, `"customize"`, `"dashboard"`, `"day"`, `"delete-column"`, `"delete"`, `"delete-row"`, `"devvit"`, `"discover"`, `"dismiss-all"`, `"distinguish"`, `"down-arrow"`, `"down"`, `"download"`, `"downvote"`, `"downvotes"`, `"drag"`, `"drugs"`, `"duplicate"`, `"edit"`, `"effect"`, `"embed"`, `"emoji"`, `"end-live-chat"`, `"error"`, `"expand-left-12"`, `"expand-left"`, `"expand-right-12"`, `"expand-right"`, `"external"`, `"feed-video"`, `"filter"`, `"fork"`, `"format"`, `"forward"`, `"funnel"`, `"gif-post"`, `"gold"`, `"happy-face"`, `"hashtag"`, `"heart"`, `"help"`, `"hide"`, `"history"`, `"home"`, `"hot"`, `"ignore-reports"`, `"image-post"`, `"inbox"`, `"infinity-12"`, `"infinity"`, `"info"`, `"insert-column-left"`, `"insert-column-right"`, `"insert-row-above"`, `"insert-row-below"`, `"internet"`, `"invite"`, `"italic"`, `"join"`, `"joined"`, `"jump-down"`, `"jump-up"`, `"karma"`, `"keyboard"`, `"keyword"`, `"kick"`, `"language"`, `"leave"`, `"left"`, `"line-graph"`, `"link"`, `"link-post"`, `"list-bulleted"`, `"list-numbered"`, `"live-chat"`, `"live"`, `"load"`, `"location"`, `"lock"`, `"logout"`, `"loop"`, `"macro"`, `"mark-read"`, `"marketplace"`, `"mask"`, `"media-gallery"`, `"meme"`, `"menu"`, `"merge"`, `"message"`, `"mic"`, `"mic-mute"`, `"mod"`, `"mod-mail"`, `"mod-mode"`, `"mod-mute"`, `"mod-overflow"`, `"mod-queue"`, `"mod-unmute"`, `"music"`, `"mute"`, `"neutral-face"`, `"new"`, `"new-guide"`, `"night"`, `"no-internet"`, `"notification"`, `"notification-frequent"`, `"notification-off"`, `"nsfw-alt"`, `"nsfw"`, `"nsfw-language"`, `"nsfw-violence"`, `"official"`, `"original"`, `"overflow-caret"`, `"overflow-horizontal"`, `"overflow-vertical"`, `"partner-community"`, `"pause"`, `"payment"`, `"peace"`, `"pending-posts"`, `"phone"`, `"pin"`, `"planet"`, `"play"`, `"poll-post"`, `"popular"`, `"posts"`, `"powerup"`, `"predictions"`, `"premium"`, `"privacy"`, `"profile"`, `"qa"`, `"qr-code"`, `"quarantined"`, `"quote"`, `"r-slash"`, `"radar"`, `"radio-button"`, `"raise-hand"`, `"random"`, `"ratings-everyone"`, `"ratings-mature"`, `"ratings-nsfw"`, `"ratings-violence"`, `"recovery-phrase"`, `"refresh"`, `"removal-reasons"`, `"remove"`, `"reply"`, `"report"`, `"reverse"`, `"rich-text"`, `"right"`, `"rising"`, `"rotate"`, `"rotate-image"`, `"rpan"`, `"rules"`, `"sad-face"`, `"safari"`, `"save"`, `"save-view"`, `"saved"`, `"saved-response"`, `"search"`, `"self"`, `"send"`, `"settings"`, `"severity"`, `"share-android"`, `"share"`, `"share-ios"`, `"share-new"`, `"show"`, `"side-menu"`, `"skipback10"`, `"skipforward10"`, `"sort-az"`, `"sort"`, `"sort-price"`, `"sort-za"`, `"spam"`, `"spoiler"`, `"sponsored"`, `"spreadsheet"`, `"star"`, `"statistics"`, `"status-live"`, `"sticker"`, `"strikethrough"`, `"subtract"`, `"superscript"`, `"swap-camera"`, `"swipe-back"`, `"swipe-down"`, `"swipe"`, `"swipe-up"`, `"table"`, `"tag"`, `"tap"`, `"telescope"`, `"text"`, `"text-post"`, `"text-size"`, `"thumbs-down"`, `"thumbs-up"`, `"toggle"`, `"tools"`, `"top"`, `"topic-activism"`, `"topic-addictionsupport"`, `"topic-advice"`, `"topic-animals"`, `"topic-anime"`, `"topic-art"`, `"topic-beauty"`, `"topic-business"`, `"topic-careers"`, `"topic-cars"`, `"topic-celebrity"`, `"topic-craftsdiy"`, `"topic-crypto"`, `"topic-culture"`, `"topic-diy"`, `"topic-entertainment"`, `"topic-ethics"`, `"topic-family"`, `"topic-fashion"`, `"topic"`, `"topic-fitness"`, `"topic-food"`, `"topic-funny"`, `"topic-gender"`, `"topic-health"`, `"topic-help"`, `"topic-history"`, `"topic-hobbies"`, `"topic-homegarden"`, `"topic-internet"`, `"topic-law"`, `"topic-learning"`, `"topic-lifestyle"`, `"topic-marketplace"`, `"topic-mature"`, `"topic-mensfashion"`, `"topic-menshealth"`, `"topic-meta"`, `"topic-military"`, `"topic-movies"`, `"topic-music"`, `"topic-news"`, `"topic-other"`, `"topic-outdoors"`, `"topic-pets"`, `"topic-photography"`, `"topic-places"`, `"topic-podcasts"`, `"topic-politics"`, `"topic-programming"`, `"topic-reading"`, `"topic-religion"`, `"topic-science"`, `"topic-sexorientation"`, `"topic-sports"`, `"topic-style"`, `"topic-tabletop"`, `"topic-technology"`, `"topic-television"`, `"topic-traumasupport"`, `"topic-travel"`, `"topic-videogaming"`, `"topic-womensfashion"`, `"topic-womenshealth"`, `"translate"`, `"translation-off"`, `"trim"`, `"u-slash"`, `"unban"`, `"undo"`, `"unheart"`, `"unlock"`, `"unmod"`, `"unpin"`, `"unstar"`, `"unverified"`, `"up-arrow"`, `"up"`, `"upload"`, `"upvote"`, `"upvotes"`, `"user"`, `"user-note"`, `"users"`, `"vault"`, `"verified"`, `"video-camera"`, `"video-feed"`, `"video-live"`, `"video-post"`, `"video-thread"`, `"video-transcription"`, `"view-card"`, `"view-classic"`, `"view-compact"`, `"view-grid"`, `"view-sort"`, `"views"`, `"voiceover"`, `"volume"`, `"wallet"`, `"warning"`, `"webhook"`, `"whale"`, `"wiki-ban"`, `"wiki"`, `"wiki-unban"`, `"world"`, `"coins-color"`, `"powerup-color"`, `"powerup-fill-color"`, `"video-live-1"`, `"video-live-fill-1"`\] diff --git a/docs/api/redditapi/README.md b/docs/api/redditapi/README.md index 784de499..cece08d6 100644 --- a/docs/api/redditapi/README.md +++ b/docs/api/redditapi/README.md @@ -1,8 +1,8 @@ -**@devvit/public-api v0.12.25-dev** +**@devvit/public-api v0.13.1-dev** *** -# @devvit/public-api v0.12.25-dev +# @devvit/public-api v0.13.1-dev ## Modules diff --git a/docs/api/redditapi/RedditAPIClient/README.md b/docs/api/redditapi/RedditAPIClient/README.md index ed0ee47b..4ebf625f 100644 --- a/docs/api/redditapi/RedditAPIClient/README.md +++ b/docs/api/redditapi/RedditAPIClient/README.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** diff --git a/docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md b/docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md index 178848b9..8cb2c311 100644 --- a/docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md +++ b/docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/RedditAPIClient/type-aliases/InviteModeratorOptions.md b/docs/api/redditapi/RedditAPIClient/type-aliases/InviteModeratorOptions.md index 32d80176..7858efad 100644 --- a/docs/api/redditapi/RedditAPIClient/type-aliases/InviteModeratorOptions.md +++ b/docs/api/redditapi/RedditAPIClient/type-aliases/InviteModeratorOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/RedditAPIClient/type-aliases/MuteUserOptions.md b/docs/api/redditapi/RedditAPIClient/type-aliases/MuteUserOptions.md index ed92e5d3..3df6dfe6 100644 --- a/docs/api/redditapi/RedditAPIClient/type-aliases/MuteUserOptions.md +++ b/docs/api/redditapi/RedditAPIClient/type-aliases/MuteUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/README.md b/docs/api/redditapi/models/README.md index 9b8ac7de..aa73b02c 100644 --- a/docs/api/redditapi/models/README.md +++ b/docs/api/redditapi/models/README.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../README.md) +[**@devvit/public-api v0.13.1-dev**](../README.md) *** @@ -75,8 +75,6 @@ - [CrosspostOptions](type-aliases/CrosspostOptions.md) - [CrowdControlLevel](type-aliases/CrowdControlLevel.md) - [CustomizationFlag](type-aliases/CustomizationFlag.md) -- [CustomPostRichTextFallback](type-aliases/CustomPostRichTextFallback.md) -- [CustomPostTextFallbackOptions](type-aliases/CustomPostTextFallbackOptions.md) - [DeleteNotesOptions](type-aliases/DeleteNotesOptions.md) - [EditCommentOptions](type-aliases/EditCommentOptions.md) - [EditFlairTemplateOptions](type-aliases/EditFlairTemplateOptions.md) @@ -142,8 +140,6 @@ - [SetPostFlairOptions](type-aliases/SetPostFlairOptions.md) - [SetUserFlairBatchConfig](type-aliases/SetUserFlairBatchConfig.md) - [SetUserFlairOptions](type-aliases/SetUserFlairOptions.md) -- [SubmitCustomPostOptions](type-aliases/SubmitCustomPostOptions.md) -- [SubmitCustomPostTextFallbackOptions](type-aliases/SubmitCustomPostTextFallbackOptions.md) - [SubmitLinkOptions](type-aliases/SubmitLinkOptions.md) - [SubmitMediaOptions](type-aliases/SubmitMediaOptions.md) - [SubmitPostOptions](type-aliases/SubmitPostOptions.md) diff --git a/docs/api/redditapi/models/classes/AuthorFlairSettings.md b/docs/api/redditapi/models/classes/AuthorFlairSettings.md index de099df8..2705cf08 100644 --- a/docs/api/redditapi/models/classes/AuthorFlairSettings.md +++ b/docs/api/redditapi/models/classes/AuthorFlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ButtonWidget.md b/docs/api/redditapi/models/classes/ButtonWidget.md index 162f8d91..0382a75f 100644 --- a/docs/api/redditapi/models/classes/ButtonWidget.md +++ b/docs/api/redditapi/models/classes/ButtonWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/CalendarWidget.md b/docs/api/redditapi/models/classes/CalendarWidget.md index 7fd06ac2..d17e4be0 100644 --- a/docs/api/redditapi/models/classes/CalendarWidget.md +++ b/docs/api/redditapi/models/classes/CalendarWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Comment.md b/docs/api/redditapi/models/classes/Comment.md index 0b94a272..2e660593 100644 --- a/docs/api/redditapi/models/classes/Comment.md +++ b/docs/api/redditapi/models/classes/Comment.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/CommunityListWidget.md b/docs/api/redditapi/models/classes/CommunityListWidget.md index 1424dcca..62d06ef3 100644 --- a/docs/api/redditapi/models/classes/CommunityListWidget.md +++ b/docs/api/redditapi/models/classes/CommunityListWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** @@ -142,11 +142,11 @@ ### toJSON() -> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CommunityListWidget`, `"communities"` \| `"styles"`\> +> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CommunityListWidget`, `"styles"` \| `"communities"`\> #### Returns -`Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CommunityListWidget`, `"communities"` \| `"styles"`\> +`Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CommunityListWidget`, `"styles"` \| `"communities"`\> #### Overrides diff --git a/docs/api/redditapi/models/classes/CustomWidget.md b/docs/api/redditapi/models/classes/CustomWidget.md index 96b54204..44c4e551 100644 --- a/docs/api/redditapi/models/classes/CustomWidget.md +++ b/docs/api/redditapi/models/classes/CustomWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Flair.md b/docs/api/redditapi/models/classes/Flair.md index 8b820342..63952063 100644 --- a/docs/api/redditapi/models/classes/Flair.md +++ b/docs/api/redditapi/models/classes/Flair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/FlairTemplate.md b/docs/api/redditapi/models/classes/FlairTemplate.md index 8dadfd9b..e901230a 100644 --- a/docs/api/redditapi/models/classes/FlairTemplate.md +++ b/docs/api/redditapi/models/classes/FlairTemplate.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ImageWidget.md b/docs/api/redditapi/models/classes/ImageWidget.md index f8400c90..b94524bb 100644 --- a/docs/api/redditapi/models/classes/ImageWidget.md +++ b/docs/api/redditapi/models/classes/ImageWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Listing.md b/docs/api/redditapi/models/classes/Listing.md index b533cfba..8e7b1cb3 100644 --- a/docs/api/redditapi/models/classes/Listing.md +++ b/docs/api/redditapi/models/classes/Listing.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ModMailService.md b/docs/api/redditapi/models/classes/ModMailService.md index 14643078..08ed8b6d 100644 --- a/docs/api/redditapi/models/classes/ModMailService.md +++ b/docs/api/redditapi/models/classes/ModMailService.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/ModNote.md b/docs/api/redditapi/models/classes/ModNote.md index f6626282..b6504b3a 100644 --- a/docs/api/redditapi/models/classes/ModNote.md +++ b/docs/api/redditapi/models/classes/ModNote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Post.md b/docs/api/redditapi/models/classes/Post.md index 38f841a2..4cc96d52 100644 --- a/docs/api/redditapi/models/classes/Post.md +++ b/docs/api/redditapi/models/classes/Post.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** @@ -160,6 +160,22 @@ *** + + +### crosspostParentId + +#### Get Signature + +> **get** **crosspostParentId**(): `undefined` \| `` `t3_${string}` `` + +The ID of the original post this was crossposted from. Undefined if this post is not a crosspost. + +##### Returns + +`undefined` \| `` `t3_${string}` `` + +*** + ### distinguishedBy @@ -792,27 +808,6 @@ const enrichedThumbnail = await post.getEnrichedThumbnail(); *** - - -### getPostData() - -> **getPostData**(): `Promise`\<`undefined` \| `JsonObject`\> - -Get the postData for the post. - -#### Returns - -`Promise`\<`undefined` \| `JsonObject`\> - -#### Example - -```ts -const post = await context.reddit.getPostById(context.postId); -const postData = await post.getPostData(); -``` - -*** - ### hide() @@ -1047,80 +1042,6 @@ const postData = await post.getPostData(); *** - - -### setCustomPostPreview() - -> **setCustomPostPreview**(`ui`): `Promise`\<`void`\> - -Set a lightweight UI that shows while the custom post renders - -#### Parameters - -##### ui - -`ComponentFunction` - -A JSX component function that returns a simple ui to be rendered. - -#### Returns - -`Promise`\<`void`\> - -#### Throws - -Throws an error if the preview could not be set. - -#### Example - -```ts -const preview = ( - - An updated preview! - -); -const post = await reddit.getPostById(context.postId); -await post.setCustomPostPreview(() => preview); -``` - -*** - - - -### setPostData() - -> **setPostData**(`postData`): `Promise`\<`void`\> - -Set the postData on a custom post. - -#### Parameters - -##### postData - -`JsonObject` - -Represents the postData to be set, eg: { currentScore: 55, secretWord: 'barbeque' } - -#### Returns - -`Promise`\<`void`\> - -#### Throws - -Throws an error if the postData could not be set. - -#### Example - -```ts -const post = await reddit.getPostById(context.postId); -await post.setPostData({ - currentScore: 55, - secretWord: 'barbeque', -}); -``` - -*** - ### setSuggestedCommentSort() @@ -1152,41 +1073,6 @@ await post.setSuggestedCommentSort("NEW"); *** - - -### setTextFallback() - -> **setTextFallback**(`options`): `Promise`\<`void`\> - -Set a text fallback for the custom post - -#### Parameters - -##### options - -[`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. - -#### 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); -``` - -*** - ### snoozeReports() @@ -1232,11 +1118,11 @@ The report reason to snooze. ### toJSON() -> **toJSON**(): `Pick`\<`Post`, `"subredditName"` \| `"flair"` \| `"id"` \| `"score"` \| `"title"` \| `"subredditId"` \| `"permalink"` \| `"url"` \| `"createdAt"` \| `"nsfw"` \| `"authorId"` \| `"authorName"` \| `"body"` \| `"bodyHtml"` \| `"thumbnail"` \| `"numberOfComments"` \| `"numberOfReports"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"removedBy"` \| `"removedByCategory"` \| `"archived"` \| `"edited"` \| `"locked"` \| `"quarantined"` \| `"spoiler"` \| `"hidden"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"secureMedia"` \| `"userReportReasons"` \| `"modReportReasons"`\> +> **toJSON**(): `Pick`\<`Post`, `"subredditName"` \| `"flair"` \| `"id"` \| `"score"` \| `"subredditId"` \| `"permalink"` \| `"url"` \| `"createdAt"` \| `"title"` \| `"nsfw"` \| `"authorId"` \| `"authorName"` \| `"body"` \| `"bodyHtml"` \| `"thumbnail"` \| `"numberOfComments"` \| `"numberOfReports"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"removedBy"` \| `"removedByCategory"` \| `"archived"` \| `"edited"` \| `"locked"` \| `"quarantined"` \| `"spoiler"` \| `"hidden"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"secureMedia"` \| `"userReportReasons"` \| `"modReportReasons"` \| `"crosspostParentId"`\> #### Returns -`Pick`\<`Post`, `"subredditName"` \| `"flair"` \| `"id"` \| `"score"` \| `"title"` \| `"subredditId"` \| `"permalink"` \| `"url"` \| `"createdAt"` \| `"nsfw"` \| `"authorId"` \| `"authorName"` \| `"body"` \| `"bodyHtml"` \| `"thumbnail"` \| `"numberOfComments"` \| `"numberOfReports"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"removedBy"` \| `"removedByCategory"` \| `"archived"` \| `"edited"` \| `"locked"` \| `"quarantined"` \| `"spoiler"` \| `"hidden"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"secureMedia"` \| `"userReportReasons"` \| `"modReportReasons"`\> +`Pick`\<`Post`, `"subredditName"` \| `"flair"` \| `"id"` \| `"score"` \| `"subredditId"` \| `"permalink"` \| `"url"` \| `"createdAt"` \| `"title"` \| `"nsfw"` \| `"authorId"` \| `"authorName"` \| `"body"` \| `"bodyHtml"` \| `"thumbnail"` \| `"numberOfComments"` \| `"numberOfReports"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"removedBy"` \| `"removedByCategory"` \| `"archived"` \| `"edited"` \| `"locked"` \| `"quarantined"` \| `"spoiler"` \| `"hidden"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"secureMedia"` \| `"userReportReasons"` \| `"modReportReasons"` \| `"crosspostParentId"`\> *** diff --git a/docs/api/redditapi/models/classes/PostFlairSettings.md b/docs/api/redditapi/models/classes/PostFlairSettings.md index 43e796ae..f33c9258 100644 --- a/docs/api/redditapi/models/classes/PostFlairSettings.md +++ b/docs/api/redditapi/models/classes/PostFlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/PostFlairWidget.md b/docs/api/redditapi/models/classes/PostFlairWidget.md index d130f86a..3bfc7804 100644 --- a/docs/api/redditapi/models/classes/PostFlairWidget.md +++ b/docs/api/redditapi/models/classes/PostFlairWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/PrivateMessage.md b/docs/api/redditapi/models/classes/PrivateMessage.md index 55563727..f2b08678 100644 --- a/docs/api/redditapi/models/classes/PrivateMessage.md +++ b/docs/api/redditapi/models/classes/PrivateMessage.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** @@ -68,11 +68,11 @@ #### Get Signature -> **get** **id**(): `TID` +> **get** **id**(): `Tid` ##### Returns -`TID` +`Tid` ## Methods diff --git a/docs/api/redditapi/models/classes/Rule.md b/docs/api/redditapi/models/classes/Rule.md index 7203fcb3..ae8bca42 100644 --- a/docs/api/redditapi/models/classes/Rule.md +++ b/docs/api/redditapi/models/classes/Rule.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Subreddit.md b/docs/api/redditapi/models/classes/Subreddit.md index 1d7410c8..000a226a 100644 --- a/docs/api/redditapi/models/classes/Subreddit.md +++ b/docs/api/redditapi/models/classes/Subreddit.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** @@ -1352,11 +1352,11 @@ const userFlairList = response.users ### toJSON() -> **toJSON**(): `Pick`\<`Subreddit`, `"type"` \| `"description"` \| `"id"` \| `"name"` \| `"title"` \| `"settings"` \| `"createdAt"` \| `"language"` \| `"numberOfSubscribers"` \| `"numberOfActiveUsers"` \| `"nsfw"`\> +> **toJSON**(): `Pick`\<`Subreddit`, `"type"` \| `"description"` \| `"id"` \| `"settings"` \| `"name"` \| `"createdAt"` \| `"title"` \| `"language"` \| `"numberOfSubscribers"` \| `"numberOfActiveUsers"` \| `"nsfw"`\> #### Returns -`Pick`\<`Subreddit`, `"type"` \| `"description"` \| `"id"` \| `"name"` \| `"title"` \| `"settings"` \| `"createdAt"` \| `"language"` \| `"numberOfSubscribers"` \| `"numberOfActiveUsers"` \| `"nsfw"`\> +`Pick`\<`Subreddit`, `"type"` \| `"description"` \| `"id"` \| `"settings"` \| `"name"` \| `"createdAt"` \| `"title"` \| `"language"` \| `"numberOfSubscribers"` \| `"numberOfActiveUsers"` \| `"nsfw"`\> *** diff --git a/docs/api/redditapi/models/classes/SubredditDescription.md b/docs/api/redditapi/models/classes/SubredditDescription.md index 4a404a7c..e9ce47e0 100644 --- a/docs/api/redditapi/models/classes/SubredditDescription.md +++ b/docs/api/redditapi/models/classes/SubredditDescription.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditRulesWidget.md b/docs/api/redditapi/models/classes/SubredditRulesWidget.md index e68edd71..61b9ba17 100644 --- a/docs/api/redditapi/models/classes/SubredditRulesWidget.md +++ b/docs/api/redditapi/models/classes/SubredditRulesWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/SubredditWikiSettings.md b/docs/api/redditapi/models/classes/SubredditWikiSettings.md index 22719b16..43651a63 100644 --- a/docs/api/redditapi/models/classes/SubredditWikiSettings.md +++ b/docs/api/redditapi/models/classes/SubredditWikiSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/TextAreaWidget.md b/docs/api/redditapi/models/classes/TextAreaWidget.md index fde06a8a..2cd5b68b 100644 --- a/docs/api/redditapi/models/classes/TextAreaWidget.md +++ b/docs/api/redditapi/models/classes/TextAreaWidget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/User.md b/docs/api/redditapi/models/classes/User.md index ca5fc997..9ceeb0d3 100644 --- a/docs/api/redditapi/models/classes/User.md +++ b/docs/api/redditapi/models/classes/User.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/Widget.md b/docs/api/redditapi/models/classes/Widget.md index e5bdac88..32901a11 100644 --- a/docs/api/redditapi/models/classes/Widget.md +++ b/docs/api/redditapi/models/classes/Widget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPage.md b/docs/api/redditapi/models/classes/WikiPage.md index 426cf26a..59b9ac10 100644 --- a/docs/api/redditapi/models/classes/WikiPage.md +++ b/docs/api/redditapi/models/classes/WikiPage.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPageRevision.md b/docs/api/redditapi/models/classes/WikiPageRevision.md index f7c0a162..a8b2878e 100644 --- a/docs/api/redditapi/models/classes/WikiPageRevision.md +++ b/docs/api/redditapi/models/classes/WikiPageRevision.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/classes/WikiPageSettings.md b/docs/api/redditapi/models/classes/WikiPageSettings.md index a4e2f349..1ead9f56 100644 --- a/docs/api/redditapi/models/classes/WikiPageSettings.md +++ b/docs/api/redditapi/models/classes/WikiPageSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/AboutLocations.md b/docs/api/redditapi/models/enumerations/AboutLocations.md index 735ebf06..16f8936e 100644 --- a/docs/api/redditapi/models/enumerations/AboutLocations.md +++ b/docs/api/redditapi/models/enumerations/AboutLocations.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/FlairType.md b/docs/api/redditapi/models/enumerations/FlairType.md index 1a5177d1..0bd4cf80 100644 --- a/docs/api/redditapi/models/enumerations/FlairType.md +++ b/docs/api/redditapi/models/enumerations/FlairType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/ModMailActionType.md b/docs/api/redditapi/models/enumerations/ModMailActionType.md index ee96570b..b0d95a58 100644 --- a/docs/api/redditapi/models/enumerations/ModMailActionType.md +++ b/docs/api/redditapi/models/enumerations/ModMailActionType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/ModMailConversationState.md b/docs/api/redditapi/models/enumerations/ModMailConversationState.md index 1f0a5376..eef6e64c 100644 --- a/docs/api/redditapi/models/enumerations/ModMailConversationState.md +++ b/docs/api/redditapi/models/enumerations/ModMailConversationState.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/SocialLinkType.md b/docs/api/redditapi/models/enumerations/SocialLinkType.md index 148cdbe2..0261734b 100644 --- a/docs/api/redditapi/models/enumerations/SocialLinkType.md +++ b/docs/api/redditapi/models/enumerations/SocialLinkType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md b/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md index 08b15ba7..5142cbde 100644 --- a/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md +++ b/docs/api/redditapi/models/enumerations/WikiPagePermissionLevel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getModerationLog.md b/docs/api/redditapi/models/functions/getModerationLog.md index 5d41f93f..30f51616 100644 --- a/docs/api/redditapi/models/functions/getModerationLog.md +++ b/docs/api/redditapi/models/functions/getModerationLog.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditInfoById.md b/docs/api/redditapi/models/functions/getSubredditInfoById.md index 7040862a..38c4215e 100644 --- a/docs/api/redditapi/models/functions/getSubredditInfoById.md +++ b/docs/api/redditapi/models/functions/getSubredditInfoById.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditInfoByName.md b/docs/api/redditapi/models/functions/getSubredditInfoByName.md index 54f1d8d2..29b34cf4 100644 --- a/docs/api/redditapi/models/functions/getSubredditInfoByName.md +++ b/docs/api/redditapi/models/functions/getSubredditInfoByName.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditLeaderboard.md b/docs/api/redditapi/models/functions/getSubredditLeaderboard.md index 3ddb6a23..1d8c04ae 100644 --- a/docs/api/redditapi/models/functions/getSubredditLeaderboard.md +++ b/docs/api/redditapi/models/functions/getSubredditLeaderboard.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getSubredditStyles.md b/docs/api/redditapi/models/functions/getSubredditStyles.md index 4db78c3a..5c011bfc 100644 --- a/docs/api/redditapi/models/functions/getSubredditStyles.md +++ b/docs/api/redditapi/models/functions/getSubredditStyles.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getVaultByAddress.md b/docs/api/redditapi/models/functions/getVaultByAddress.md index e5fa2e76..854474b1 100644 --- a/docs/api/redditapi/models/functions/getVaultByAddress.md +++ b/docs/api/redditapi/models/functions/getVaultByAddress.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/functions/getVaultByUserId.md b/docs/api/redditapi/models/functions/getVaultByUserId.md index d66f87d6..9aedc145 100644 --- a/docs/api/redditapi/models/functions/getVaultByUserId.md +++ b/docs/api/redditapi/models/functions/getVaultByUserId.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/interfaces/ModAction.md b/docs/api/redditapi/models/interfaces/ModAction.md index 7cb9f9be..91b7e5d7 100644 --- a/docs/api/redditapi/models/interfaces/ModAction.md +++ b/docs/api/redditapi/models/interfaces/ModAction.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md b/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md index 20242124..1af42e9f 100644 --- a/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md +++ b/docs/api/redditapi/models/type-aliases/AboutSubredditTypes.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md b/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md index c4d5f09f..383e7997 100644 --- a/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md +++ b/docs/api/redditapi/models/type-aliases/AddRemovalNoteOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AddWidgetData.md b/docs/api/redditapi/models/type-aliases/AddWidgetData.md index 5ba5d416..094c6474 100644 --- a/docs/api/redditapi/models/type-aliases/AddWidgetData.md +++ b/docs/api/redditapi/models/type-aliases/AddWidgetData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md b/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md index 27a2d442..d1e28fd1 100644 --- a/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md +++ b/docs/api/redditapi/models/type-aliases/AllowableFlairContent.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md b/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md index 39759bed..af48e6e3 100644 --- a/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/BackgroundImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BanUserOptions.md b/docs/api/redditapi/models/type-aliases/BanUserOptions.md index 6ea0e5fd..6418c030 100644 --- a/docs/api/redditapi/models/type-aliases/BanUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/BanUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md b/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md index 9ba3e32e..1386ffa7 100644 --- a/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md +++ b/docs/api/redditapi/models/type-aliases/BanWikiContributorOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/BannerHeight.md b/docs/api/redditapi/models/type-aliases/BannerHeight.md index 3c479962..8c024ce1 100644 --- a/docs/api/redditapi/models/type-aliases/BannerHeight.md +++ b/docs/api/redditapi/models/type-aliases/BannerHeight.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md b/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md index 87366723..4dbc37df 100644 --- a/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md +++ b/docs/api/redditapi/models/type-aliases/CommentMediaTypes.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentSort.md b/docs/api/redditapi/models/type-aliases/CommentSort.md index 114f0609..19453b20 100644 --- a/docs/api/redditapi/models/type-aliases/CommentSort.md +++ b/docs/api/redditapi/models/type-aliases/CommentSort.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md b/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md index f8672541..e4c951db 100644 --- a/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md +++ b/docs/api/redditapi/models/type-aliases/CommentSubmissionOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommonFlair.md b/docs/api/redditapi/models/type-aliases/CommonFlair.md index 6b886f01..3a2b538b 100644 --- a/docs/api/redditapi/models/type-aliases/CommonFlair.md +++ b/docs/api/redditapi/models/type-aliases/CommonFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md b/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md index f8b10640..c2071398 100644 --- a/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/CommonSubmitPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md b/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md index 72772b45..f10b1dcc 100644 --- a/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md +++ b/docs/api/redditapi/models/type-aliases/CommunityNameFormat.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationData.md b/docs/api/redditapi/models/type-aliases/ConversationData.md index 28e7e726..db28dd43 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationData.md +++ b/docs/api/redditapi/models/type-aliases/ConversationData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationResponse.md b/docs/api/redditapi/models/type-aliases/ConversationResponse.md index ba8ddaf4..f2d3fab8 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationResponse.md +++ b/docs/api/redditapi/models/type-aliases/ConversationResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md b/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md index 3cadd6f4..5c358808 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md +++ b/docs/api/redditapi/models/type-aliases/ConversationStateFilter.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ConversationUserData.md b/docs/api/redditapi/models/type-aliases/ConversationUserData.md index e3f619d6..b500c747 100644 --- a/docs/api/redditapi/models/type-aliases/ConversationUserData.md +++ b/docs/api/redditapi/models/type-aliases/ConversationUserData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md b/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md index 79b1ed1a..2e8c3d99 100644 --- a/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateFlairTemplateOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md b/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md index d2a04014..8db6955a 100644 --- a/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateModNoteOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md b/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md index 21d6aa0b..0b9b4ec5 100644 --- a/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateRelationshipOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md b/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md index 194278a9..2ca8208c 100644 --- a/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateRuleOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md b/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md index 25207660..c6ebc089 100644 --- a/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/CreateWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CrosspostOptions.md b/docs/api/redditapi/models/type-aliases/CrosspostOptions.md index ab8bdbb8..5f339282 100644 --- a/docs/api/redditapi/models/type-aliases/CrosspostOptions.md +++ b/docs/api/redditapi/models/type-aliases/CrosspostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md b/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md index 5b51680c..d9925469 100644 --- a/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md +++ b/docs/api/redditapi/models/type-aliases/CrowdControlLevel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md b/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md deleted file mode 100644 index 64168a3d..00000000 --- a/docs/api/redditapi/models/type-aliases/CustomPostRichTextFallback.md +++ /dev/null @@ -1,7 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) - -*** - -# Type Alias: CustomPostRichTextFallback - -> **CustomPostRichTextFallback** = `RichTextBuilder` \| `string` diff --git a/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md b/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md deleted file mode 100644 index 3a50a560..00000000 --- a/docs/api/redditapi/models/type-aliases/CustomPostTextFallbackOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) - -*** - -# Type Alias: CustomPostTextFallbackOptions - -> **CustomPostTextFallbackOptions** = \{ `text`: `string`; \} \| \{ `richtext`: [`CustomPostRichTextFallback`](CustomPostRichTextFallback.md); \} - -## Type declaration - -\{ `text`: `string`; \} - -### text - -> **text**: `string` - -May also include markdown. See https://www.reddit.com/r/reddit.com/wiki/markdown/ - -\{ `richtext`: [`CustomPostRichTextFallback`](CustomPostRichTextFallback.md); \} - -### richtext - -> **richtext**: [`CustomPostRichTextFallback`](CustomPostRichTextFallback.md) diff --git a/docs/api/redditapi/models/type-aliases/CustomizationFlag.md b/docs/api/redditapi/models/type-aliases/CustomizationFlag.md index 5dd7ac1a..6859ff55 100644 --- a/docs/api/redditapi/models/type-aliases/CustomizationFlag.md +++ b/docs/api/redditapi/models/type-aliases/CustomizationFlag.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md b/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md index 70465676..81f790f3 100644 --- a/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md +++ b/docs/api/redditapi/models/type-aliases/DeleteNotesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/EditCommentOptions.md b/docs/api/redditapi/models/type-aliases/EditCommentOptions.md index 4c684037..f2982a59 100644 --- a/docs/api/redditapi/models/type-aliases/EditCommentOptions.md +++ b/docs/api/redditapi/models/type-aliases/EditCommentOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md b/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md index 15555e64..06a3b564 100644 --- a/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md +++ b/docs/api/redditapi/models/type-aliases/EditFlairTemplateOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md b/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md index 1d127b63..a8b71a4c 100644 --- a/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md +++ b/docs/api/redditapi/models/type-aliases/EnrichedThumbnail.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md b/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md index c8b7fc5d..756dff70 100644 --- a/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md +++ b/docs/api/redditapi/models/type-aliases/FlairBackgroundColor.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/FlairSettings.md b/docs/api/redditapi/models/type-aliases/FlairSettings.md index 980148e8..20b53767 100644 --- a/docs/api/redditapi/models/type-aliases/FlairSettings.md +++ b/docs/api/redditapi/models/type-aliases/FlairSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/FlairTextColor.md b/docs/api/redditapi/models/type-aliases/FlairTextColor.md index b9569ba3..04124167 100644 --- a/docs/api/redditapi/models/type-aliases/FlairTextColor.md +++ b/docs/api/redditapi/models/type-aliases/FlairTextColor.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GalleryMedia.md b/docs/api/redditapi/models/type-aliases/GalleryMedia.md index c4c6a5cd..30e4a3c6 100644 --- a/docs/api/redditapi/models/type-aliases/GalleryMedia.md +++ b/docs/api/redditapi/models/type-aliases/GalleryMedia.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md b/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md index 05065332..e9396023 100644 --- a/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md +++ b/docs/api/redditapi/models/type-aliases/GalleryMediaStatus.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md index 466ab521..131ec963 100644 --- a/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetBestPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md b/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md index 729ed32d..5da82ff2 100644 --- a/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetCommentsByUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md b/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md index 662e11dc..4a7c6ec6 100644 --- a/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetCommentsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationResponse.md b/docs/api/redditapi/models/type-aliases/GetConversationResponse.md index b827a648..1fdf6585 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md b/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md index 6d6baf1a..8aa6c2d5 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationsRequest.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md b/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md index 18b41467..7d06b58e 100644 --- a/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetConversationsResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md b/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md index 806b72cc..e706c0aa 100644 --- a/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetDuplicatesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md index 51ad2185..17645a02 100644 --- a/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetHotPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md b/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md index 628e6127..bf53647d 100644 --- a/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetModNotesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md b/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md index f1901a0d..9f4c4eed 100644 --- a/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetModerationLogOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md b/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md index 8e564143..b80cec02 100644 --- a/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPageRevisionsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md b/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md index 2782bb51..b2803036 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsByUserOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetPostsOptions.md index 9f1780ab..f14b7379 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md b/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md index cadf2831..db7ac100 100644 --- a/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md +++ b/docs/api/redditapi/models/type-aliases/GetPostsOptionsWithTimeframe.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md b/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md index 666e5035..188fecef 100644 --- a/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetPrivateMessagesOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md b/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md index c956a9a7..0eb62812 100644 --- a/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetSortedPostsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md b/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md index 78d1fe89..c57848bd 100644 --- a/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetSubredditUsersByTypeOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md index edc96128..0c023c20 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md index 55bcac5f..100dc01f 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairBySubredditResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md b/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md index 327bae5f..c719d678 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md b/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md index 5b188203..433337ec 100644 --- a/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md +++ b/docs/api/redditapi/models/type-aliases/GetUserOverviewOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ImagePosition.md b/docs/api/redditapi/models/type-aliases/ImagePosition.md index 65860253..50aa2dc3 100644 --- a/docs/api/redditapi/models/type-aliases/ImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/ImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md b/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md index 96510d46..f5205395 100644 --- a/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/InternalSetPostFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/LinkFlair.md b/docs/api/redditapi/models/type-aliases/LinkFlair.md index 86a3147a..85e554c9 100644 --- a/docs/api/redditapi/models/type-aliases/LinkFlair.md +++ b/docs/api/redditapi/models/type-aliases/LinkFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md b/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md index b6849024..381e2b73 100644 --- a/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md +++ b/docs/api/redditapi/models/type-aliases/ListingFetchOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md b/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md index 3735d56b..d6da15f1 100644 --- a/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md +++ b/docs/api/redditapi/models/type-aliases/ListingFetchResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MenuPosition.md b/docs/api/redditapi/models/type-aliases/MenuPosition.md index 26d6e0bc..1821a173 100644 --- a/docs/api/redditapi/models/type-aliases/MenuPosition.md +++ b/docs/api/redditapi/models/type-aliases/MenuPosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MessageData.md b/docs/api/redditapi/models/type-aliases/MessageData.md index 9a3a336b..9eeb8e37 100644 --- a/docs/api/redditapi/models/type-aliases/MessageData.md +++ b/docs/api/redditapi/models/type-aliases/MessageData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionData.md b/docs/api/redditapi/models/type-aliases/ModActionData.md index f33f7979..8b655901 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionData.md +++ b/docs/api/redditapi/models/type-aliases/ModActionData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionTarget.md b/docs/api/redditapi/models/type-aliases/ModActionTarget.md index 78028adf..4061cae7 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionTarget.md +++ b/docs/api/redditapi/models/type-aliases/ModActionTarget.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModActionType.md b/docs/api/redditapi/models/type-aliases/ModActionType.md index 3a910bba..750be67c 100644 --- a/docs/api/redditapi/models/type-aliases/ModActionType.md +++ b/docs/api/redditapi/models/type-aliases/ModActionType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModLogOptions.md b/docs/api/redditapi/models/type-aliases/ModLogOptions.md index 81b8340c..869b96fb 100644 --- a/docs/api/redditapi/models/type-aliases/ModLogOptions.md +++ b/docs/api/redditapi/models/type-aliases/ModLogOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModNoteType.md b/docs/api/redditapi/models/type-aliases/ModNoteType.md index 5a9e79c4..a8e21b6f 100644 --- a/docs/api/redditapi/models/type-aliases/ModNoteType.md +++ b/docs/api/redditapi/models/type-aliases/ModNoteType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ModeratorPermission.md b/docs/api/redditapi/models/type-aliases/ModeratorPermission.md index 37816281..2c130062 100644 --- a/docs/api/redditapi/models/type-aliases/ModeratorPermission.md +++ b/docs/api/redditapi/models/type-aliases/ModeratorPermission.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/MoreObject.md b/docs/api/redditapi/models/type-aliases/MoreObject.md index 5a869713..5a7661ff 100644 --- a/docs/api/redditapi/models/type-aliases/MoreObject.md +++ b/docs/api/redditapi/models/type-aliases/MoreObject.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/OEmbed.md b/docs/api/redditapi/models/type-aliases/OEmbed.md index 9917d119..3b4e16bb 100644 --- a/docs/api/redditapi/models/type-aliases/OEmbed.md +++ b/docs/api/redditapi/models/type-aliases/OEmbed.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Participant.md b/docs/api/redditapi/models/type-aliases/Participant.md index b192512d..54058fb0 100644 --- a/docs/api/redditapi/models/type-aliases/Participant.md +++ b/docs/api/redditapi/models/type-aliases/Participant.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PollData.md b/docs/api/redditapi/models/type-aliases/PollData.md index b6adf12b..2a2ffaa8 100644 --- a/docs/api/redditapi/models/type-aliases/PollData.md +++ b/docs/api/redditapi/models/type-aliases/PollData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PollOption.md b/docs/api/redditapi/models/type-aliases/PollOption.md index 751e821c..b889a0df 100644 --- a/docs/api/redditapi/models/type-aliases/PollOption.md +++ b/docs/api/redditapi/models/type-aliases/PollOption.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md b/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md index 861f65f0..52aa14a8 100644 --- a/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md +++ b/docs/api/redditapi/models/type-aliases/PositionedImagePosition.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostCapabilities.md b/docs/api/redditapi/models/type-aliases/PostCapabilities.md index 7e033648..7c89b225 100644 --- a/docs/api/redditapi/models/type-aliases/PostCapabilities.md +++ b/docs/api/redditapi/models/type-aliases/PostCapabilities.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md b/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md index 4289d7f3..ab7a8708 100644 --- a/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md +++ b/docs/api/redditapi/models/type-aliases/PostSuggestedCommentSort.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostTextOptions.md b/docs/api/redditapi/models/type-aliases/PostTextOptions.md index 0e82992d..4b2984b2 100644 --- a/docs/api/redditapi/models/type-aliases/PostTextOptions.md +++ b/docs/api/redditapi/models/type-aliases/PostTextOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/PostType.md b/docs/api/redditapi/models/type-aliases/PostType.md index 3c97235b..7ac51df2 100644 --- a/docs/api/redditapi/models/type-aliases/PostType.md +++ b/docs/api/redditapi/models/type-aliases/PostType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RedditVideo.md b/docs/api/redditapi/models/type-aliases/RedditVideo.md index 701daef0..c1efea50 100644 --- a/docs/api/redditapi/models/type-aliases/RedditVideo.md +++ b/docs/api/redditapi/models/type-aliases/RedditVideo.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RelationshipType.md b/docs/api/redditapi/models/type-aliases/RelationshipType.md index 67a37d7d..4e2d0d5e 100644 --- a/docs/api/redditapi/models/type-aliases/RelationshipType.md +++ b/docs/api/redditapi/models/type-aliases/RelationshipType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RemovalReason.md b/docs/api/redditapi/models/type-aliases/RemovalReason.md index 4f8e1cc4..ce1615b4 100644 --- a/docs/api/redditapi/models/type-aliases/RemovalReason.md +++ b/docs/api/redditapi/models/type-aliases/RemovalReason.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md b/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md index 4934f033..565dc709 100644 --- a/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md +++ b/docs/api/redditapi/models/type-aliases/RemoveRelationshipOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md b/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md index 597ae2d5..de3ce218 100644 --- a/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md +++ b/docs/api/redditapi/models/type-aliases/ReplyToCommentOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SecureMedia.md b/docs/api/redditapi/models/type-aliases/SecureMedia.md index a8c018bd..2cb1e6e7 100644 --- a/docs/api/redditapi/models/type-aliases/SecureMedia.md +++ b/docs/api/redditapi/models/type-aliases/SecureMedia.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md b/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md index 527f0e24..7e3f06fb 100644 --- a/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md +++ b/docs/api/redditapi/models/type-aliases/SendPrivateMessageAsSubredditOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md b/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md index 89a30c47..5f9db1eb 100644 --- a/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md +++ b/docs/api/redditapi/models/type-aliases/SendPrivateMessageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetFlairOptions.md index 7c0837e2..67517877 100644 --- a/docs/api/redditapi/models/type-aliases/SetFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md index 7aba5dad..07ba4916 100644 --- a/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetPostFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md b/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md index 4ad94277..06658097 100644 --- a/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md +++ b/docs/api/redditapi/models/type-aliases/SetUserFlairBatchConfig.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md b/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md index 1d255f47..2aaa3d0d 100644 --- a/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md +++ b/docs/api/redditapi/models/type-aliases/SetUserFlairOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md deleted file mode 100644 index e89a6489..00000000 --- a/docs/api/redditapi/models/type-aliases/SubmitCustomPostOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) - -*** - -# Type Alias: SubmitCustomPostOptions - -> **SubmitCustomPostOptions** = [`CommonSubmitPostOptions`](CommonSubmitPostOptions.md) & [`SubmitCustomPostTextFallbackOptions`](SubmitCustomPostTextFallbackOptions.md) & `object` - -## Type declaration - -### postData? - -> `optional` **postData**: `PostData` - -### preview - -> **preview**: `JSX.Element` - -### userGeneratedContent? - -> `optional` **userGeneratedContent**: `UserGeneratedContent` diff --git a/docs/api/redditapi/models/type-aliases/SubmitCustomPostTextFallbackOptions.md b/docs/api/redditapi/models/type-aliases/SubmitCustomPostTextFallbackOptions.md deleted file mode 100644 index 13f873d5..00000000 --- a/docs/api/redditapi/models/type-aliases/SubmitCustomPostTextFallbackOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) - -*** - -# Type Alias: SubmitCustomPostTextFallbackOptions - -> **SubmitCustomPostTextFallbackOptions** = `object` - -## Properties - - - -### textFallback? - -> `optional` **textFallback**: [`CustomPostTextFallbackOptions`](CustomPostTextFallbackOptions.md) diff --git a/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md b/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md index d9940ce1..580c0465 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitLinkOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** @@ -8,16 +8,6 @@ ## Type declaration -### ~~resubmit?~~ - -> `optional` **resubmit**: `boolean` - -#### Deprecated - -Unsupported. This property is for backwards compatibility and -has no effect. It will removed in a future version. New code should not -use it. - ### url > **url**: `string` diff --git a/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md b/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md index 5dd14464..a3fb998a 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitMediaOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md index 14628857..d7941175 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitPostOptions.md @@ -1,10 +1,10 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** # Type Alias: SubmitPostOptions -> **SubmitPostOptions** = [`SubmitLinkOptions`](SubmitLinkOptions.md) \| [`SubmitSelfPostOptions`](SubmitSelfPostOptions.md) \| [`SubmitCustomPostOptions`](SubmitCustomPostOptions.md) \| [`SubmitMediaOptions`](SubmitMediaOptions.md) & `object` +> **SubmitPostOptions** = [`SubmitLinkOptions`](SubmitLinkOptions.md) \| [`SubmitSelfPostOptions`](SubmitSelfPostOptions.md) \| [`SubmitMediaOptions`](SubmitMediaOptions.md) & `object` ## Type declaration diff --git a/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md b/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md index e6a4cabf..13c05273 100644 --- a/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubmitSelfPostOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditData.md b/docs/api/redditapi/models/type-aliases/SubredditData.md index 13dc28e3..5be7325f 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditData.md +++ b/docs/api/redditapi/models/type-aliases/SubredditData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditInfo.md b/docs/api/redditapi/models/type-aliases/SubredditInfo.md index 88ba56f4..a8504773 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditInfo.md +++ b/docs/api/redditapi/models/type-aliases/SubredditInfo.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md index c470cd0b..010a2561 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboard.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md index af5e297f..46808441 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummary.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md index 39702f64..03f66281 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md +++ b/docs/api/redditapi/models/type-aliases/SubredditLeaderboardSummaryRow.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditSettings.md b/docs/api/redditapi/models/type-aliases/SubredditSettings.md index b8fd2189..ccd0db19 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditSettings.md +++ b/docs/api/redditapi/models/type-aliases/SubredditSettings.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md b/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md index 5ad4adf5..6e03de21 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md +++ b/docs/api/redditapi/models/type-aliases/SubredditSettingsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditStyles.md b/docs/api/redditapi/models/type-aliases/SubredditStyles.md index 6238ee7b..c04cfa50 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditStyles.md +++ b/docs/api/redditapi/models/type-aliases/SubredditStyles.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/SubredditType.md b/docs/api/redditapi/models/type-aliases/SubredditType.md index 1319e2a2..53b4599c 100644 --- a/docs/api/redditapi/models/type-aliases/SubredditType.md +++ b/docs/api/redditapi/models/type-aliases/SubredditType.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Trophy.md b/docs/api/redditapi/models/type-aliases/Trophy.md index 82fe1f87..84e9aed0 100644 --- a/docs/api/redditapi/models/type-aliases/Trophy.md +++ b/docs/api/redditapi/models/type-aliases/Trophy.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md b/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md index ca18f635..0bde466b 100644 --- a/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md +++ b/docs/api/redditapi/models/type-aliases/UnreadCountResponse.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md b/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md index af2972b0..047315d2 100644 --- a/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdatePageSettingsOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md b/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md index e1e642c9..60d03f1c 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdateRuleOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md b/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md index 02924d29..0fc25b96 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md +++ b/docs/api/redditapi/models/type-aliases/UpdateWidgetData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md b/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md index de64802f..c5f59775 100644 --- a/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/UpdateWikiPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserFlair.md b/docs/api/redditapi/models/type-aliases/UserFlair.md index b86d7e24..16d849f2 100644 --- a/docs/api/redditapi/models/type-aliases/UserFlair.md +++ b/docs/api/redditapi/models/type-aliases/UserFlair.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md b/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md index cf9eda07..e11ff580 100644 --- a/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md +++ b/docs/api/redditapi/models/type-aliases/UserFlairPageOptions.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserNote.md b/docs/api/redditapi/models/type-aliases/UserNote.md index 18faa819..ac4d2602 100644 --- a/docs/api/redditapi/models/type-aliases/UserNote.md +++ b/docs/api/redditapi/models/type-aliases/UserNote.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserNoteLabel.md b/docs/api/redditapi/models/type-aliases/UserNoteLabel.md index 6f662020..2ad8d64d 100644 --- a/docs/api/redditapi/models/type-aliases/UserNoteLabel.md +++ b/docs/api/redditapi/models/type-aliases/UserNoteLabel.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/UserSocialLink.md b/docs/api/redditapi/models/type-aliases/UserSocialLink.md index e0fa31f0..ccbfd80e 100644 --- a/docs/api/redditapi/models/type-aliases/UserSocialLink.md +++ b/docs/api/redditapi/models/type-aliases/UserSocialLink.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Vault.md b/docs/api/redditapi/models/type-aliases/Vault.md index baea3031..705b8d78 100644 --- a/docs/api/redditapi/models/type-aliases/Vault.md +++ b/docs/api/redditapi/models/type-aliases/Vault.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/Visibility.md b/docs/api/redditapi/models/type-aliases/Visibility.md index 591c629e..8677c299 100644 --- a/docs/api/redditapi/models/type-aliases/Visibility.md +++ b/docs/api/redditapi/models/type-aliases/Visibility.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WikiEditMode.md b/docs/api/redditapi/models/type-aliases/WikiEditMode.md index 3f77c178..e7a0b7f7 100644 --- a/docs/api/redditapi/models/type-aliases/WikiEditMode.md +++ b/docs/api/redditapi/models/type-aliases/WikiEditMode.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md b/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md index ce6cfad2..25649d12 100644 --- a/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md +++ b/docs/api/redditapi/models/type-aliases/WikiPageRevisionId.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/type-aliases/WithUserData.md b/docs/api/redditapi/models/type-aliases/WithUserData.md index 5c812f22..eb132188 100644 --- a/docs/api/redditapi/models/type-aliases/WithUserData.md +++ b/docs/api/redditapi/models/type-aliases/WithUserData.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) *** diff --git a/docs/api/redditapi/models/variables/GalleryMediaStatus.md b/docs/api/redditapi/models/variables/GalleryMediaStatus.md index f7d8076d..1a23fa0a 100644 --- a/docs/api/redditapi/models/variables/GalleryMediaStatus.md +++ b/docs/api/redditapi/models/variables/GalleryMediaStatus.md @@ -1,4 +1,4 @@ -[**@devvit/public-api v0.12.25-dev**](../../README.md) +[**@devvit/public-api v0.13.1-dev**](../../README.md) ***