node-zendesk • Docs

---

node-zendesk / clients/transporter / Transporter

Class: Transporter

Constructors

new Transporter()

new Transporter(options, sideLoad?, useDotJson?): Transporter

Parameters

• options: any

• sideLoad?: any[]

• useDotJson?: boolean

Returns

Transporter

Defined in

clients/transporter.d.ts:2

Properties

authHandler

authHandler: AuthorizationHandler

Defined in

clients/transporter.d.ts:6

---

endpointChecker

endpointChecker: EndpointChecker

Defined in

clients/transporter.d.ts:8

---

eventTarget

eventTarget: CustomEventTarget

Defined in

clients/transporter.d.ts:7

---

options

options: any

Defined in

clients/transporter.d.ts:3

---

responseAdapter

responseAdapter: any

Defined in

clients/transporter.d.ts:10

---

sideLoad

sideLoad: any[]

Defined in

clients/transporter.d.ts:4

---

transportFn

transportFn: any

Defined in

clients/transporter.d.ts:9

---

useDotJson

useDotJson: boolean

Defined in

clients/transporter.d.ts:5

---

userAgent

userAgent: any

Defined in

clients/transporter.d.ts:11

Methods

emit()

emit(eventType, eventData): void

Parameters

• eventType: any

• eventData: any

Returns

void

Defined in

clients/transporter.d.ts:12

---

getBodyForRequest()

getBodyForRequest(method, body): string

Parameters

• method: any

• body: any

Returns

string

Defined in

clients/transporter.d.ts:29

---

getHeadersForRequest()

getHeadersForRequest(): any

Returns

any

Defined in

clients/transporter.d.ts:28

---

getJSONBody()

getJSONBody(body): string

Parameters

• body: any

Returns

string

Defined in

clients/transporter.d.ts:30

---

obfuscateToken()

obfuscateToken(options): any

Parameters

• options: any

Returns

any

Defined in

clients/transporter.d.ts:22

---

on()

on(eventType, callback): void

Parameters

• eventType: any

• callback: any

Returns

void

Defined in

clients/transporter.d.ts:13

---

prepareOptionsForRequest()

prepareOptionsForRequest(method, uri, body, isBinary?): any

Parameters

• method: string

• uri: any

• body: any

• isBinary?: boolean

Returns

any

Defined in

clients/transporter.d.ts:27

---

request()

request(method, uri, body?): Promise<object>

Parameters

• method: any

• uri: any

• body?: any

Returns

Promise<object>

response

response: any

result

result: object

Defined in

clients/transporter.d.ts:14

---

sendRequest()

sendRequest(options): Promise<object>

Parameters

• options: any

Returns

Promise<object>

response

response: any

result

result: object

Defined in

clients/transporter.d.ts:23

---

setSideLoad()

setSideLoad(array): void

Parameters

• array: any

Returns

void

Defined in

clients/transporter.d.ts:31

---

upload()

upload(uri, file): Promise<object>

Parameters

• uri: any

• file: any

Returns

Promise<object>

response

response: any

result

result: object

Defined in

clients/transporter.d.ts:18