RemoveUserIdFromGroup

Remove a user, by ID, from a group

public bool RemoveUserIdFromGroup(string userId, Platform platform, string groupName)
userId
string required

The unique ID for this user

platform
Streamer.bot.Plugin.Interface.Enums.Platform required

The platform this user belongs to

Possible values:

  • Platform.Twitch
  • Platform.YouTube
  • Platform.Kick
groupName
string required

The name of the group

bool

using System;
public class CPHInline
{
    public bool Execute()
    {
        //Define the groupname you want to add the user to
        string groupName = "Test Group";
        //Get userId of current user
        CPH.TryGetArg("userId",out string userId);

        //Get user type and define the Platform Enum
        CPH.TryGetArg("userType",out string userType);
        Enum.TryParse(userType, out Platform platform);

        //Method returns a bool type which you can check if the user was removed
        bool userGotRemoved = CPH.RemoveUserIdFromGroup(userId, platform, groupName);         return true;
    }
}