GS2-Inbox 스크립트 트리거 레퍼런스

확장 스크립트를 호출하는 이벤트 트리거의 레퍼런스

트리거

receiveMessage

메시지 수신

동기 실행 스크립트

메시지 수신 처리 전에, 스크립트가 동기 실행됩니다.

Request
타입설명
namespaceNamespace네임스페이스
messageMessage메시지
Result
타입필수기본값값 제한설명
permitbool
메시지 수신을 허용할지 여부
overrideMetadatastring0 ~ 4096자덮어쓸 메타데이터
구현 예제
-- Request
local namespace = args.namespace
local message = args.message

-- Business logic:
local permit = true
local overrideMetadata = ""

-- Result
result = {
  permit=permit,
  overrideMetadata=overrideMetadata
}

비동기 실행 스크립트

메시지 수신 처리 후에, 스크립트가 비동기 실행됩니다.

Request
타입설명
namespaceNamespace네임스페이스
messageMessage메시지
구현 예제
-- Request
local namespace = args.namespace
local message = args.message

-- 비동기 스크립트는 일반적으로 API 응답에 영향을 주지 않습니다.
-- 로그 출력이나 분석, 외부 알림 등에 사용됩니다.

result = {
}

readMessage

메시지 개봉

동기 실행 스크립트

메시지 개봉 처리 전에, 스크립트가 동기 실행됩니다.

Request
타입설명
namespaceNamespace네임스페이스
messageMessage메시지
Result
타입필수기본값값 제한설명
permitbool
메시지 개봉을 허용할지 여부
구현 예제
-- Request
local namespace = args.namespace
local message = args.message

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

비동기 실행 스크립트

메시지 개봉 처리 후에, 스크립트가 비동기 실행됩니다.

Request
타입설명
namespaceNamespace네임스페이스
messageMessage메시지
구현 예제
-- Request
local namespace = args.namespace
local message = args.message

-- 비동기 스크립트는 일반적으로 API 응답에 영향을 주지 않습니다.
-- 로그 출력이나 분석, 외부 알림 등에 사용됩니다.

result = {
}

deleteMessage

메시지 삭제

동기 실행 스크립트

메시지 삭제 처리 전에, 스크립트가 동기 실행됩니다.

Request
타입설명
namespaceNamespace네임스페이스
messageMessage메시지
Result
타입필수기본값값 제한설명
permitbool
메시지 삭제를 허용할지 여부
구현 예제
-- Request
local namespace = args.namespace
local message = args.message

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

비동기 실행 스크립트

메시지 삭제 처리 후에, 스크립트가 비동기 실행됩니다.

Request
타입설명
namespaceNamespace네임스페이스
messageMessage메시지
구현 예제
-- Request
local namespace = args.namespace
local message = args.message

-- 비동기 스크립트는 일반적으로 API 응답에 영향을 주지 않습니다.
-- 로그 출력이나 분석, 외부 알림 등에 사용됩니다.

result = {
}