Skip to main content

Interface: RequestOptions

Defined in: service-core/src/routes/ModelRoute.ts:24

The set of options required by all request handlers.

Extends​

Extended by​

Properties​

ignoreACL?​

optional ignoreACL?: boolean

Defined in: service-core/src/models/RepoUtils.ts:34

Set to true to ignore the ACL permissions check.

Inherited from​

RepoOperationOptions.ignoreACL

pushChannels?​

optional pushChannels?: string[]

Defined in: service-core/src/models/RepoUtils.ts:36

An additional list of channel names to send push notifications to.

Inherited from​

RepoOperationOptions.pushChannels

recordEvent?​

optional recordEvent?: boolean

Defined in: service-core/src/models/RepoUtils.ts:38

Indicates if a telemetry event should be broadcast for the request.

Inherited from​

RepoOperationOptions.recordEvent

req?​

optional req?: HttpRequest

Defined in: service-core/src/routes/ModelRoute.ts:26

The originating client request.

res?​

optional res?: HttpResponse

Defined in: service-core/src/routes/ModelRoute.ts:28

The outgoing client response.

skipPush?​

optional skipPush?: boolean

Defined in: service-core/src/models/RepoUtils.ts:40

Set to true to not send a push notification.

Inherited from​

RepoOperationOptions.skipPush

user?​

optional user?: JWTUser

Defined in: service-core/src/models/RepoUtils.ts:42

The authenticated user making the request.

Inherited from​

RepoOperationOptions.user