Update RawEvent docs

This commit is contained in:
Szymon Uglis 2020-12-20 12:19:35 +01:00 committed by Szymon Uglis
parent 102650c81c
commit 6a25562ae1
No known key found for this signature in database
GPG key ID: 112376C5BEE91FE2
2 changed files with 2 additions and 0 deletions

View file

@ -1,6 +1,7 @@
part of nyxx;
/// Raw gateway event
/// RawEvent is dispatched ONLY for payload that doesn't match any event built in into Nyxx.
class RawEvent {
/// Shard where event was received
final Shard shard;

View file

@ -19,6 +19,7 @@ class ShardManager implements Disposable {
late final Stream<MemberChunkEvent> onMemberChunk = this._onMemberChunk.stream;
/// Raw gateway payloads. You have set `dispatchRawShardEvent` in [ClientOptions] to true otherwise stream won't receive any events.
/// Also rawEvent is dispatched ONLY for payload that doesn't match any event built in into Nyxx.
late final Stream<RawEvent> rawEvent = this._onRawEvent.stream;
final StreamController<Shard> _onConnect = StreamController.broadcast();