TwitchLib.EventSub.Websockets 0.3.0-preview-13e1cef

This is a prerelease version of TwitchLib.EventSub.Websockets.
There is a newer version of this package available.
See the version list below for details.
dotnet add package TwitchLib.EventSub.Websockets --version 0.3.0-preview-13e1cef                
NuGet\Install-Package TwitchLib.EventSub.Websockets -Version 0.3.0-preview-13e1cef                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TwitchLib.EventSub.Websockets" Version="0.3.0-preview-13e1cef" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TwitchLib.EventSub.Websockets --version 0.3.0-preview-13e1cef                
#r "nuget: TwitchLib.EventSub.Websockets, 0.3.0-preview-13e1cef"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install TwitchLib.EventSub.Websockets as a Cake Addin
#addin nuget:?package=TwitchLib.EventSub.Websockets&version=0.3.0-preview-13e1cef&prerelease

// Install TwitchLib.EventSub.Websockets as a Cake Tool
#tool nuget:?package=TwitchLib.EventSub.Websockets&version=0.3.0-preview-13e1cef&prerelease                

TwitchLib.EventSub.Websockets

TwitchLib component to connect to Twitch's EventSub service via Websockets also known as EventSockets

Disclaimer

EventSub via Websockets is still in open beta. You can use it in production but Twitch may introduce breaking changes without prior notice. The same goes for this implementation until it reaches Version 1.0.0

Prerequisites

  • Currently we only support setup via Dependency Injection

Resources

If you need help on how to setup Dependency Injection in your Console or WPF Application you can have a look at these guides:

You can also find a console app example for .NET 6 and for .NET Framework 4.8 in the repo.

Installation

NuGet TwitchLib.EventSub.Websockets
Package Manager PM> Install-Package TwitchLib.EventSub.Websockets -Version 0.2.0
.NET CLI > dotnet add package TwitchLib.EventSub.Websockets --version 0.2.0
PackageReference <PackageReference Include="TwitchLib.EventSub.Websockets" Version="0.2.0" />
Paket CLI > paket add TwitchLib.EventSub.Websockets --version 0.2.0

Setup

Step 1: Create a new project (Console, WPF, ASP.NET)

Step 2: Install the TwitchLib.EventSub.Websockets nuget package. (See above on how to do that)

Step 3: Step 3: Add necessary services and config to the DI Container

services.AddTwitchLibEventSubWebsockets();
services.AddHostedService<WebsocketHostedService>();

(The location of where to put this and the naming of variables might differ depending on what kind of project and general setup you have)

Step 4: Create the HostedService we just added to the DI container and connect to EventSub and listen to Events

using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using TwitchLib.EventSub.Websockets.Core.EventArgs;
using TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;

namespace TwitchLib.EventSub.Websockets.Test
{
    public class WebsocketHostedService : IHostedService
    {
        private readonly ILogger<WebsocketHostedService> _logger;
        private readonly EventSubWebsocketClient _eventSubWebsocketClient;

        public WebsocketHostedService(ILogger<WebsocketHostedService> logger, EventSubWebsocketClient eventSubWebsocketClient)
        {
            _logger = logger ?? throw new ArgumentNullException(nameof(logger));

            _eventSubWebsocketClient = eventSubWebsocketClient ?? throw new ArgumentNullException(nameof(eventSubWebsocketClient));
            _eventSubWebsocketClient.WebsocketConnected += OnWebsocketConnected;
            _eventSubWebsocketClient.WebsocketDisconnected += OnWebsocketDisconnected;
            _eventSubWebsocketClient.WebsocketReconnected += OnWebsocketReconnected;
            _eventSubWebsocketClient.ErrorOccurred += OnErrorOccurred;

            _eventSubWebsocketClient.ChannelFollow += OnChannelFollow;
        }

        public async Task StartAsync(CancellationToken cancellationToken)
        {
            await _eventSubWebsocketClient.ConnectAsync();
        }

        public async Task StopAsync(CancellationToken cancellationToken)
        {
            await _eventSubWebsocketClient.DisconnectAsync();
        }

        private void OnWebsocketConnected(object? sender, WebsocketConnectedArgs e)
        {
            _logger.LogInformation($"Websocket {_eventSubWebsocketClient.SessionId} connected!");

            if (!e.IsRequestedReconnect)
            {
                // subscribe to topics
            }
         }

        private async void OnWebsocketDisconnected(object? sender, EventArgs e)
        {
            _logger.LogError($"Websocket {_eventSubWebsocketClient.SessionId} disconnected!");

            // Don't do this in production. You should implement a better reconnect strategy with exponential backoff
            while (!await _eventSubWebsocketClient.ReconnectAsync())
            {
                _logger.LogError("Websocket reconnect failed!");
                await Task.Delay(1000);
            }
        }

        private void OnWebsocketReconnected(object? sender, EventArgs e)
        {
            _logger.LogWarning($"Websocket {_eventSubWebsocketClient.SessionId} reconnected");
        }      
      
         private void OnErrorOccurred(object? sender, ErrorOccuredArgs e)
        {
            _logger.LogError($"Websocket {_eventSubWebsocketClient.SessionId} - Error occurred!");
        }

        private void OnChannelFollow(object? sender, ChannelFollowArgs e)
        {
            var eventData = e.Notification.Payload.Event;
            _logger.LogInformation($"{eventData.UserName} followed {eventData.BroadcasterUserName} at {eventData.FollowedAt}");
        }
    }
}

Alternatively you can also just clone the examples:

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on TwitchLib.EventSub.Websockets:

Package Downloads
TwitchLib

Twitch C# library for accessing Twitch chat and whispers with events, Twitch API wrapper with every available API endpoint, PubSub wrapper and an Eventsub Websocket implementation

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on TwitchLib.EventSub.Websockets:

Repository Stars
songify-rocks/Songify
A simple tool that gets the current track from Spotify, YouTube and Nightbot.
Version Downloads Last updated
0.6.0-preview-dbc970c 81 11/6/2024
0.6.0-preview-cde682a 61 11/5/2024
0.6.0-preview-129f195 63 11/5/2024
0.5.0 2,103 4/11/2024
0.5.0-preview-ffc3181 242 7/31/2024
0.5.0-preview-ff1356d 111 6/12/2024
0.5.0-preview-fed1002 82 4/22/2024
0.5.0-preview-ef96f7f 83 4/11/2024
0.5.0-preview-d22efe0 90 4/11/2024
0.5.0-preview-cf9adcd 91 4/11/2024
0.5.0-preview-bcfc70a 96 5/20/2024
0.5.0-preview-bcc5801 92 6/17/2024
0.5.0-preview-abba5e7 135 6/25/2024
0.5.0-preview-a6ae325 261 10/30/2023
0.5.0-preview-72088d1 174 6/1/2023
0.5.0-preview-50e75fa 117 6/1/2023
0.5.0-preview-38d6070 121 6/1/2023
0.5.0-preview-10a6910 85 6/17/2024
0.4.0 2,310 5/9/2023
0.4.0-preview-7595d8b 111 5/9/2023
0.3.0 821 2/12/2023
0.3.0-preview-f4eee33 120 4/13/2023
0.3.0-preview-4523dce 123 5/9/2023
0.3.0-preview-34c0d87 134 2/11/2023
0.3.0-preview-13e1cef 129 2/11/2023
0.2.0 485 11/20/2022
0.2.0-preview-e561e8e 139 11/20/2022
0.2.0-preview-24aeaba 144 11/20/2022
0.1.0 335 11/8/2022
0.1.0-preview-ce4fc65 130 11/8/2022
0.1.0-preview-a65fad9 145 11/8/2022
0.1.0-preview-29bcaac 129 11/8/2022
0.1.0-preview-17203fa 129 11/8/2022
0.0.3 51,034 11/3/2022
0.0.3-preview-5d9eb3d 126 11/3/2022
0.0.2 377 11/1/2022
0.0.2-preview-d1dbff3 132 11/3/2022
0.0.2-preview-66f945c 128 11/1/2022
0.0.2-preview-1038807 133 11/3/2022

Updated TwitchLib.EventSub.Core for the latest SubscriptionType changes, Added Handlers for ShieldMode SubscriptionTypes