DelegatingHandler

Stentor API Reference

---

Stentor API Reference / stentor-handler-delegating/src / DelegatingHandler

Class: DelegatingHandler

Defined in: packages/stentor-handler-delegating/src/Handler.ts:19

This handler can call registered methods outside Stentor.

Extends

• AbstractHandler\<Content, DelegatingData>

Constructors

Constructor

new DelegatingHandler(props): DelegatingHandler

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:21

Parameters

props

Handler\<Content, DelegatingData, Forward, Redirect>

Returns

DelegatingHandler

Inherited from

AbstractHandler.constructor

Properties

intentId

readonly intentId: string

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:9

The ID of the intent, typically a combination of the name and a random string.

Inherited from

AbstractHandler.intentId

---

appId

readonly appId: string

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:10

The ID for the app the intent belongs to.

Inherited from

AbstractHandler.appId

---

organizationId

readonly organizationId: string

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:11

The organization ID for the app of which this intent belongs.

Inherited from

AbstractHandler.organizationId

---

createdAt

readonly createdAt: string

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:12

ISO-8601 string of when the intent was created.

Inherited from

AbstractHandler.createdAt

---

content

readonly content: Content

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:13

Inherited from

AbstractHandler.content

---

data

data: DelegatingData

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:14

Inherited from

AbstractHandler.data

---

forward

readonly forward: Forward

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:15

Inherited from

AbstractHandler.forward

---

redirect

readonly redirect: Redirect

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:16

Inherited from

AbstractHandler.redirect

---

name?

readonly optional name: string

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:17

The human readable name of the intent.

Inherited from

AbstractHandler.name

---

slots?

readonly optional slots: Slot[]

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:18

The slots defined within the utterance patterns and their Entity types.

Inherited from

AbstractHandler.slots

---

slotTypes?

readonly optional slotTypes: SlotTypeMap

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:19

A map of the slot type definition.

Deprecated

Use Entities

Inherited from

AbstractHandler.slotTypes

---

permissions?

readonly optional permissions: UserDataType[]

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:20

Inherited from

AbstractHandler.permissions

---

type

type: "DelegatingHandlerType"

Defined in: packages/stentor-handler-delegating/src/Handler.ts:20

Overrides

ConversationHandler.type

Methods

isOwnRequest()

isOwnRequest(request): boolean

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:25

Determines if the request is for itself.

Parameters

request

Request

Returns

boolean

Inherited from

AbstractHandler.isOwnRequest

---

forwardingPathForRequest()

forwardingPathForRequest(request, context): Promise\<ExecutablePath>

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:40

Get the forwarding path for the provided request.

Returns undefined if a path could not be found.

Parameters

request

Request

context

Context

Returns

Promise\<ExecutablePath>

Inherited from

AbstractHandler.forwardingPathForRequest

---

redirectingPathForRequest()

redirectingPathForRequest(request, context): Promise\<ExecutablePath>

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:48

Check if we have redirects (applied before handling the request). Usually some gate condition.

Returns undefined if a path could not be found.

Parameters

request

Request

context

Context

Returns

Promise\<ExecutablePath>

Inherited from

AbstractHandler.redirectingPathForRequest

---

canHandleInputUnknown()

canHandleInputUnknown(request, context): boolean

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:55

Can handle InputUnknown

Parameters

request

Request

context

Context

Returns

boolean

Inherited from

AbstractHandler.canHandleInputUnknown

---

repeat()

protected repeat(request, context): Promise\<void>

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:61

Repeats the last uttered response.

Parameters

request

Request

context

Context

Returns

Promise\<void>

Inherited from

AbstractHandler.repeat

---

inputUnknown()

protected inputUnknown(request, context): Promise\<void>

Defined in: packages/stentor-handler/lib/AbstractHandler/Handler.d.ts:70

Handles the situation where the handler

Parameters

request

Request

context

Context

Returns

Promise\<void>

Inherited from

AbstractHandler.inputUnknown

---

setHandlerDelegates()

setHandlerDelegates(handlerDelegates): void

Defined in: packages/stentor-handler-delegating/src/Handler.ts:29

Pick out the method this handler should delegate to. The default is the intentId of the handler.

Parameters

handlerDelegates

Returns

void

---

start()

start(request, context): Promise\<void>

Defined in: packages/stentor-handler-delegating/src/Handler.ts:44

Call start if we have an override

Parameters

request

Request

context

Context

Returns

Promise\<void>

Overrides

AbstractHandler.start

---

handleRequest()

handleRequest(request, context): Promise\<void>

Defined in: packages/stentor-handler-delegating/src/Handler.ts:64

Call the handler method if we have an override

We need to be tricky. Basic services, like cancel/stop, repeat and InputUnknow we still want to use, but some skills want those two.

Parameters

request

Request

context

Context

Returns

Promise\<void>

Overrides

AbstractHandler.handleRequest

---

canHandleRequest()

canHandleRequest(request, context): boolean

Defined in: packages/stentor-handler-delegating/src/Handler.ts:87

Ask the super AND the delegate. One of them should be interested.

Parameters

request

Request

context

Context

Returns

boolean

Overrides

AbstractHandler.canHandleRequest