MessageBusService

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

MessageBusService
Not creatableThis class cannot be instantiated. ServiceThis class is a service. Not replicatedThis class is not replicated.
Icon
Added in	491 (August 2021)
Memory category	Instances
Inheritance
Object Instance MessageBusService

The MessageBusService class inherits from Instance.

Methods

Call(key: string, input: Variant): Variant

Parameters

Name	Type
key	string
input	Variant

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetLast(mid: string): Variant

Parameters

Name	Type
mid	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetMessageId(domainName: string, messageName: string): string

Parameters

Name	Type
domainName	string
messageName	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetProtocolMethodRequestMessageId(protocolName: string, methodName: string): string

Parameters

Name	Type
protocolName	string
methodName	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetProtocolMethodResponseMessageId(protocolName: string, methodName: string): string

Parameters

Name	Type
protocolName	string
methodName	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

MakeRequest(protocolName: string, methodName: string, message: Variant, callback: Function, customTelemetryData: Variant): null

Parameters

Name	Type
protocolName	string
methodName	string
message	Variant
callback	Function
customTelemetryData	Variant

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Publish(mid: string, params: Variant): null

Parameters

Name	Type
mid	string
params	Variant

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PublishProtocolMethodRequest(protocolName: string, methodName: string, message: Variant, customTelemetryData: Variant): null

Parameters

Name	Type
protocolName	string
methodName	string
message	Variant
customTelemetryData	Variant

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PublishProtocolMethodResponse(protocolName: string, methodName: string, message: Variant, responseCode: int, customTelemetryData: Variant): null

Parameters

Name	Type
protocolName	string
methodName	string
message	Variant
responseCode	int
customTelemetryData	Variant

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetRequestHandler(protocolName: string, methodName: string, callback: Function): null

Parameters

Name	Type
protocolName	string
methodName	string
callback	Function

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Subscribe(mid: string, callback: Function, once: bool, sticky: bool): Instance

Parameters

Name	Type
mid	string
callback	Function
once	bool
sticky	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SubscribeToProtocolMethodRequest(protocolName: string, methodName: string, callback: Function, once: bool, sticky: bool): Instance

Parameters

Name	Type
protocolName	string
methodName	string
callback	Function
once	bool
sticky	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SubscribeToProtocolMethodResponse(protocolName: string, methodName: string, callback: Function, once: bool, sticky: bool): Instance

Parameters

Name	Type
protocolName	string
methodName	string
callback	Function
once	bool
sticky	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

External links

• MessageBusService in the Roblox Creator Documentation
• MessageBusService in the Roblox API Reference