NAME

Kernel::System::Role::ContactsExternalAPI – Role to emit push events

REQUIRED METHODS

Provides methods to define the allowed push events and emit the push events.

RegisteredPushEvents()

Method that returns the allowed push events. This values will be used to validate the emitted push events.

Push events should be defined like this:

    sub RegisteredPushEvents {
        return {
            TicketSubscribe => [
                'TicketID',
                'UserID',
            ],
            TicketUnsubscribe => [
                'TicketID',
                'UserID',
            ],
        };
    }

ATTRIBUTES

APIBasePath

Emit a push event, which adds it to the event queue to be processed by the daemon.

    $Self->EmitPushEvent(
        EventName  => 'TicketSubscribe',
        Attributes => {
            TicketID => 123,
            UserID   => 12,
        },
    );

UserAgent

Emit a push event, which adds it to the event queue to be processed by the daemon.

    $Self->EmitPushEvent(
        EventName  => 'TicketSubscribe',
        Attributes => {
            TicketID => 123,
            UserID   => 12,
        },
    );

METHODS

MethodParamValidationSchema()

Default parameter validation schema for social media article drivers.

APIRequest()

Emit a push event, which adds it to the event queue to be processed by the daemon.

    $Self->EmitPushEvent(
        EventName  => 'TicketSubscribe',
        Attributes => {
            TicketID => 123,
            UserID   => 12,
        },
    );