Attach event listeners in OS X JavaScript for Automation (JXA)

Question

How is it possible to listen for events in OS X JavaScript for automation.

In the scripting Library for the Messages application there is a list of event handlers, such as messageSent and messageReceived. However, I cannot figure out how to use them. Trying to pass a function yields an error, and trying to set these variables to new functions causes the REPL to hang.

What is the proper way to set up these event handlers?

Answer 1

You would create a script that you then select from the AppleScript handler menu in Preferences > General. Use the built-in Speak Events.applescript file as your guide and be aware that you have to override every single handler for it to execute properly.

Note: even with Standard Additions included, you still cannot call scripting addition commands like say() likely due to how they've implemented this layer on top of the scripting engine, making even an appropriate call using currentApplication() look as if it is being sent cross-application.

Here is a template:

Messages = Application.currentApplication()
Messages.includeStandardAdditions = true

function messageSent(m, e) {
}

function messageReceived(m, e) {
}

function chatRoomMessageReceived(e) {
}

function activeChatMessageReceived(m, e) {
}

function addressedMessageReceived(m, b, c, e) {
}

function receivedTextInvitation(e) {
}

function receivedAudioInvitation(m, b, c, e) {
}

function receivedVideoInvitation(m, b, c, e) {
}

function receivedLocalScreenSharingInvitation(b, c, e) {
}

function buddyAuthorizationRequested(e) {
}

function addressedChatRoomMessageReceived(e) {
}

function receivedRemoteScreenSharingInvitation(e) {
}

function loginFinished(e) {
}

function logoutFinished(e) {
}

function buddyBecameAvailable(e) {
}

function buddyBecameUnavailable(e) {
}

function receivedFileTransferInvitation(e) {
}

function avChatStarted(e) {
}

function avChatEnded(e) {
}

function completedFileTransfer(e) {
}

Answer 2

I’ve gotten say to work in OS X 10.11.3 Beta (15D9c).

ObjC.import('stdlib')
var yell = "say"

function run() {
    //  messageReceived("test",{from:Application("Messages").services.byName("SMS").buddies[0]})
}

function execute(program, args) {
    var command = program + " " + args.map(q).join("")
    console.log(command)
    $.system(command)

    function q(s) {
        return " '" + s.replace("'", "'\\''") + "' "
    }
}

function messageReceived(text, who) {
    execute(yell, [who.from.name(), text])
}

function loginFinished(service) {
    execute(yell, ["login", service.for.name()])
}

function logoutFinished(service) { // doesn't work!
    execute(yell, ["Logout", service.for.name()])
}

function keys(o) { // debugging tool
    return Object.keys(o).join(",")
}
receivedTextInvitation = addressedMessageReceived = chatRoomMessageReceived = activeChatMessageReceived = messageReceived

function messageSent() {}

function receivedAudioInvitation() {}

function receivedVideoInvitation() {}

function receivedLocalScreenSharingInvitation() {}

function buddyAuthorizationRequested() {}

function addressedChatRoomMessageReceived() {}

function receivedRemoteScreenSharingInvitation() {}

function logoutFinished() {}

function buddyBecameAvailable() {}

function buddyBecameUnavailable() {}

function receivedFileTransferInvitation() {}

function avChatStarted() {}

function avChatEnded() {}

function completedFileTransfer() {}