StreamingService
CreatorHub

Its interface does not cross the network boundary.

Instances of this class cannot be created with Instance.new.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Member index 0

History		Member
No members defined by StreamingService.
67 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
670		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
702		PredictionMode: PredictionMode
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
670		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
680		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Removed member index 25

History		Member
710		AttemptSaveAndSendPlaceTelemetry(requestId: string, toolSource: string): null
710		BindCodeToGuid(runCodeGuid: string, code: string): Tuple
655		DEPRECATED_RegisterCommand(commandName: string, function: Function = nil): null
655		DEPRECATED_RegisterSequentialCommand(commandName: string, function: Function = nil): null
710		ExecuteCommandAsync(requestId: string, commandName: string, arg: Variant): Variant
710		GetEphemeralVariable(key: string): Variant
710		GetInstance(requestId: string, instanceId: string): Instance
710		GetRequiredScripts(script: Instance): Variant
710		InvokeCommand(requestId: string, commandName: string, arg: Variant): null
649		RegisterCommand(commandName: string, function: Function = nil): null
710		RegisterCommandInternal(commandName: string, function: Function = nil, isSequential: bool = false, isPublic: bool = false): null
710		RegisterContextCollector(collectorName: string, function: Function = nil): null
649		RegisterSequentialCommand(commandName: string, function: Function = nil): null
710		RunSandboxedCode(runCodeGuid: string, requestId: string): Tuple
710		SearchForAssets(body: Variant): Variant
710		SetEphemeralVariable(key: string, value: Variant, timeToLive: int = -1): null
710		SetPluginInfoCallback(function: Function = nil): null
710		UnregisterCommand(commandName: string): null
710		UnregisterContextCollector(collectorName: string): null
710		ConversationCleared()
710		RequestEnded(requestId: string)
710		RequestError(requestId: string, errorType: string, errorMessage: string)
710		RequestStarted(requestId: string, queryToProcess: string)
710		SequentialCommandsFinished(requestId: string, success: bool)
710		Stream(requestId: string, commandName: string, streamContent: string)

Description

History 41
Hide member changes

710 Remove StreamingService
655 Remove DEPRECATED_RegisterSequentialCommand
655 Remove DEPRECATED_RegisterCommand
652 Add GetRequiredScripts
651 Add SearchForAssets
649 Remove RegisterSequentialCommand
649 Add RegisterCommandInternal
649 Remove RegisterCommand
649 Change Security of ExecuteCommandAsync from LocalUserSecurity to None
649 Add DEPRECATED_RegisterSequentialCommand
649 Add DEPRECATED_RegisterCommand
649 Add AttemptSaveAndSendPlaceTelemetry
636 Change Security of ExecuteCommandAsync from RobloxScriptSecurity to LocalUserSecurity
636 Change ReturnType of ExecuteCommandAsync from null to Variant
627 Change Parameters of Stream from (requestId: string, streamContent: string) to (requestId: string, commandName: string, streamContent: string)
625 Change Parameters of RunSandboxedCode from (requestId: string, runCodeGuid: string, defaultCode: string = ) to (runCodeGuid: string, requestId: string)
625 Add BindCodeToGuid
622 Change Parameters of RunSandboxedCode from (requestId: string, code: string) to (requestId: string, runCodeGuid: string, defaultCode: string = )
621 Change Parameters of RunSandboxedCode from (code: string) to (requestId: string, code: string)
619 Change Parameters of GetInstance from (collectorName: string, requestId: string = instanceId) to (requestId: string, instanceId: string)
616 Add ConversationCleared
613 Add RunSandboxedCode
605 Add ExecuteCommandAsync
602 Change Parameters of RequestError from (requestId: string, errorMessage: string) to (requestId: string, errorType: string, errorMessage: string)
602 Add SetPluginInfoCallback
601 Add SequentialCommandsFinished
601 Change Parameters of RequestStarted from (requestId: string) to (requestId: string, queryToProcess: string)
601 Add SetEphemeralVariable
601 Add RegisterSequentialCommand
601 Add InvokeCommand
601 Add GetEphemeralVariable
591 Add Stream
591 Add RequestStarted
591 Add RequestError
591 Add RequestEnded
591 Add UnregisterContextCollector
591 Add RegisterContextCollector
591 Add GetInstance
590 Add UnregisterCommand
590 Add RegisterCommand
590 Add StreamingService

Removed members 25

AttemptSaveAndSendPlaceTelemetry
CreatorHub

Parameters (2)
requestId	string
toolSource	string
Returns (1)
null

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
649 Add AttemptSaveAndSendPlaceTelemetry

Tags: [Yields]

BindCodeToGuid
CreatorHub

Parameters (2)
runCodeGuid	string
code	string
Returns (1)
Tuple

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
625 Add BindCodeToGuid

Tags: [Yields]

ConversationCleared
CreatorHub

Parameters (0)
No parameters.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
616 Add ConversationCleared

DEPRECATED_RegisterCommand
CreatorHub

Parameters (2)		Default
commandName	string
function	Function	nil
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

655 Remove DEPRECATED_RegisterCommand
649 Add DEPRECATED_RegisterCommand

Tags: [Deprecated]

DEPRECATED_RegisterSequentialCommand
CreatorHub

Parameters (2)		Default
commandName	string
function	Function	nil
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

655 Remove DEPRECATED_RegisterSequentialCommand
649 Add DEPRECATED_RegisterSequentialCommand

Tags: [Deprecated]

ExecuteCommandAsync
CreatorHub

Parameters (3)
requestId	string
commandName	string
arg	Variant
Returns (1)
Variant

It will block the calling thread until completion.

Thread safety	Unsafe

History 5

710 Remove StreamingService
649 Change Security of ExecuteCommandAsync from LocalUserSecurity to None
636 Change Security of ExecuteCommandAsync from RobloxScriptSecurity to LocalUserSecurity
636 Change ReturnType of ExecuteCommandAsync from null to Variant
605 Add ExecuteCommandAsync

Tags: [Yields]

GetEphemeralVariable
CreatorHub

Parameters (1)
key	string
Returns (1)
Variant

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
601 Add GetEphemeralVariable

GetInstance
CreatorHub

Parameters (2)
requestId	string
instanceId	string
Returns (1)
Instance

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

710 Remove StreamingService
619 Change Parameters of GetInstance from (collectorName: string, requestId: string = instanceId) to (requestId: string, instanceId: string)
591 Add GetInstance

GetRequiredScripts
CreatorHub

Parameters (1)
script	Instance
Returns (1)
Variant

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
652 Add GetRequiredScripts

Tags: [Yields]

InvokeCommand
CreatorHub

Parameters (3)
requestId	string
commandName	string
arg	Variant
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
601 Add InvokeCommand

RegisterCommand
CreatorHub

Parameters (2)		Default
commandName	string
function	Function	nil
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

649 Remove RegisterCommand
590 Add RegisterCommand

RegisterCommandInternal
CreatorHub

Parameters (4)		Default
commandName	string
function	Function	nil
isSequential	bool	false
isPublic	bool	false
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
649 Add RegisterCommandInternal

RegisterContextCollector
CreatorHub

Parameters (2)		Default
collectorName	string
function	Function	nil
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
591 Add RegisterContextCollector

RegisterSequentialCommand
CreatorHub

Parameters (2)		Default
commandName	string
function	Function	nil
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

649 Remove RegisterSequentialCommand
601 Add RegisterSequentialCommand

RequestEnded
CreatorHub

Parameters (1)
requestId	string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
591 Add RequestEnded

RequestError
CreatorHub

Parameters (3)
requestId	string
errorType	string
errorMessage	string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

710 Remove StreamingService
602 Change Parameters of RequestError from (requestId: string, errorMessage: string) to (requestId: string, errorType: string, errorMessage: string)
591 Add RequestError

RequestStarted
CreatorHub

Parameters (2)
requestId	string
queryToProcess	string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

710 Remove StreamingService
601 Change Parameters of RequestStarted from (requestId: string) to (requestId: string, queryToProcess: string)
591 Add RequestStarted

RunSandboxedCode
CreatorHub

Parameters (2)
runCodeGuid	string
requestId	string
Returns (1)
Tuple

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 5

710 Remove StreamingService
625 Change Parameters of RunSandboxedCode from (requestId: string, runCodeGuid: string, defaultCode: string = ) to (runCodeGuid: string, requestId: string)
622 Change Parameters of RunSandboxedCode from (requestId: string, code: string) to (requestId: string, runCodeGuid: string, defaultCode: string = )
621 Change Parameters of RunSandboxedCode from (code: string) to (requestId: string, code: string)
613 Add RunSandboxedCode

Tags: [Yields]

SearchForAssets
CreatorHub

Parameters (1)
body	Variant
Returns (1)
Variant

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
651 Add SearchForAssets

Tags: [Yields]

SequentialCommandsFinished
CreatorHub

Parameters (2)
requestId	string
success	bool

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
601 Add SequentialCommandsFinished

SetEphemeralVariable
CreatorHub

Parameters (3)		Default
key	string
value	Variant
timeToLive	int	-1
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
601 Add SetEphemeralVariable

SetPluginInfoCallback
CreatorHub

Parameters (1)		Default
function	Function	nil
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
602 Add SetPluginInfoCallback

Stream
CreatorHub

Parameters (3)
requestId	string
commandName	string
streamContent	string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

710 Remove StreamingService
627 Change Parameters of Stream from (requestId: string, streamContent: string) to (requestId: string, commandName: string, streamContent: string)
591 Add Stream

UnregisterCommand
CreatorHub

Parameters (1)
commandName	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
590 Add UnregisterCommand

UnregisterContextCollector
CreatorHub

Parameters (1)
collectorName	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

710 Remove StreamingService
591 Add UnregisterContextCollector

Engine API

Website

Related

History 2

History 2

History 2

History 2

History 2

History 5

History 2

History 3

History 2

History 2

History 2

History 2

History 2

History 2

History 2

History 3

History 3

History 5

History 2

History 2

History 2

History 2

History 3

History 2

History 2