summaryrefslogtreecommitdiff
path: root/docs/stream/notifications.md
blob: 7be6f0c837af43f599e5e702f3f62122d91b8e8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# Stream notifications

The `!notify` command gives users the ability to manage event subscriptions.

## Syntax

### Subscribe to the event
`!notify sub [name]:[type]`

+ `[name]` - Twitch username or event name *(custom type only)*.
+ `[type]` - [Event type](/wiki/stream/events#event-types).

### Unsubscribe from the event
`!notify unsub [name]:[type]`

+ `[name]` - Twitch username or event name *(custom type only)*.
+ `[type]` - [Event type](/wiki/stream/events#event-types).

### Get your event subscriptions
`!notify subs`

### Get available events to subscribe
`!notify list`

## Usage

### Subscribing to the event

+ `!notify sub forsen:live`

### Unsubscribing from the event

+ `!notify unsub forsen:live`

## Responses

### Subscribing to the event

+ If you're not a subscriber

`You have successfully subscribed to the "forsen:live" event!`

+ If you're already a subscriber

`You're already a subscriber to the "forsen:live" event.`

### Unsubscribing from the event

+ If you're not a subscriber

`You're not subscribed to the "forsen:live" event.`

+ If you're a subscriber

`You have successfully unsubscribed from the "forsen:live" event!`

### Getting event subscriptions

+ If you're subscribed to at least one event

`Your subscriptions: forsen:live, xqc:offline, nymn:title, ...`

+ Otherwise,

`You're not subscribed to any events.`

## Important notes

+ If the specified event name does not belong to a Twitch user, 
the event type will automatically be considered ***custom***.

## Error handling

+ [Not enough arguments](/wiki/errors#0)
+ [Incorrect argument](/wiki/errors#2)
+ [Not found](/wiki/errors#12)
+ [Something went wrong](/wiki/errors#127)