Class RemoteServiceHttpRequest

A http request which can be sent using the RemoteServiceModule.

Snap OS

Camera Kit

Hierarchy (View Summary)

ScriptObject
- RemoteServiceHttpRequest

Index

Properties

body contentType headers method url

Methods

create getHeader getTypeName isOfType isSame setHeader

Properties

body

body: string | number[] | Uint8Array

The body of the http request.

Snap OS

Camera Kit

contentType

contentType: string

The content type of the http request.

Snap OS

Camera Kit

headers

headers: { [key: string]: string }

The headers of the http request.

Snap OS

Camera Kit

method

method: HttpRequestMethod

The method which should be used to send this http request.

Snap OS

Camera Kit

url

url: string

The URL which this http request should point to.

Snap OS

Camera Kit

Methods

`Static`create

create(): RemoteServiceHttpRequest
Create a new http request.

Returns RemoteServiceHttpRequest
Snap OS
Camera Kit

getHeader

getHeader(name: string): string
Get the header of the http request.
Parameters
- name: string
Returns string
Snap OS
Camera Kit

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame

setHeader

setHeader(name: string, value: string): void
Set the header of the http request.
Parameters
- name: string
- value: string
Returns void
Snap OS
Camera Kit