Class CanvasTransport

Class for Sfdc Canvas request transport

Hierarchy

Transport
- CanvasTransport

Index

Constructors

Properties

_signedRequest supported

Methods

getRequestStreamCreator httpRequest

Constructors

constructor

new CanvasTransport(signedRequest): CanvasTransport
Parameters
- signedRequest: any
Returns CanvasTransport
Overrides Transport.constructor
- Defined in src/transport.ts:100

Properties

_signedRequest

_signedRequest: any

`Static` supported

supported: boolean = canvas.supported

Methods

getRequestStreamCreator

getRequestStreamCreator(): ((req, options) => Duplex)
Returns ((req, options) => Duplex)
- - (req, options): Duplex
  - Parameters
    - req: HttpRequest
    - options: HttpRequestOptions
    Returns Duplex
Overrides Transport.getRequestStreamCreator
- Defined in src/transport.ts:105

httpRequest

httpRequest(req, options?): StreamPromise<HttpResponse>
Parameters
- req: HttpRequest
- options: HttpRequestOptions = {}
Returns StreamPromise<HttpResponse>
Inherited from Transport.httpRequest
- Defined in src/transport.ts:45