이벤트 함수

스크립트에 정해진 이름의 함수를 만들어 두면, 그 일이 생길 때 StarLight가 함수를 불러요. NeonJS 프로젝트에서는 함수를 export 해야 해요.

export function onMessage(event) { … }

function onMessage(event) { … }

기본 이벤트#

메신저봇 API2 이벤트#

메신저봇 API2 방식의 이벤트는 함수 이름이 아니라 bot.addListener()로 등록한 리스너로 전달돼요. 허용 이벤트 ID는 아래와 같고, 리스너와 인자는 BotManager를 보세요.

이벤트는 아래 조건을 모두 만족할 때만 불려요.

• 설정의 전역 전원이 켜져 있어요.
• 프로젝트가 컴파일되어 있고, 켜져 있어요. (디버그 룸과 사용자 지정 버튼은 꺼져 있어도 불러요.)
• 프로젝트 설정의 받을 이벤트에서 그 이벤트가 체크돼 있고, 프로젝트의 API 방식에 그 이벤트가 있어요.

이벤트는 프로젝트마다 순서대로 대기열에 들어가 차례로 실행돼요. 대기열이 가득 차면(256개) 가장 오래된 이벤트부터 버려져요.

onMessage#

export function onMessage(event) {
    const { message, sender, room } = event;
    if (message === "/방정보")
        room.send(`${room.name} (${room.isGroupChat() ? "단체방" : "1:1"}) · ${sender.name}`);
}

event#

event.room#

event.sender#

onMessageDeleted#

카카오톡에서 가장 최근에 받은 메시지가 삭제되면 불려요.

response (레거시)#

메신저봇, 채자봇 같은 다른 앱의 봇 코드와 호환되는 함수예요. 프로젝트의 API 방식에 메신저봇 레거시가 있어야 불려요. StarLight 오리지널도 함께 고르면 메시지마다 onMessage 다음에 response도 불려요.

function response(room, msg, sender, isGroupChat, replier, imageDB) {
    if (msg === "/안녕")
        replier.reply(sender + "님 안녕하세요!");
}

일곱 번째 인자 packageName은 메신저 앱의 패키지 이름이에요 (com.kakao.talk).

읽음 처리는 replier에 없으니 Api.markAsRead()를 쓰세요.

onNotificationPosted#

설정 → 알림, 이벤트에서 onNotificationPosted 이벤트 사용을 켜면, StarLight를 뺀 모든 앱의 알림이 이 함수로 들어와요. 인자 sbn은 Android의 StatusBarNotification이에요.

export function onNotificationPosted(sbn) {
    const extras = sbn.getNotification().extras;
    console.log(sbn.getPackageName(), String(extras.getCharSequence("android.title")));
}

알림이 많은 기기에서는 부하가 커질 수 있어요. 필요할 때만 켜세요.

onStartCompile#

이미 컴파일된 프로젝트를 다시 컴파일할 때, 이전 상태를 정리하기 직전에 불려요. 처음 컴파일할 때는 불리지 않아요. 열어 둔 연결을 닫거나 값을 저장하는 데 쓰고, 오래 걸리는 작업은 하지 마세요.

onProjectButtonClicked#

프로젝트 설정의 실험적 기능 → 사용자 지정 버튼에 버튼을 추가하면 프로젝트 카드에 버튼이 생겨요. 버튼을 누르면 버튼에 정한 ID가 buttonId로 넘어와요. 프로젝트가 컴파일되어 있어야 하고, 꺼져 있어도 불려요.

let count = 0;

export function onMessage(event) {
    count++;
}

export function onProjectButtonClicked(buttonId) {
    if (buttonId === "reset") {
        count = 0;
        Log.i("button", "초기화했어요");
    }
}

플러그인 이벤트#

플러그인이 더한 이벤트도 같은 방식으로 받아요. 프로젝트 설정의 받을 이벤트에서 그 플러그인의 이벤트를 체크하고(ID로는 예: webserver.*), 플러그인이 정한 이름의 함수를 만들어요. 함수 이름과 인자는 각 플러그인의 문서를 보세요.