Skip to content

Commit 8d01ff7

Browse files
committed
docs(sdk): add emoji status-related docs
1 parent f746c5e commit 8d01ff7

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

apps/docs/.vitepress/packages.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ export const packagesLinksGenerator = (prefix: string = '') => {
109109
]),
110110
],
111111
'Utilities': [{ url: 'utils', page: false }, fromEntries([
112+
scope('emoji-status'),
112113
scope('links'),
113114
scope('privacy'),
114115
scope('uncategorized'),
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Emoji Status
2+
3+
## `requestEmojiStatusAccess`
4+
5+
To request access to user emoji status update, use the `requestEmojiStatusAccess` function:
6+
7+
::: code-group
8+
9+
```ts [Using isAvailable]
10+
import { requestEmojiStatusAccess } from '@telegram-apps/sdk';
11+
12+
if (requestEmojiStatusAccess.isAvailable()) {
13+
const status = await requestEmojiStatusAccess();
14+
}
15+
```
16+
17+
```ts [Using ifAvailable]
18+
import { requestEmojiStatusAccess } from '@telegram-apps/sdk';
19+
20+
const status = await requestEmojiStatusAccess.ifAvailable();
21+
```
22+
23+
:::
24+
25+
## `setEmojiStatus`
26+
27+
To set an emoji status on user's behalf, use the `setEmojiStatus` function.
28+
29+
As the first argument, it accepts a custom emoji id. Optionally, you can pass the second
30+
argument determining for how many seconds the status must be set.
31+
32+
::: code-group
33+
34+
```ts [Using isAvailable]
35+
import { setEmojiStatus } from '@telegram-apps/sdk';
36+
37+
if (setEmojiStatus.isAvailable()) {
38+
// Set for unlimited period of time.
39+
await setEmojiStatus('5361800828313167608');
40+
41+
// Set for 1 day.
42+
await setEmojiStatus('5361800828313167608', 86400);
43+
}
44+
```
45+
46+
```ts [Using ifAvailable]
47+
import { setEmojiStatus } from '@telegram-apps/sdk';
48+
49+
// Set for unlimited period of time.
50+
await setEmojiStatus.ifAvailable('5361800828313167608');
51+
52+
// Set for 1 day.
53+
await setEmojiStatus.ifAvailable('5361800828313167608', 86400);
54+
```
55+
56+
:::

0 commit comments

Comments
 (0)