s&box docs

public sealed struct Sandbox.StreamUser

Methods

Showing 5 methods

public void Ban(string reason, int duration = 0)

Ban user from your chat, the user will no longer be able to chat. Optionally specify the duration, a duration of zero means perm ban (Note: You have to be in your chat for this to work)

Parameters

  • duration: Default: 0

public System.Threading.Tasks.Task`1<Sandbox.StreamClip> CreateClip(bool hasDelay = False)

Create a clip of our stream, if we're streaming

Parameters

  • hasDelay: Default: False

public System.Threading.Tasks.Task`1<Sandbox.StreamPoll> CreatePoll(string title, int duration, string[] choices)

Start a poll on our channel with multiple choices, save the poll so you can end it later on

public System.Threading.Tasks.Task`1<Sandbox.StreamPrediction> CreatePrediction(string title, int duration, string firstOutcome, string secondOutcome)

Create a prediction on our channel to bet with channel points

public void Unban()

Unban user from your chat, this allows them to chat again (Note: You have to be in your chat for this to work)

Properties

Showing 13 properties

public string Sandbox.StreamUser.BroadcasterType { get; set; }

public System.DateTimeOffset Sandbox.StreamUser.CreatedAt { get; set; }

public string Sandbox.StreamUser.Description { get; set; }

public string Sandbox.StreamUser.DisplayName { get; set; }

public string Sandbox.StreamUser.Email { get; set; }

public System.Threading.Tasks.Task`1<System.Collections.Generic.List`1<Sandbox.StreamUserFollow>> Sandbox.StreamUser.Followers { get; set; }

Get followers "Who are we following"

public System.Threading.Tasks.Task`1<System.Collections.Generic.List`1<Sandbox.StreamUserFollow>> Sandbox.StreamUser.Following { get; set; }

Get following "Who is following us"

public string Sandbox.StreamUser.Login { get; set; }

public string Sandbox.StreamUser.OfflineImageUrl { get; set; }

public string Sandbox.StreamUser.ProfileImageUrl { get; set; }

public string Sandbox.StreamUser.UserType { get; set; }

public int Sandbox.StreamUser.ViewCount { get; set; }

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.StreamUser

On this page

Methodspublic System.Void Ban(System.String reason, System.Int32 duration = 0)public System.Threading.Tasks.Task`1<Sandbox.StreamClip> CreateClip(System.Boolean hasDelay = False)public System.Threading.Tasks.Task`1<Sandbox.StreamPoll> CreatePoll(System.String title, System.Int32 duration, System.String[] choices)public System.Threading.Tasks.Task`1<Sandbox.StreamPrediction> CreatePrediction(System.String title, System.Int32 duration, System.String firstOutcome, System.String secondOutcome)public System.Void Unban()Propertiespublic System.String Sandbox.StreamUser.BroadcasterType { get; set; }public System.DateTimeOffset Sandbox.StreamUser.CreatedAt { get; set; }public System.String Sandbox.StreamUser.Description { get; set; }public System.String Sandbox.StreamUser.DisplayName { get; set; }public System.String Sandbox.StreamUser.Email { get; set; }public System.Threading.Tasks.Task`1<System.Collections.Generic.List`1<Sandbox.StreamUserFollow>> Sandbox.StreamUser.Followers { get; set; }public System.Threading.Tasks.Task`1<System.Collections.Generic.List`1<Sandbox.StreamUserFollow>> Sandbox.StreamUser.Following { get; set; }public System.String Sandbox.StreamUser.Id { get; set; }public System.String Sandbox.StreamUser.Login { get; set; }public System.String Sandbox.StreamUser.OfflineImageUrl { get; set; }public System.String Sandbox.StreamUser.ProfileImageUrl { get; set; }public System.String Sandbox.StreamUser.UserType { get; set; }public System.Int32 Sandbox.StreamUser.ViewCount { get; set; }Metadata