Class SigaaHTTPWithBond

Implements sigaa bond in HTTP request class.

param: http instamce implementation
param: A instance of BondController to read current bond
param: url to switch bond

Hierarchy

SigaaHTTPWithBond

Implements

HTTP

Index

Constructors

constructor

Methods

Constructors

constructor

new SigaaHTTPWithBond(http: HTTP, bondController: BondController, pageCacheWithBond: PageCacheWithBond, bondSwitchUrl: null | URL): SigaaHTTPWithBond

- Defined in src/session/sigaa-http-with-bond.ts:17
Parameters
- http: HTTP
- bondController: BondController
- pageCacheWithBond: PageCacheWithBond
- bondSwitchUrl: null | URL
Returns SigaaHTTPWithBond

Methods

closeSession

closeSession(): void

Implementation of HTTP.closeSession
- Defined in src/session/sigaa-http-with-bond.ts:125
Close http session

Returns void

downloadFileByGet

downloadFileByGet(urlPath: string, basepath: string, callback?: ProgressCallback): Promise<string>

Implementation of HTTP.downloadFileByGet
- Defined in src/session/sigaa-http-with-bond.ts:84
Download a file

Parameters
- urlPath: string
  
  file url
- basepath: string
  
  path to save file
- Optional callback: ProgressCallback
  
  callback to view download progress
Returns Promise<string>

downloadFileByPost

downloadFileByPost(urlPath: string, postValues: Record<string, string>, basepath: string, callback?: ProgressCallback): Promise<string>

Implementation of HTTP.downloadFileByPost
- Defined in src/session/sigaa-http-with-bond.ts:96
Download a file

Parameters
- urlPath: string
  
  file url
- postValues: Record<string, string>
- basepath: string
  
  path to save file
- Optional callback: ProgressCallback
  
  callback to view download progress
Returns Promise<string>

followAllRedirect

followAllRedirect(page: Page, options?: SigaaRequestOptions): Promise<Page>

Implementation of HTTP.followAllRedirect
- Defined in src/session/sigaa-http-with-bond.ts:114
Follow the redirect while the page response redirects to another page

Parameters
- page: Page
- Optional options: SigaaRequestOptions
Returns Promise<Page>

get

get(path: string, options?: SigaaRequestOptions): Promise<Page>

Implementation of HTTP.get
- Defined in src/session/sigaa-http-with-bond.ts:76
Make a GET request

Parameters
- path: string
- Optional options: SigaaRequestOptions
Returns Promise<Page>

post

post(path: string, postValues: Record<string, string>, options?: SigaaRequestOptions): Promise<Page>

Implementation of HTTP.post
- Defined in src/session/sigaa-http-with-bond.ts:67
Make a POST request

Parameters
- path: string
  
  The path of request or full URL
- postValues: Record<string, string>
  
  Post values in format, key as field name, and value as field value.
- Optional options: SigaaRequestOptions
Returns Promise<Page>

postMultipart

postMultipart(path: string, formData: FormData, options?: SigaaRequestOptions): Promise<Page>

Implementation of HTTP.postMultipart
- Defined in src/session/sigaa-http-with-bond.ts:55
Make a POST multipart request

Parameters
- path: string
  
  The path of request or full URL
- formData: FormData
  
  instance of FormData
- Optional options: SigaaRequestOptions
Returns Promise<Page>

Private switchBond

switchBond(): Promise<void>

- Defined in src/session/sigaa-http-with-bond.ts:37
Switch bond

Returns Promise<void>

Private verifyIfBondIsCorrect

verifyIfBondIsCorrect(): Promise<void>

- Defined in src/session/sigaa-http-with-bond.ts:28
Verify if current bond is correct. Otherwise, switch bond

Returns Promise<void>

Generated using TypeDoc