Skip to content

Commit 23cc91f

Browse files
MeixDevMeixDev
committed
Updated Readme
1 parent 3ae92e8 commit 23cc91f

File tree

1 file changed

+149
-145
lines changed

1 file changed

+149
-145
lines changed

‎README.md‎

Lines changed: 149 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,11 @@ You will also need to pass a `DiscordHttpClient` to it. You can either implement
3333
);
3434
```
3535

36-
Now that you initialized the client, the last step before using the endpoints wrappers will be to manage the first connection with your Discord application, and initialize the Tokens you'll receive. You can find a complete example of this in the [example](https://github.com/MeixDev/discord_api_flutter/blob/main/example/lib/main.dart), using the package [flutter_webview_plugin](https://pub.dev/packages/flutter_webview_plugin). You can also use url_launcher with deep linking, use an external window in web as described in [this article](https://itnext.io/flutter-web-oauth-authentication-through-external-window-d890a7ff6463) by my friend [TesteurManiak](https://github.com/TesteurManiak), or any other method that you fancy depending on your targeted systems.
36+
Now that you initialized the client, the last step before using the endpoints wrappers will be to manage the first connection with your Discord application, and initialize the Tokens you'll receive.
37+
38+
You can find a complete example of this in the [example](https://github.com/MeixDev/discord_api_flutter/blob/main/example/lib/main.dart), using the package [flutter_webview_plugin](https://pub.dev/packages/flutter_webview_plugin).
39+
40+
You can also use url_launcher with deep linking, use an external window in web as described in [this article](https://itnext.io/flutter-web-oauth-authentication-through-external-window-d890a7ff6463) by my friend [TesteurManiak](https://github.com/TesteurManiak), or any other method that you fancy depending on your targeted systems.
3741

3842
## Supported Endpoints
3943

@@ -42,184 +46,184 @@ _____
4246

4347
### User
4448

45-
[x] Get Current User
46-
[x] Get User
47-
[x] Modify Current User
48-
[x] Get Current User Guilds
49-
[x] Get Current User Guild Member
50-
[x] Leave Guild
51-
[x] Create DM
52-
[ ] Create Group DM
53-
[x] Get Current User Connections
49+
* [x] Get Current User
50+
* [x] Get User
51+
* [x] Modify Current User
52+
* [x] Get Current User Guilds
53+
* [x] Get Current User Guild Member
54+
* [x] Leave Guild
55+
* [x] Create DM
56+
* [ ] Create Group DM
57+
* [x] Get Current User Connections
5458

5559
### Guild
5660

57-
[x] Get Guild
58-
[x] Get Guild Preview
59-
[ ] Modify Guild
60-
[ ] Delete Guild
61-
[ ] Create Guild Channel
62-
[ ] Modify Guild Channel Positions
63-
[ ] List Active Threads
64-
[ ] Get Guild Member
65-
[ ] List Guild Members
66-
[ ] Search Guild Members
67-
[ ] Add Guild Member
68-
[ ] List Guild Members
69-
[ ] Search Guild Members
70-
[ ] Add Guild Member
71-
[ ] Modify Guild Member
72-
[ ] Modify Current Member
73-
[ ] Modify Current User Nick
74-
[ ] Add Guild Member Role
75-
[ ] Remove Guild Member Role
76-
[ ] Remove Guild Member
77-
[ ] Get Guild Bans
78-
[ ] Get Guild Ban
79-
[ ] Create Guild Ban
80-
[ ] Remove Guild Ban
81-
[ ] Get Guild Roles
82-
[ ] Create Guild Role
83-
[ ] Modify Guild Role Positions
84-
[ ] Modify Guild Role
85-
[ ] Delete Guild Role
86-
[ ] Get Guild Prune Count
87-
[ ] Begin Guild Prune
88-
[ ] Get Guild Voice Regions
89-
[ ] Get Guild Invites
90-
[ ] Get Guild Integrations
91-
[ ] Delete Guild Integration
92-
[ ] Get Guild Widget Settings
93-
[ ] Modify Guild Widget
94-
[ ] Get Guild Widget
95-
[ ] Get Guild Vanity URL
96-
[ ] Get Guild Widget Image
97-
[ ] Get Guild Welcome Screen
98-
[ ] Modify Guild Welcome Screen
99-
[ ] Modify Current User Voice State
100-
[ ] Modify User Voice State
61+
* [x] Get Guild
62+
* [x] Get Guild Preview
63+
* [ ] Modify Guild
64+
* [ ] Delete Guild
65+
* [ ] Create Guild Channel
66+
* [ ] Modify Guild Channel Positions
67+
* [ ] List Active Threads
68+
* [ ] Get Guild Member
69+
* [ ] List Guild Members
70+
* [ ] Search Guild Members
71+
* [ ] Add Guild Member
72+
* [ ] List Guild Members
73+
* [ ] Search Guild Members
74+
* [ ] Add Guild Member
75+
* [ ] Modify Guild Member
76+
* [ ] Modify Current Member
77+
* [ ] Modify Current User Nick
78+
* [ ] Add Guild Member Role
79+
* [ ] Remove Guild Member Role
80+
* [ ] Remove Guild Member
81+
* [ ] Get Guild Bans
82+
* [ ] Get Guild Ban
83+
* [ ] Create Guild Ban
84+
* [ ] Remove Guild Ban
85+
* [ ] Get Guild Roles
86+
* [ ] Create Guild Role
87+
* [ ] Modify Guild Role Positions
88+
* [ ] Modify Guild Role
89+
* [ ] Delete Guild Role
90+
* [ ] Get Guild Prune Count
91+
* [ ] Begin Guild Prune
92+
* [ ] Get Guild Voice Regions
93+
* [ ] Get Guild Invites
94+
* [ ] Get Guild Integrations
95+
* [ ] Delete Guild Integration
96+
* [ ] Get Guild Widget Settings
97+
* [ ] Modify Guild Widget
98+
* [ ] Get Guild Widget
99+
* [ ] Get Guild Vanity URL
100+
* [ ] Get Guild Widget Image
101+
* [ ] Get Guild Welcome Screen
102+
* [ ] Modify Guild Welcome Screen
103+
* [ ] Modify Current User Voice State
104+
* [ ] Modify User Voice State
101105

102106
### Emoji
103107

104-
[ ] List Guild Emojis
105-
[ ] Get Guild Emoji
106-
[ ] Create Guild Emoji
107-
[ ] Modify Guild Emoji
108-
[ ] Delete Guild Emoji
108+
* [ ] List Guild Emojis
109+
* [ ] Get Guild Emoji
110+
* [ ] Create Guild Emoji
111+
* [ ] Modify Guild Emoji
112+
* [ ] Delete Guild Emoji
109113

110114
### Channel
111115

112-
[ ] Get Channel
113-
[ ] Modify Channel
114-
[ ] Delete/Close Channel
115-
[ ] Get Channel Messages
116-
[ ] Get Channel Message
117-
[ ] Create Message
118-
[ ] Crosspost Message
119-
[ ] Create Reaction
120-
[ ] Delete Own Reaction
121-
[ ] Delete User Reaction
122-
[ ] Get Reactions
123-
[ ] Delete All Reactions
124-
[ ] Delete All Reactions for Emoji
125-
[ ] Edit Message
126-
[ ] Delete Message
127-
[ ] Bulk Delete Messages
128-
[ ] Edit Channel Permissions
129-
[ ] Get Channel Invites
130-
[ ] Create Channel Invite
131-
[ ] Delete Channel Permission
132-
[ ] Follow News Channel
133-
[ ] Trigger Typing Indicator
134-
[ ] Get Pinned Messages
135-
[ ] Pin Message
136-
[ ] Unpin Message
137-
[ ] Group DM Add Recipient
138-
[ ] Group DM Remove Recipient
139-
[ ] Start Thread with Message
140-
[ ] Start Thread without Message
141-
[ ] Join Thread
142-
[ ] Add Thread Member
143-
[ ] Leave Thread
144-
[ ] Remove Thread Member
145-
[ ] Get Thread Member
146-
[ ] List Thread Members
147-
[ ] List Active Threads
148-
[ ] List Public Archived Threads
149-
[ ] List Private Archived Threads
150-
[ ] List Joined Private Archive Threads
116+
* [ ] Get Channel
117+
* [ ] Modify Channel
118+
* [ ] Delete/Close Channel
119+
* [ ] Get Channel Messages
120+
* [ ] Get Channel Message
121+
* [ ] Create Message
122+
* [ ] Crosspost Message
123+
* [ ] Create Reaction
124+
* [ ] Delete Own Reaction
125+
* [ ] Delete User Reaction
126+
* [ ] Get Reactions
127+
* [ ] Delete All Reactions
128+
* [ ] Delete All Reactions for Emoji
129+
* [ ] Edit Message
130+
* [ ] Delete Message
131+
* [ ] Bulk Delete Messages
132+
* [ ] Edit Channel Permissions
133+
* [ ] Get Channel Invites
134+
* [ ] Create Channel Invite
135+
* [ ] Delete Channel Permission
136+
* [ ] Follow News Channel
137+
* [ ] Trigger Typing Indicator
138+
* [ ] Get Pinned Messages
139+
* [ ] Pin Message
140+
* [ ] Unpin Message
141+
* [ ] Group DM Add Recipient
142+
* [ ] Group DM Remove Recipient
143+
* [ ] Start Thread with Message
144+
* [ ] Start Thread without Message
145+
* [ ] Join Thread
146+
* [ ] Add Thread Member
147+
* [ ] Leave Thread
148+
* [ ] Remove Thread Member
149+
* [ ] Get Thread Member
150+
* [ ] List Thread Members
151+
* [ ] List Active Threads
152+
* [ ] List Public Archived Threads
153+
* [ ] List Private Archived Threads
154+
* [ ] List Joined Private Archive Threads
151155

152156
### Audit Logs
153157

154-
[ ] Get Guild Audit Log
158+
* [ ] Get Guild Audit Log
155159

156160
### Guild Scheduled Event
157161

158-
[ ] List Scheduled Events for Guild
159-
[ ] Create Guild Scheduled Event
160-
[ ] Get Guild Scheduled Event
161-
[ ] Modify Guild Scheduled Event
162-
[ ] Delete Guild Scheduled Event
163-
[ ] Get Guild Scheduled Event Users
164-
[ ] Guild Scheduled Event Status Update Automation
165-
[ ] Guild Scheduled Event Permissions Requirements
162+
* [ ] List Scheduled Events for Guild
163+
* [ ] Create Guild Scheduled Event
164+
* [ ] Get Guild Scheduled Event
165+
* [ ] Modify Guild Scheduled Event
166+
* [ ] Delete Guild Scheduled Event
167+
* [ ] Get Guild Scheduled Event Users
168+
* [ ] Guild Scheduled Event Status Update Automation
169+
* [ ] Guild Scheduled Event Permissions Requirements
166170

167171
### Guild Template
168172

169-
[ ] Get Guild Template
170-
[ ] Create Guild from Guild Template
171-
[ ] Get Guild Templates
172-
[ ] Create Guild Template
173-
[ ] Sync Guild Template
174-
[ ] Modify Guild Template
175-
[ ] Delete Guild Template
173+
* [ ] Get Guild Template
174+
* [ ] Create Guild from Guild Template
175+
* [ ] Get Guild Templates
176+
* [ ] Create Guild Template
177+
* [ ] Sync Guild Template
178+
* [ ] Modify Guild Template
179+
* [ ] Delete Guild Template
176180

177181
### Invite
178182

179-
[ ] Get Invite
180-
[ ] Delete Invite
183+
* [ ] Get Invite
184+
* [ ] Delete Invite
181185

182186
### Stage Instance
183187

184-
[ ] Create Stage Instance
185-
[ ] Get Stage Instance
186-
[ ] Modify Stage Instance
187-
[ ] Delete Stage Instance
188+
* [ ] Create Stage Instance
189+
* [ ] Get Stage Instance
190+
* [ ] Modify Stage Instance
191+
* [ ] Delete Stage Instance
188192

189193
### Sticker
190194

191-
[ ] Get Sticker
192-
[ ] List Nitro Sticker Packs
193-
[ ] List Guild Stickers
194-
[ ] Get Guild Sticker
195-
[ ] Create Guild Sticker
196-
[ ] Modify Guild Sticker
197-
[ ] Delete Guild Sticker
195+
* [ ] Get Sticker
196+
* [ ] List Nitro Sticker Packs
197+
* [ ] List Guild Stickers
198+
* [ ] Get Guild Sticker
199+
* [ ] Create Guild Sticker
200+
* [ ] Modify Guild Sticker
201+
* [ ] Delete Guild Sticker
198202

199203
### Voice
200204

201-
[ ] List Voice Regions
205+
* [ ] List Voice Regions
202206

203207
### Webhook
204208

205-
[ ] Create Webhook
206-
[ ] Get Channel Webhooks
207-
[ ] Get Guild Webhooks
208-
[ ] Get Webhook
209-
[ ] Get Webhook with Token
210-
[ ] Modify Webhook
211-
[ ] Modify Webhook with Token
212-
[ ] Delete Webhook
213-
[ ] Delete Webhook with Token
214-
[ ] Execute Webhook
215-
[ ] Execute Slack-Compatible Webhook
216-
[ ] Execute GitHub-Compatible Webhook
217-
[ ] Get Webhook Message
218-
[ ] Edit Webhook Message
219-
[ ] Delete Webhook Message
209+
* [ ] Create Webhook
210+
* [ ] Get Channel Webhooks
211+
* [ ] Get Guild Webhooks
212+
* [ ] Get Webhook
213+
* [ ] Get Webhook with Token
214+
* [ ] Modify Webhook
215+
* [ ] Modify Webhook with Token
216+
* [ ] Delete Webhook
217+
* [ ] Delete Webhook with Token
218+
* [ ] Execute Webhook
219+
* [ ] Execute Slack-Compatible Webhook
220+
* [ ] Execute GitHub-Compatible Webhook
221+
* [ ] Get Webhook Message
222+
* [ ] Edit Webhook Message
223+
* [ ] Delete Webhook Message
220224

221225
### OAuth2
222226

223-
[ ] Get Current Bot Application Information
224-
[ ] Get Current Authorization Information
227+
* [ ] Get Current Bot Application Information
228+
* [ ] Get Current Authorization Information
225229

0 commit comments

Comments
 (0)