Interface NotificationDefaultAdapterOptions

interface NotificationDefaultAdapterOptions {
    authEncSecret: string;
    authSignSecret: string;
    authenticate?: AuthenticationFunction;
    customFields?: {
        message: CustomField[];
    };
    paginationConfiguration?: PaginationConfigurations;
    sender?: string;
}

Properties

authEncSecret authSignSecret authenticate? customFields? paginationConfiguration? sender?

Properties

authEncSecret

authEncSecret: string

Secret use to encrypt the JWT Token

authSignSecret

authSignSecret: string

Secret use to sign the JWT Token

Optional authenticate

authenticate?: AuthenticationFunction

Function that will be called to authenticate the user via validators. When not provided, this will default to bearer authentication (security.defaultBearerAuth)

Typically you would only provide this if designing your own authentication or using cookie auth via security.defaultCookieAuth.

Optional customFields

customFields?: {
    message: CustomField[];
}

Custom field configuration per data type

Type declaration

  • message: CustomField[]

Optional paginationConfiguration

paginationConfiguration?: PaginationConfigurations

Default pagination configuration for each of the list endpoints

Optional sender

sender?: string

Email address of sender when configuring email sending

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc