HttpRbxApiService 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.

Memory Category	Instances

Tags: [NotCreatable, Service]

Inherits (1)

Instance

Member index (7)

Type	Member	History
string	GetAsync (string apiUrlPath, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default)	263 263 264 298 414
string	GetAsyncFullUrl (string apiUrl, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default)	346 414
string	GetDocumentationUrl (string partialUrl)	411
string	PostAsync (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)	263 298 414
string	PostAsyncFullUrl (string apiUrl, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)	346 414
string	RequestAsync (Dictionary requestOptions, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)	351 350 351 414
string	RequestLimitedAsync (Dictionary requestOptions, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)	421
57 members inherited from Instance

421 Add HttpRbxApiService.RequestLimitedAsync
414 Change Parameters of HttpRbxApiService.GetAsync from (string apiUrlPath, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (string apiUrlPath, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default)
414 Change Parameters of HttpRbxApiService.GetAsyncFullUrl from (string apiUrl, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (string apiUrl, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default)
414 Change Parameters of HttpRbxApiService.PostAsync from (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)
414 Change Parameters of HttpRbxApiService.PostAsyncFullUrl from (string apiUrl, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (string apiUrl, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)
414 Change Parameters of HttpRbxApiService.RequestAsync from (Dictionary requestOptions, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (Dictionary requestOptions, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)
411 Add HttpRbxApiService.GetDocumentationUrl
351 Add HttpRbxApiService.RequestAsync
350 Remove HttpRbxApiService.RequestAsync
351 Add HttpRbxApiService.RequestAsync
346 Add HttpRbxApiService.GetAsyncFullUrl
346 Add HttpRbxApiService.PostAsyncFullUrl
298 Change Parameters of HttpRbxApiService.GetAsync from (string apiUrlPath, ThrottlingPriority priority = Default) to (string apiUrlPath, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false)
298 Change Parameters of HttpRbxApiService.PostAsync from (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson) to (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false)
264 Change Tags of HttpRbxApiService.GetAsync from [Yields, Deprecated] to [Yields]
263 Change Parameters of HttpRbxApiService.GetAsync from (string apiUrlPath, bool useHttps = true, ThrottlingPriority priority = Default) to (string apiUrlPath, ThrottlingPriority priority = Default)
263 Change Tags of HttpRbxApiService.GetAsync from [Yields] to [Yields, Deprecated]
263 Change Parameters of HttpRbxApiService.PostAsync from (string apiUrlPath, string data, bool useHttps = true, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson) to (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson)
174 Add HttpRbxApiService

Members

GetAsync On DevHub

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

Parameters	3

Name	Type	Default
apiUrlPath	string	none
priority	ThrottlingPriority	Default
httpRequestType	HttpRequestType	Default

Return Type	string
Security	RobloxScriptSecurity

History

414 Change Parameters of HttpRbxApiService.GetAsync from (string apiUrlPath, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (string apiUrlPath, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default)
298 Change Parameters of HttpRbxApiService.GetAsync from (string apiUrlPath, ThrottlingPriority priority = Default) to (string apiUrlPath, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false)
264 Change Tags of HttpRbxApiService.GetAsync from [Yields, Deprecated] to [Yields]
263 Change Parameters of HttpRbxApiService.GetAsync from (string apiUrlPath, bool useHttps = true, ThrottlingPriority priority = Default) to (string apiUrlPath, ThrottlingPriority priority = Default)
263 Change Tags of HttpRbxApiService.GetAsync from [Yields] to [Yields, Deprecated]

Tags: [Yields]

GetAsyncFullUrl On DevHub

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

Parameters	3

Name	Type	Default
apiUrl	string	none
priority	ThrottlingPriority	Default
httpRequestType	HttpRequestType	Default

Return Type	string
Security	RobloxScriptSecurity

History

414 Change Parameters of HttpRbxApiService.GetAsyncFullUrl from (string apiUrl, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (string apiUrl, ThrottlingPriority priority = Default, HttpRequestType httpRequestType = Default)
346 Add HttpRbxApiService.GetAsyncFullUrl

Tags: [Yields]

GetDocumentationUrl On DevHub

Parameters	1

Name	Type	Default
partialUrl	string	none

Return Type	string
Security	RobloxScriptSecurity

History

411 Add HttpRbxApiService.GetDocumentationUrl

PostAsync On DevHub

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

Parameters	5

Name	Type	Default
apiUrlPath	string	none
data	string	none
priority	ThrottlingPriority	Default
content_type	HttpContentType	ApplicationJson
httpRequestType	HttpRequestType	Default

Return Type	string
Security	RobloxScriptSecurity

History

414 Change Parameters of HttpRbxApiService.PostAsync from (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)
298 Change Parameters of HttpRbxApiService.PostAsync from (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson) to (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false)
263 Change Parameters of HttpRbxApiService.PostAsync from (string apiUrlPath, string data, bool useHttps = true, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson) to (string apiUrlPath, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson)

Tags: [Yields]

PostAsyncFullUrl On DevHub

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

Parameters	5

Name	Type	Default
apiUrl	string	none
data	string	none
priority	ThrottlingPriority	Default
content_type	HttpContentType	ApplicationJson
httpRequestType	HttpRequestType	Default

Return Type	string
Security	RobloxScriptSecurity

History

414 Change Parameters of HttpRbxApiService.PostAsyncFullUrl from (string apiUrl, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (string apiUrl, string data, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)
346 Add HttpRbxApiService.PostAsyncFullUrl

Tags: [Yields]

RequestAsync On DevHub

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

Parameters	4

Name	Type	Default
requestOptions	Dictionary	none
priority	ThrottlingPriority	Default
content_type	HttpContentType	ApplicationJson
httpRequestType	HttpRequestType	Default

Return Type	string
Security	RobloxScriptSecurity

History

414 Change Parameters of HttpRbxApiService.RequestAsync from (Dictionary requestOptions, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default, bool doNotAllowDiabolicalMode = false) to (Dictionary requestOptions, ThrottlingPriority priority = Default, HttpContentType content_type = ApplicationJson, HttpRequestType httpRequestType = Default)
351 Add HttpRbxApiService.RequestAsync
350 Remove HttpRbxApiService.RequestAsync
351 Add HttpRbxApiService.RequestAsync

Tags: [Yields]

RequestLimitedAsync On DevHub

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

Parameters	4

Name	Type	Default
requestOptions	Dictionary	none
priority	ThrottlingPriority	Default
content_type	HttpContentType	ApplicationJson
httpRequestType	HttpRequestType	Default

Return Type	string

History

421 Add HttpRbxApiService.RequestLimitedAsync

Tags: [Yields]

Roblox API Reference

HttpRbxApiService On DevHub

Summary

Inherits (1)

Member index (7)

History

Members

GetAsync On DevHub

History

GetAsyncFullUrl On DevHub

History

GetDocumentationUrl On DevHub

History

PostAsync On DevHub

History

PostAsyncFullUrl On DevHub

History

RequestAsync On DevHub

History

RequestLimitedAsync On DevHub

History

Relevant enums (3)