StreamingService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This class is a service. It is a singleton that may be acquired with GetService.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Instance

Member index (16)

Type	Member	History
null	ExecuteCommandAsync (string requestId, string commandName, Variant arg)	605
Variant	GetEphemeralVariable (string key)	601
Instance	GetInstance (string collectorName, string requestId = instanceId)	591
null	InvokeCommand (string requestId, string commandName, Variant arg)	601
null	RegisterCommand (string commandName, Function function = nil)
null	RegisterContextCollector (string collectorName, Function function = nil)	591
null	RegisterSequentialCommand (string commandName, Function function = nil)	601
null	SetEphemeralVariable (string key, Variant value, int timeToLive = -1)	601
null	SetPluginInfoCallback (Function function = nil)	602
null	UnregisterCommand (string commandName)
null	UnregisterContextCollector (string collectorName)	591
	RequestEnded (string requestId)	591
	RequestError (string requestId, string errorType, string errorMessage)	591 602
	RequestStarted (string requestId, string queryToProcess)	591 601
	SequentialCommandsFinished (string requestId, bool success)	601
	Stream (string requestId, string streamContent)	591
57 members inherited from Instance

605 Add StreamingService.ExecuteCommandAsync
602 Add StreamingService.SetPluginInfoCallback
602 Change Parameters of StreamingService.RequestError from (string requestId, string errorMessage) to (string requestId, string errorType, string errorMessage)
601 Add StreamingService.GetEphemeralVariable
601 Add StreamingService.InvokeCommand
601 Add StreamingService.RegisterSequentialCommand
601 Add StreamingService.SetEphemeralVariable
601 Change Parameters of StreamingService.RequestStarted from (string requestId) to (string requestId, string queryToProcess)
601 Add StreamingService.SequentialCommandsFinished
591 Add StreamingService.GetInstance
591 Add StreamingService.RegisterContextCollector
591 Add StreamingService.UnregisterContextCollector
591 Add StreamingService.RequestEnded
591 Add StreamingService.RequestError
591 Add StreamingService.RequestStarted
591 Add StreamingService.Stream
590 Add StreamingService

Members

ExecuteCommandAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	3

Name	Type	Default
requestId	string	none
commandName	string	none
arg	Variant	none

Return Type	null
Security	RobloxScriptSecurity

History

605 Add StreamingService.ExecuteCommandAsync

Tags: [Yields]

GetEphemeralVariable On DevHub

Parameters	1

Name	Type	Default
key	string	none

Return Type	Variant
Security	RobloxScriptSecurity

History

601 Add StreamingService.GetEphemeralVariable

GetInstance On DevHub

Parameters	2

Name	Type	Default
collectorName	string	none
requestId	string	instanceId

Return Type	Instance
Security	RobloxScriptSecurity

History

591 Add StreamingService.GetInstance

InvokeCommand On DevHub

Parameters	3

Name	Type	Default
requestId	string	none
commandName	string	none
arg	Variant	none

Return Type	null
Security	RobloxScriptSecurity

History

601 Add StreamingService.InvokeCommand

RegisterCommand On DevHub

Parameters	2

Name	Type	Default
commandName	string	none
function	Function	nil

Return Type	null
Security	RobloxScriptSecurity

RegisterContextCollector On DevHub

Parameters	2

Name	Type	Default
collectorName	string	none
function	Function	nil

Return Type	null
Security	RobloxScriptSecurity

History

591 Add StreamingService.RegisterContextCollector

RegisterSequentialCommand On DevHub

Parameters	2

Name	Type	Default
commandName	string	none
function	Function	nil

Return Type	null
Security	RobloxScriptSecurity

History

601 Add StreamingService.RegisterSequentialCommand

RequestEnded On DevHub

Parameters	1

Name	Type	Default
requestId	string	none

Security	RobloxScriptSecurity

History

591 Add StreamingService.RequestEnded

RequestError On DevHub

Parameters	3

Name	Type	Default
requestId	string	none
errorType	string	none
errorMessage	string	none

Security	RobloxScriptSecurity

History

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

RequestStarted On DevHub

Parameters	2

Name	Type	Default
requestId	string	none
queryToProcess	string	none

Security	RobloxScriptSecurity

History

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

SequentialCommandsFinished On DevHub

Parameters	2

Name	Type	Default
requestId	string	none
success	bool	none

Security	RobloxScriptSecurity

History

601 Add StreamingService.SequentialCommandsFinished

SetEphemeralVariable On DevHub

Parameters	3

Name	Type	Default
key	string	none
value	Variant	none
timeToLive	int	-1

Return Type	null
Security	RobloxScriptSecurity

History

601 Add StreamingService.SetEphemeralVariable

SetPluginInfoCallback On DevHub

Parameters	1

Name	Type	Default
function	Function	nil

Return Type	null
Security	RobloxScriptSecurity

History

602 Add StreamingService.SetPluginInfoCallback

Stream On DevHub

Parameters	2

Name	Type	Default
requestId	string	none
streamContent	string	none

Security	RobloxScriptSecurity

History

591 Add StreamingService.Stream

UnregisterCommand On DevHub

Parameters	1

Name	Type	Default
commandName	string	none

Return Type	null
Security	RobloxScriptSecurity

UnregisterContextCollector On DevHub

Parameters	1

Name	Type	Default
collectorName	string	none

Return Type	null
Security	RobloxScriptSecurity

History

591 Add StreamingService.UnregisterContextCollector

Relevant classes (1)

Instance