Lime Web Components API Documentation - v7.4.0
    Preparing search index...

    Interface LimeObjectCommand

    A command that operates on a single LimeObject.

    LimeObjectCommand is used for actions that target a specific record, such as sending an email to a contact, generating a PDF for a deal, or archiving a specific company. The context property identifies which object the command should operate on.

    import {
        Command,
        LimeObjectCommand,
        LimeObjectContext,
    } from '@limetech/lime-web-components';

    // The platform instantiates a command without arguments and then assigns the
    // properties, so a command class declares no constructor.
    @Command({ id: 'send-email' })
    class SendEmailCommand implements LimeObjectCommand {
        public context: LimeObjectContext;
        public subject: string;
        public body: string;
    }

    const command = new SendEmailCommand();
    command.context = { limetype: 'person', id: 42 };
    command.subject = 'Meeting Invitation';
    command.body = 'Please join us for a meeting...';

    import {
        Command,
        LimeObjectCommand,
        LimeObjectContext,
        PlatformServiceName,
    } from '@limetech/lime-web-components';

    @Command({ id: 'send-email' })
    class SendEmailCommand implements LimeObjectCommand {
        public context: LimeObjectContext;
        public subject: string;
        public body: string;
    }

    const commandBus = platform.get(PlatformServiceName.CommandBus);

    const command = new SendEmailCommand();
    command.context = { limetype: 'person', id: 42 };
    command.subject = 'Meeting Invitation';
    command.body = 'Please join us for a meeting...';

    await commandBus.handle(command);
    interface LimeObjectCommand {
        context: LimeObjectContext;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    context

    Properties

    context: LimeObjectContext

    Context describing the LimeObject the command will operate on.

    Must include both limetype (the type of object) and id (the specific object's identifier). This ensures the command knows exactly which record to target.

    Settings

    Member Visibility

    On This Page

    Properties