Reference API Roblox

Engine API

Website

Related

Reference API Roblox

HttpRbxApiService

Summary

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]

Member index 7

HistoryMember
462GetAsync(apiUrlPath: string, priority: ThrottlingPriority = Default, httpRequestType: HttpRequestType = Default): string
462GetAsyncFullUrl(apiUrl: string, priority: ThrottlingPriority = Default, httpRequestType: HttpRequestType = Default): string
462GetDocumentationUrl(partialUrl: string): string
462PostAsync(apiUrlPath: string, data: string, priority: ThrottlingPriority = Default, content_type: HttpContentType = ApplicationJson, httpRequestType: HttpRequestType = Default): string
462PostAsyncFullUrl(apiUrl: string, data: string, priority: ThrottlingPriority = Default, content_type: HttpContentType = ApplicationJson, httpRequestType: HttpRequestType = Default): string
462RequestAsync(requestOptions: Dictionary, priority: ThrottlingPriority = Default, content_type: HttpContentType = ApplicationJson, httpRequestType: HttpRequestType = Default): string
462RequestLimitedAsync(requestOptions: Dictionary, priority: ThrottlingPriority = Default, content_type: HttpContentType = ApplicationJson, httpRequestType: HttpRequestType = Default): string
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

History 28

Members 7

GetAsync

Parameters (3)Default
apiUrlPathstring
priorityThrottlingPriorityDefault
httpRequestTypeHttpRequestTypeDefault
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 7

Tags: [Yields]

GetAsyncFullUrl

Parameters (3)Default
apiUrlstring
priorityThrottlingPriorityDefault
httpRequestTypeHttpRequestTypeDefault
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetDocumentationUrl

Parameters (1)
partialUrlstring
Returns (1)
string

History 2

PostAsync

Parameters (5)Default
apiUrlPathstring
datastring
priorityThrottlingPriorityDefault
content_typeHttpContentTypeApplicationJson
httpRequestTypeHttpRequestTypeDefault
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

PostAsyncFullUrl

Parameters (5)Default
apiUrlstring
datastring
priorityThrottlingPriorityDefault
content_typeHttpContentTypeApplicationJson
httpRequestTypeHttpRequestTypeDefault
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

RequestAsync

Parameters (4)Default
requestOptionsDictionary
priorityThrottlingPriorityDefault
content_typeHttpContentTypeApplicationJson
httpRequestTypeHttpRequestTypeDefault
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

RequestLimitedAsync

Parameters (4)Default
requestOptionsDictionary
priorityThrottlingPriorityDefault
content_typeHttpContentTypeApplicationJson
httpRequestTypeHttpRequestTypeDefault
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Settings