Skip to content

[DR-382] updated blocks example to devvit web in RedditAPIClient #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vdikransamarjian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[DR-382] updated blocks example to devvit web in RedditAPIClient #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions docs/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,29 @@

The Reddit API Client

To use the Reddit API Client, add it to the plugin configuration at the top of the file.
To use the Reddit API Client, enable the `redditAPI` permission in your `devvit.json` file.

```json title="devvit.json"
{
"permissions": {
"redditAPI": true
}
}
```

## Example

```ts

Devvit.configure({
redditAPI: true,
// other plugins
})

// use within one of our capability handlers e.g. Menu Actions, Triggers, Scheduled Job Type, etc
async (event, context) => {
const subreddit = await context.reddit.getSubredditById(context.subredditId);
context.reddit.submitPost({
subredditName: subreddit.name,
title: 'test post',
text: 'test body',
})
// additional code
}
import { reddit } from '@devvit/web/server';

export const menuActionHandler = async () => {
const subredditName = await reddit.getCurrentSubredditName();
return await reddit.submitPost({
subredditName,
title: 'test post',
text: 'test body',
});
};
```

## Constructors
Expand Down
36 changes: 19 additions & 17 deletions ...oned_docs/version-0.12/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,29 @@

The Reddit API Client

To use the Reddit API Client, add it to the plugin configuration at the top of the file.
To use the Reddit API Client, enable the `redditAPI` permission in your `devvit.json` file.

```json title="devvit.json"
{
"permissions": {
"redditAPI": true
}
}
```

## Example

```ts

Devvit.configure({
redditAPI: true,
// other plugins
})

// use within one of our capability handlers e.g. Menu Actions, Triggers, Scheduled Job Type, etc
async (event, context) => {
const subreddit = await context.reddit.getSubredditById(context.subredditId);
context.reddit.submitPost({
subredditName: subreddit.name,
title: 'test post',
text: 'test body',
})
// additional code
}
import { reddit } from '@devvit/web/server';

export const menuActionHandler = async () => {
const subredditName = await reddit.getCurrentSubredditName();
return await reddit.submitPost({
subredditName,
title: 'test post',
text: 'test body',
});
};
```

## Constructors
Expand Down
Loading