Skip to main content

Interface: RepoCreateOptions

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

The available options for the RepoUtils.create() operation.

Extends​

Properties​

acl?​

optional acl?: AccessControlList

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

The AccessControlList to use when creating a new object.


allowExistingACL?​

optional allowExistingACL?: boolean

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

Set to true to let a record-level-ACL create adopt an ACL that already exists at the new record's uid even though no record of this model exists there yet and the caller doesn't already hold every creator right on it. The existing ACL is used as-is (the creator is not added to it). Defaults to false, in which case such a create is refused with IDENTIFIER_EXISTS - see create().

For trusted server-side code only (e.g. code that deliberately saves a record's ACL before the record itself) - this must never be derived from a client request.


ignoreACL?​

optional ignoreACL?: boolean

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

Set to true to ignore the ACL permissions check.

Inherited from​

RepoOperationOptions.ignoreACL


preserveId?​

optional preserveId?: boolean

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

Set to true to keep the _id carried by the object being created instead of discarding it. The object is still always inserted, never merged into an existing document: a create whose _id is already taken fails with IDENTIFIER_EXISTS. Defaults to false.

For trusted server-side code only (e.g. restoring or migrating documents with their original _id) - this must never be derived from a client request.


pushChannels?​

optional pushChannels?: string[]

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

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:88

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

Inherited from​

RepoOperationOptions.recordEvent


skipPush?​

optional skipPush?: boolean

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

Set to true to not send a push notification.

Inherited from​

RepoOperationOptions.skipPush


transaction?​

optional transaction?: TransactionInfo

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

The transactional session to execute the operation within.

Inherited from​

RepoOperationOptions.transaction


user?​

optional user?: JWTUser

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

The authenticated user making the request.

Inherited from​

RepoOperationOptions.user