Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor USERNOTICE models #250

Merged
merged 5 commits into from
Oct 22, 2023
Merged

Refactor USERNOTICE models #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
454f0a6
rewrite models
AoshiW Sep 19, 2023
99293fd
rewritten initialization of `ChatReply` and `HypeChat`
AoshiW Sep 21, 2023
0bebadf
constructors
AoshiW Sep 21, 2023
6f23723
fix `IsAnonymous`
Oct 3, 2023
6286f14
removed 'Params' suffix from class name
Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
230 changes: 71 additions & 159 deletions TwitchLib.Client.Models/Announcement.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,169 +1,81 @@
#nullable disable
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
using TwitchLib.Client.Enums;
using TwitchLib.Client.Models.Interfaces;
using TwitchLib.Client.Enums;
using TwitchLib.Client.Models.Internal;

namespace TwitchLib.Client.Models
{
/// <summary>Class representing Announcement in a Twitch channel.</summary>
public class Announcement : IHexColorProperty
{
/// <summary>Property representing announcement message id</summary>
public string Id { get; }

/// <summary>Property representing list of badges assigned.</summary>
public List<KeyValuePair<string, string>> Badges { get; }

/// <summary>Metadata associated with each badge</summary>
public List<KeyValuePair<string, string>> BadgeInfo { get; }

/// <summary>Property representing internal system message value.</summary>
public string SystemMessage { get; }

/// <summary>Property representing internal system message value, parsed.</summary>
public string SystemMessageParsed { get; }

/// <summary>Property representing whether or not the announcer is the broadcaster.</summary>
public bool IsBroadcaster { get; }

/// <summary>Property representing whether or not the announcer is a moderator.</summary>
public bool IsModerator { get; }

/// <summary>Property representing whether or not announcer is a partner.</summary>
public bool IsPartner { get; }

/// <summary>Property representing whether or not the announcer is a subscriber.</summary>
public bool IsSubscriber { get; }

/// <summary>Property representing whether or not the announcer is a twitch staff member.</summary>
public bool IsStaff { get; }

/// <summary>Property representing whether or not the announcer is a turbo member.</summary>
public bool IsTurbo { get; }

/// <summary>Property representing the user's login.</summary>
public string Login { get; }
namespace TwitchLib.Client.Models;

/// <summary>Property representing the user's id.</summary>
public string UserId { get; }

/// <summary>Property representing the room id.</summary>
public string RoomId { get; }

/// <summary>Property representing the user type of the announcer.</summary>
public UserType UserType { get; }

/// <summary>Property representing the tmi-sent-ts value.</summary>
public DateTimeOffset TmiSent { get; }

/// <summary>Property representing emote set of announcement.</summary>
public string EmoteSet { get; }

/// <summary>Property representing the raw IRC message (for debugging/customized parsing)</summary>
public string RawIrc { get; }

/// <summary>Property representing the msg-id value.</summary>
public string MsgId { get; }

/// <summary>Property representing the color value of the announcement.</summary>
public string MsgParamColor { get; }
/// <summary>Class representing Announcement in a Twitch channel.</summary>
public class Announcement : UserNoticeBase
{
/// <summary>Property representing the color value of the announcement.</summary>
public string MsgParamColor { get; protected set; } = default!;

/// <inheritdoc/>
public string HexColor { get; }
/// <summary>Property representing the message of the announcement.</summary>
public string Message { get; protected set; }

/// <summary>Property representing the message of the announcement.</summary>
public string Message { get; }
/// <summary>
/// Initializes a new instance of the <see cref="Announcement"/> class.
/// </summary>
/// <param name="ircMessage">The IRC message from Twitch to be processed.</param>
public Announcement(IrcMessage ircMessage) : base(ircMessage)
{
Message = ircMessage.Message;
}

/// <summary>
/// Contains undocumented tags.
/// </summary>
public Dictionary<string, string>? UndocumentedTags { get; }
/// <summary>
/// Initializes a new instance of the <see cref="Announcement"/> class.
/// </summary>
public Announcement(
List<KeyValuePair<string, string>> badgeInfo,
List<KeyValuePair<string, string>> badges,
string hexColor,
string displayMame,
string emotes,
string id,
string login,
bool isModerator,
string msgId,
string roomId,
bool isSubscriber,
string systemMsg,
DateTimeOffset tmiSent,
bool isTurbo,
string userId,
UserType userType,
Dictionary<string, string>? undocumentedTags,
string msgParamColor,
string message)
: base(badgeInfo,
badges,
hexColor,
displayMame,
emotes,
id,
login,
isModerator,
msgId, roomId,
isSubscriber,
systemMsg,
tmiSent,
isTurbo,
userId,
userType,
undocumentedTags)
{
MsgParamColor = msgParamColor;
Message = message;
}

/// SAMPLE: @badge-info=;badges=broadcaster/1,ambassador/1;color=#033700;display-name=BarryCarlyon;emotes=;flags=;id=55d90904-e515-47d0-ac1d-879f7f1d7b01;login=barrycarlyon;mod=0;msg-id=announcement;msg-param-color=PRIMARY;room-id=15185913;subscriber=0;system-msg=;tmi-sent-ts=1648758023469;user-id=15185913;user-type= :tmi.twitch.tv USERNOTICE #barrycarlyon :test announcment main
/// <summary>Announcement object constructor.</summary>
/// <param name="ircMessage">The IRC message from Twitch to be processed.</param>
public Announcement(IrcMessage ircMessage)
/// <inheritdoc/>
protected override bool TrySet(KeyValuePair<string, string> tag)
{
switch (tag.Key)
{
RawIrc = ircMessage.ToString();
Message = ircMessage.Message;
foreach (var tag in ircMessage.Tags)
{
var tagValue = tag.Value;
switch (tag.Key)
{
case Tags.Badges:
Badges = TagHelper.ToBadges(tagValue);
foreach (var badge in Badges)
{
switch (badge.Key)
{
case "broadcaster":
IsBroadcaster = true;
break;
case "turbo":
IsTurbo = true;
break;
case "moderator":
IsModerator = true;
break;
case "subscriber":
IsSubscriber = true;
break;
case "admin":
IsStaff = true;
break;
case "staff":
IsStaff = true;
break;
case "partner":
IsPartner = true;
break;
}
}
break;
case Tags.BadgeInfo:
BadgeInfo = TagHelper.ToBadges(tagValue);
break;
case Tags.Color:
HexColor = tagValue;
break;
case Tags.MsgParamColor:
MsgParamColor = tagValue;
break;
case Tags.Emotes:
EmoteSet = tagValue;
break;
case Tags.Id:
Id = tagValue;
break;
case Tags.Login:
Login = tagValue;
break;
case Tags.MsgId:
MsgId = tagValue;
break;
case Tags.RoomId:
RoomId = tagValue;
break;
case Tags.SystemMsg:
SystemMessage = tagValue;
SystemMessageParsed = tagValue.Replace("\\s", " ");
break;
case Tags.TmiSentTs:
TmiSent = TagHelper.ToDateTimeOffsetFromUnixMs(tagValue);
break;
case Tags.UserId:
UserId = tagValue;
break;
case Tags.UserType:
UserType = TagHelper.ToUserType(tag.Value);
break;
default:
(UndocumentedTags = new()).Add(tag.Key, tag.Value);
break;
}
}
case Tags.MsgParamColor:
MsgParamColor = tag.Value;
break;
default:
return false;
}
return true;
}
}
}
85 changes: 85 additions & 0 deletions TwitchLib.Client.Models/AnonGiftPaidUpgrade.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
using TwitchLib.Client.Enums;
using TwitchLib.Client.Models.Internal;

namespace TwitchLib.Client.Models;

public class AnonGiftPaidUpgrade : UserNoticeBase
{
/// <summary>
/// The number of gifts the gifter has given during the promo indicated by <see cref="MsgParamPromoName"/>.
/// </summary>
public int MsgParamPromoGiftTotal { get; protected set; }

/// <summary>
/// The subscriptions promo, if any, that is ongoing (for example, Subtember 2018).
/// </summary>
public string MsgParamPromoName { get; protected set; } = default!;

/// <summary>
/// Initializes a new instance of the <see cref="AnonGiftPaidUpgrade"/> class.
/// </summary>
public AnonGiftPaidUpgrade(IrcMessage ircMessage) : base(ircMessage)
{
}

/// <summary>
/// Initializes a new instance of the <see cref="AnonGiftPaidUpgrade"/> class.
/// </summary>
public AnonGiftPaidUpgrade(
List<KeyValuePair<string, string>> badgeInfo,
List<KeyValuePair<string, string>> badges,
string hexColor,
string displayMame,
string emotes,
string id,
string login,
bool isModerator,
string msgId,
string roomId,
bool isSubscriber,
string systemMsg,
DateTimeOffset tmiSent,
bool isTurbo,
string userId,
UserType userType,
Dictionary<string, string>? undocumentedTags,
int msgParamPromoGiftTotal,
string msgParamPromoName)
: base(badgeInfo,
badges,
hexColor,
displayMame,
emotes,
id,
login,
isModerator,
msgId, roomId,
isSubscriber,
systemMsg,
tmiSent,
isTurbo,
userId,
userType,
undocumentedTags)
{
MsgParamPromoGiftTotal = msgParamPromoGiftTotal;
MsgParamPromoName = msgParamPromoName;
}

/// <inheritdoc/>
protected override bool TrySet(KeyValuePair<string, string> tag)
{
switch (tag.Key)
{
case Tags.MsgParamPromoGiftTotal:
MsgParamPromoGiftTotal = int.Parse(tag.Value);
break;
case Tags.MsgParamPromoName:
MsgParamPromoName = tag.Value;
break;
default:
return false;
}
return true;
}
}
Loading