Class HttpWeb

Hierarchy

WebPlugin
- HttpWeb

Implements

HttpPlugin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HttpWeb(): HttpWeb

Overrides WebPlugin.constructor
- Defined in src/web.ts:20
Returns HttpWeb

Properties

Optional config

config: WebPluginConfig

deprecated: WebPluginConfig deprecated in v3 and will be removed in v4.

Protected listeners

listeners: {}

Type declaration

[eventName: string]: ListenerCallback[]

Protected windowListeners

windowListeners: {}

Type declaration

[eventName: string]: WindowListenerHandle

Methods

addListener

addListener(eventName: string, listenerFunc: ListenerCallback): Promise<PluginListenerHandle> & PluginListenerHandle

Inherited from WebPlugin.addListener
- Defined in node_modules/@capacitor/core/types/web-plugin.d.ts:18
Parameters
- eventName: string
- listenerFunc: ListenerCallback
Returns Promise<PluginListenerHandle> & PluginListenerHandle

clearCookies

clearCookies(options: HttpMultiCookiesOptions): Promise<void>

Implementation of HttpPlugin.clearCookies
- Defined in src/web.ts:124
Clears out cookies by setting them to expire immediately

Parameters
- options: HttpMultiCookiesOptions
Returns Promise<void>

del

del(options: HttpOptions): Promise<HttpResponse>

Implementation of HttpPlugin.del
- Defined in src/web.ts:64
Perform an Http DELETE request given a set of options

Parameters
- options: HttpOptions
  
  Options to build the HTTP request
Returns Promise<HttpResponse>

deleteCookie

deleteCookie(options: HttpSingleCookieOptions): Promise<void>

Implementation of HttpPlugin.deleteCookie
- Defined in src/web.ts:117
Deletes a cookie given a key

Parameters
- options: HttpSingleCookieOptions
Returns Promise<void>

downloadFile

downloadFile(options: HttpDownloadFileOptions): Promise<HttpDownloadFileResult>

Implementation of HttpPlugin.downloadFile
- Defined in src/web.ts:151
Downloads a file

Parameters
- options: HttpDownloadFileOptions
  
  TODO
Returns Promise<HttpDownloadFileResult>

get

get(options: HttpOptions): Promise<HttpResponse>

Implementation of HttpPlugin.get
- Defined in src/web.ts:36
Perform an Http GET request given a set of options

Parameters
- options: HttpOptions
  
  Options to build the HTTP request
Returns Promise<HttpResponse>

getCookie

getCookie(options: HttpSingleCookieOptions): Promise<HttpCookie>

Implementation of HttpPlugin.getCookie
- Defined in src/web.ts:109
Gets all cookie values unless a key is specified, then return only that value

Parameters
- options: HttpSingleCookieOptions
Returns Promise<HttpCookie>

getCookies

getCookies(options: HttpMultiCookiesOptions): Promise<HttpGetCookiesResult>

Implementation of HttpPlugin.getCookies
- Defined in src/web.ts:84
Get all HttpCookies as an object with the values as an HttpCookie[]

Parameters
- options: HttpMultiCookiesOptions
Returns Promise<HttpGetCookiesResult>

getCookiesMap

getCookiesMap(): Promise<HttpCookieMap>

Implementation of HttpPlugin.getCookiesMap
- Defined in src/web.ts:70
Gets all HttpCookies as a Map

Returns Promise<HttpCookieMap>

Protected hasListeners

hasListeners(eventName: string): boolean

Inherited from WebPlugin.hasListeners
- Defined in node_modules/@capacitor/core/types/web-plugin.d.ts:21
Parameters
- eventName: string
Returns boolean

Protected notifyListeners

notifyListeners(eventName: string, data: any): void

Inherited from WebPlugin.notifyListeners
- Defined in node_modules/@capacitor/core/types/web-plugin.d.ts:20
Parameters
- eventName: string
- data: any
Returns void

patch

patch(options: HttpOptions): Promise<HttpResponse>

Implementation of HttpPlugin.patch
- Defined in src/web.ts:57
Perform an Http PATCH request given a set of options

Parameters
- options: HttpOptions
  
  Options to build the HTTP request
Returns Promise<HttpResponse>

post

post(options: HttpOptions): Promise<HttpResponse>

Implementation of HttpPlugin.post
- Defined in src/web.ts:43
Perform an Http POST request given a set of options

Parameters
- options: HttpOptions
  
  Options to build the HTTP request
Returns Promise<HttpResponse>

put

put(options: HttpOptions): Promise<HttpResponse>

Implementation of HttpPlugin.put
- Defined in src/web.ts:50
Perform an Http PUT request given a set of options

Parameters
- options: HttpOptions
  
  Options to build the HTTP request
Returns Promise<HttpResponse>

Protected registerWindowListener

registerWindowListener(windowEventName: string, pluginEventName: string): void

Inherited from WebPlugin.registerWindowListener
- Defined in node_modules/@capacitor/core/types/web-plugin.d.ts:22
Parameters
- windowEventName: string
- pluginEventName: string
Returns void

removeAllListeners

removeAllListeners(): Promise<void>

Inherited from WebPlugin.removeAllListeners
- Defined in node_modules/@capacitor/core/types/web-plugin.d.ts:19
Returns Promise<void>

request

request(options: HttpOptions): Promise<HttpResponse>

Implementation of HttpPlugin.request
- Defined in src/web.ts:29
Perform an Http request given a set of options

Parameters
- options: HttpOptions
  
  Options to build the HTTP request
Returns Promise<HttpResponse>

setCookie

setCookie(options: HttpSetCookieOptions): Promise<void>

Implementation of HttpPlugin.setCookie
- Defined in src/web.ts:100
Set a cookie

Parameters
- options: HttpSetCookieOptions
  
  Optional additional parameters
Returns Promise<void>

Protected unavailable

unavailable(msg?: string): CapacitorException

Inherited from WebPlugin.unavailable
- Defined in node_modules/@capacitor/core/types/web-plugin.d.ts:24
Parameters
- Optional msg: string
Returns CapacitorException

Protected unimplemented

unimplemented(msg?: string): CapacitorException

Inherited from WebPlugin.unimplemented
- Defined in node_modules/@capacitor/core/types/web-plugin.d.ts:23
Parameters
- Optional msg: string
Returns CapacitorException

uploadFile

uploadFile(options: HttpUploadFileOptions): Promise<HttpUploadFileResult>

Implementation of HttpPlugin.uploadFile
- Defined in src/web.ts:133
Uploads a file through a POST request

Parameters
- options: HttpUploadFileOptions
  
  TODO
Returns Promise<HttpUploadFileResult>

Generated using TypeDoc