SteamWorks.SteamHTTP

Interface: SteamHTTP

SteamWorksNamespace.SteamHTTP

Table of contents

Properties

• CreateCookieContainer
• CreateHTTPRequest
• DeferHTTPRequest
• GetHTTPDownloadProgressPct
• GetHTTPRequestWasTimedOut
• GetHTTPResponseBodyData
• GetHTTPResponseBodySize
• GetHTTPResponseHeaderSize
• GetHTTPResponseHeaderValue
• GetHTTPStreamingResponseBodyData
• PrioritizeHTTPRequest
• ReleaseCookieContainer
• ReleaseHTTPRequest
• SendHTTPRequest
• SendHTTPRequestAndStreamResponse
• SetCookie
• SetHTTPRequestAbsoluteTimeoutMS
• SetHTTPRequestContextValue
• SetHTTPRequestCookieContainer
• SetHTTPRequestGetOrPostParameter
• SetHTTPRequestHeaderValue
• SetHTTPRequestNetworkActivityTimeout
• SetHTTPRequestRawPostBody
• SetHTTPRequestRequiresVerifiedCertificate
• SetHTTPRequestUserAgentInfo

Properties

CreateCookieContainer

• CreateCookieContainer: (bAllowResponsesToModify: boolean) => number

Type declaration

▸ (bAllowResponsesToModify): number

Parameters

Name	Type
bAllowResponsesToModify	boolean

Returns

number

Defined in

index.d.ts:2614

---

CreateHTTPRequest

• CreateHTTPRequest: (eHTTPRequestMethod: EHTTPMethod, pchAbsoluteURL: string) => number

Type declaration

▸ (eHTTPRequestMethod, pchAbsoluteURL): number

Parameters

Name	Type
eHTTPRequestMethod	EHTTPMethod
pchAbsoluteURL	string

Returns

number

Defined in

index.d.ts:2597

---

DeferHTTPRequest

• DeferHTTPRequest: (hRequest: number) => boolean

Type declaration

▸ (hRequest): boolean

Parameters

Name	Type
hRequest	number

Returns

boolean

Defined in

index.d.ts:2604

---

GetHTTPDownloadProgressPct

• GetHTTPDownloadProgressPct: (hRequest: number, pflPercentOut: number) => boolean

Type declaration

▸ (hRequest, pflPercentOut): boolean

Parameters

Name	Type
hRequest	number
pflPercentOut	number

Returns

boolean

Defined in

index.d.ts:2612

---

GetHTTPRequestWasTimedOut

• GetHTTPRequestWasTimedOut: (hRequest: number, pbWasTimedOut: unknown) => boolean

Type declaration

▸ (hRequest, pbWasTimedOut): boolean

Parameters

Name	Type
hRequest	number
pbWasTimedOut	unknown

Returns

boolean

Defined in

index.d.ts:2621

---

GetHTTPResponseBodyData

• GetHTTPResponseBodyData: (hRequest: number, pBodyDataBuffer: number, unBufferSize: number) => boolean

Type declaration

▸ (hRequest, pBodyDataBuffer, unBufferSize): boolean

Parameters

Name	Type
hRequest	number
pBodyDataBuffer	number
unBufferSize	number

Returns

boolean

Defined in

index.d.ts:2609

---

GetHTTPResponseBodySize

• GetHTTPResponseBodySize: (hRequest: number, unBodySize: number) => boolean

Type declaration

▸ (hRequest, unBodySize): boolean

Parameters

Name	Type
hRequest	number
unBodySize	number

Returns

boolean

Defined in

index.d.ts:2608

---

GetHTTPResponseHeaderSize

• GetHTTPResponseHeaderSize: (hRequest: number, pchHeaderName: string, unResponseHeaderSize: number) => boolean

Type declaration

▸ (hRequest, pchHeaderName, unResponseHeaderSize): boolean

Parameters

Name	Type
hRequest	number
pchHeaderName	string
unResponseHeaderSize	number

Returns

boolean

Defined in

index.d.ts:2606

---

GetHTTPResponseHeaderValue

• GetHTTPResponseHeaderValue: (hRequest: number, pchHeaderName: string, pHeaderValueBuffer: number, unBufferSize: number) => boolean

Type declaration

▸ (hRequest, pchHeaderName, pHeaderValueBuffer, unBufferSize): boolean

Parameters

Name	Type
hRequest	number
pchHeaderName	string
pHeaderValueBuffer	number
unBufferSize	number

Returns

boolean

Defined in

index.d.ts:2607

---

GetHTTPStreamingResponseBodyData

• GetHTTPStreamingResponseBodyData: (hRequest: number, cOffset: number, pBodyDataBuffer: number, unBufferSize: number) => boolean

Type declaration

▸ (hRequest, cOffset, pBodyDataBuffer, unBufferSize): boolean

Parameters

Name	Type
hRequest	number
cOffset	number
pBodyDataBuffer	number
unBufferSize	number

Returns

boolean

Defined in

index.d.ts:2610

---

PrioritizeHTTPRequest

• PrioritizeHTTPRequest: (hRequest: number) => boolean

Type declaration

▸ (hRequest): boolean

Parameters

Name	Type
hRequest	number

Returns

boolean

Defined in

index.d.ts:2605

---

ReleaseCookieContainer

• ReleaseCookieContainer: (hCookieContainer: number) => boolean

Type declaration

▸ (hCookieContainer): boolean

Parameters

Name	Type
hCookieContainer	number

Returns

boolean

Defined in

index.d.ts:2615

---

ReleaseHTTPRequest

• ReleaseHTTPRequest: (hRequest: number) => boolean

Type declaration

▸ (hRequest): boolean

Parameters

Name	Type
hRequest	number

Returns

boolean

Defined in

index.d.ts:2611

---

SendHTTPRequest

• SendHTTPRequest: (hRequest: number, pCallHandle: unknown) => boolean

Type declaration

▸ (hRequest, pCallHandle): boolean

Parameters

Name	Type
hRequest	number
pCallHandle	unknown

Returns

boolean

Defined in

index.d.ts:2602

---

SendHTTPRequestAndStreamResponse

• SendHTTPRequestAndStreamResponse: (hRequest: number, pCallHandle: unknown) => boolean

Type declaration

▸ (hRequest, pCallHandle): boolean

Parameters

Name	Type
hRequest	number
pCallHandle	unknown

Returns

boolean

Defined in

index.d.ts:2603

---

SetCookie

• SetCookie: (hCookieContainer: number, pchHost: string, pchUrl: string, pchCookie: string) => boolean

Type declaration

▸ (hCookieContainer, pchHost, pchUrl, pchCookie): boolean

Parameters

Name	Type
hCookieContainer	number
pchHost	string
pchUrl	string
pchCookie	string

Returns

boolean

Defined in

index.d.ts:2616

---

SetHTTPRequestAbsoluteTimeoutMS

• SetHTTPRequestAbsoluteTimeoutMS: (hRequest: number, unMilliseconds: number) => boolean

Type declaration

▸ (hRequest, unMilliseconds): boolean

Parameters

Name	Type
hRequest	number
unMilliseconds	number

Returns

boolean

Defined in

index.d.ts:2620

---

SetHTTPRequestContextValue

• SetHTTPRequestContextValue: (hRequest: number, ulContextValue: bigint) => boolean

Type declaration

▸ (hRequest, ulContextValue): boolean

Parameters

Name	Type
hRequest	number
ulContextValue	bigint

Returns

boolean

Defined in

index.d.ts:2598

---

SetHTTPRequestCookieContainer

• SetHTTPRequestCookieContainer: (hRequest: number, hCookieContainer: number) => boolean

Type declaration

▸ (hRequest, hCookieContainer): boolean

Parameters

Name	Type
hRequest	number
hCookieContainer	number

Returns

boolean

Defined in

index.d.ts:2617

---

SetHTTPRequestGetOrPostParameter

• SetHTTPRequestGetOrPostParameter: (hRequest: number, pchParamName: string, pchParamValue: string) => boolean

Type declaration

▸ (hRequest, pchParamName, pchParamValue): boolean

Parameters

Name	Type
hRequest	number
pchParamName	string
pchParamValue	string

Returns

boolean

Defined in

index.d.ts:2601

---

SetHTTPRequestHeaderValue

• SetHTTPRequestHeaderValue: (hRequest: number, pchHeaderName: string, pchHeaderValue: string) => boolean

Type declaration

▸ (hRequest, pchHeaderName, pchHeaderValue): boolean

Parameters

Name	Type
hRequest	number
pchHeaderName	string
pchHeaderValue	string

Returns

boolean

Defined in

index.d.ts:2600

---

SetHTTPRequestNetworkActivityTimeout

• SetHTTPRequestNetworkActivityTimeout: (hRequest: number, unTimeoutSeconds: number) => boolean

Type declaration

▸ (hRequest, unTimeoutSeconds): boolean

Parameters

Name	Type
hRequest	number
unTimeoutSeconds	number

Returns

boolean

Defined in

index.d.ts:2599

---

SetHTTPRequestRawPostBody

• SetHTTPRequestRawPostBody: (hRequest: number, pchContentType: string, pubBody: number, unBodyLen: number) => boolean

Type declaration

▸ (hRequest, pchContentType, pubBody, unBodyLen): boolean

Parameters

Name	Type
hRequest	number
pchContentType	string
pubBody	number
unBodyLen	number

Returns

boolean

Defined in

index.d.ts:2613

---

SetHTTPRequestRequiresVerifiedCertificate

• SetHTTPRequestRequiresVerifiedCertificate: (hRequest: number, bRequireVerifiedCertificate: boolean) => boolean

Type declaration

▸ (hRequest, bRequireVerifiedCertificate): boolean

Parameters

Name	Type
hRequest	number
bRequireVerifiedCertificate	boolean

Returns

boolean

Defined in

index.d.ts:2619

---

SetHTTPRequestUserAgentInfo

• SetHTTPRequestUserAgentInfo: (hRequest: number, pchUserAgentInfo: string) => boolean

Type declaration

▸ (hRequest, pchUserAgentInfo): boolean

Parameters

Name	Type
hRequest	number
pchUserAgentInfo	string

Returns

boolean

Defined in

index.d.ts:2618