@appsemble/lang-sdk/schemas/actions/NotifyActionDefinition.js

Language SDK for Appsemble

import { BaseActionDefinition } from './BaseActionDefinition.js';
import { extendJSONSchema } from '../utils/extendJSONSchema.js';
export const NotifyActionDefinition = extendJSONSchema(BaseActionDefinition, {
    type: 'object',
    additionalProperties: false,
    required: ['type', 'title', 'body', 'to'],
    properties: {
        type: {
            enum: ['notify'],
            description: 'Send notifications to one or all the users of an app.',
        },
        title: {
            $ref: '#/components/schemas/RemapperDefinition',
            description: 'The title of the notification.',
        },
        body: {
            $ref: '#/components/schemas/RemapperDefinition',
            description: 'The description of the notification.',
        },
        link: {
            $ref: '#/components/schemas/RemapperDefinition',
            description: 'The link of the notification.',
        },
        to: {
            $ref: '#/components/schemas/RemapperDefinition',
            description: `To whom the notification should be sent.

Use \`all\` to send the notification to all app subscribed users.
Or notify specific users by passing either a single user id or an array of user ids.

Nothing is sent if the value is **not** a valid user id.
`,
        },
    },
});
//# sourceMappingURL=NotifyActionDefinition.js.map