Skip to main content

@webda/coreReadme | API


Class: InvitationParameters

Extends

Constructors

new InvitationParameters(params)

new InvitationParameters(params): InvitationParameters

Parameters

params: any

Returns

InvitationParameters

Overrides

ServiceParameters.constructor

Source

packages/core/src/services/invitationservice.ts:161

Properties

attribute

attribute: string

Attribute where to store once the invitation is accepted

If attribute is __acls, the multiple will be ignored and the storage will be compatible with AclModel

Where to store within the model User

Source

packages/core/src/services/invitationservice.ts:141


authenticationService

authenticationService: string

Name of the bean to use for Authentication

Default

Authentication

Source

packages/core/src/services/invitationservice.ts:110


autoAccept

autoAccept: boolean

Do not require a validation by the invitee

Source

packages/core/src/services/invitationservice.ts:155


invitationStore

invitationStore: string

Used to store pending invitation

Source

packages/core/src/services/invitationservice.ts:124


mapAttribute

mapAttribute: string

Attribute to use for the mapping

Source

packages/core/src/services/invitationservice.ts:132


mapFields

mapFields: string[]

Fields to duplicate

Source

packages/core/src/services/invitationservice.ts:128


model

model: string

Model to use

Source

packages/core/src/services/invitationservice.ts:120


multiple

multiple: boolean

Define if several invitation can be accepted or just one

Source

packages/core/src/services/invitationservice.ts:151


notification?

notification?: string

Email template to send to the user

Source

packages/core/src/services/invitationservice.ts:159


notificationService?

notificationService?: string

Notification service

Default

Mailer

Source

packages/core/src/services/invitationservice.ts:116


openapi?

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore

Inherited from

ServiceParameters.openapi

Source

packages/core/src/services/service.ts:260


pendingAttribute

pendingAttribute: string

Attribute where to store once the invitation is created and pending

Where to store within the model Ident and User

Source

packages/core/src/services/invitationservice.ts:147


type

type: string

Type of the service

Inherited from

ServiceParameters.type

Source

packages/core/src/services/service.ts:251


url?

url?: string

URL on which to serve the content

Inherited from

ServiceParameters.url

Source

packages/core/src/services/service.ts:255