Skip to main content

Interface: TruncateRequestOptions

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

The set of options required by truncate request handlers.

Extends​

Properties​

ignoreACL?​

optional ignoreACL?: boolean

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

Set to true to ignore the ACL permissions check.

Inherited from​

DeleteRequestOptions.ignoreACL

params​

params: any

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

The list of URL parameters to use in the search.

purge?​

optional purge?: boolean

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

Set to true to permanently remove the object from the database (if applicable).

Inherited from​

DeleteRequestOptions.purge

pushChannels?​

optional pushChannels?: string[]

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

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

Overrides​

DeleteRequestOptions.pushChannels

query​

query: any

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

The list of query parameters to use in the search.

recordEvent?​

optional recordEvent?: boolean

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

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

Inherited from​

DeleteRequestOptions.recordEvent

req?​

optional req?: HttpRequest

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

The originating client request.

Inherited from​

DeleteRequestOptions.req

res?​

optional res?: HttpResponse

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

The outgoing client response.

Inherited from​

DeleteRequestOptions.res

skipPush?​

optional skipPush?: boolean

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

Set to true to not send a push notification.

Overrides​

DeleteRequestOptions.skipPush

transaction?​

optional transaction?: TransactionInfo

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

The transactional session to execute the operation within.

Inherited from​

DeleteRequestOptions.transaction

user?​

optional user?: JWTUser

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

The authenticated user making the request.

Inherited from​

DeleteRequestOptions.user

version?​

optional version?: string | number

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

The desired version number of the resource to delete.

Inherited from​

DeleteRequestOptions.version