App 객체의 프로퍼티 / 메소드 | |
---|---|
android.content.Context |
반환값앱의 Context |
void |
매개변수
|
API2
API2는 최근에 공개된 내장 API로, 레거시 API보다 더 체계적인 구조로 되어 있습니다. 카카오톡봇의 지원은 API2를 중심으로 이루어질 예정입니다.
객체
App
App
객체는 봇 구동 앱에 관한 기능들을 담고 있는 객체입니다.
Bot
Bot
객체는 카카오톡봇을 소스 코드 상에서 카카오톡봇을 개념화하는 객체입니다.
Bot 객체의 프로퍼티 / 메소드 | |
---|---|
void |
매개변수
|
Boolean |
반환값
매개변수
|
Boolean |
반환값
매개변수
|
String |
반환값카카오톡봇의 이름 |
void |
매개변수
|
Boolean |
반환값스크립트가 활성화 상태일 경우 |
void |
|
void |
|
void |
매개변수
|
void |
매개변수
|
void |
매개변수
|
void |
매개변수
|
Array<Function> |
반환값
매개변수
|
Boolean |
반환값메시지가 온 방에 대한 알림 읽기 세션을 찾을 수 있을 경우 매개변수
|
Boolean |
반환값
매개변수
|
BotManager
BotManager
객체는 Bot
객체를 관리/보조해주는 객체입니다.
BotManager 객체의 프로퍼티 / 메소드 | |
---|---|
Bot |
반환값스크립트에 할당된 |
Bot |
반환값
매개변수
|
Array<String> |
반환값
매개변수
|
Array<Bot> |
반환값모든 |
Boolean |
반환값
매개변수
|
void |
매개변수
|
Boolean |
반환값
매개변수
|
void |
|
Number |
반환값컴파일에 실패할 경우: 매개변수
|
Number |
반환값새롭게 컴파일된 매개변수
|
Boolean |
반환값
매개변수
|
void |
|
Broadcast
Broadcast
객체는 다른 스크립트 간의 데이터 교류를 지원하는 객체입니다.
Broadcast 객체의 프로퍼티 / 메소드 | |
---|---|
void |
매개변수
|
void |
매개변수
|
void |
매개변수
|
void |
|
Database
Database
객체 스크립트 로컬 폴더의 /Database
폴더 내 데이터 조작에 관한 객체입니다.
Database 객체의 프로퍼티 / 메소드 | |
---|---|
Boolean |
반환값
매개변수
|
Object |
반환값
매개변수
|
String |
반환값
매개변수
|
void |
매개변수
|
void |
매개변수
|
Device
Device
객체는 구동 환경/기기에 관한 정보를 제공하는 메소드들을 모은 객체입니다.
Device 객체의 프로퍼티 / 메소드 | |
---|---|
android.os.Build |
반환값
|
Number |
반환값앱 구동 환경의 안드로이드 버전 코드 |
String |
반환값앱 구동 환경의 안드로이드 버전 이름 |
String |
반환값앱 구동 기기의 브랜드명 |
String |
반환값앱 구동 기기의 모델명 |
Boolean |
반환값앱 구동 기기가 충전 중일 경우 |
String |
반환값
|
Number |
반환값앱 구동 기기의 배터리 잔량(%) |
Number |
반환값앱 구동 기기의 배터리 건강 상태를 나타내는 상수
|
Number |
반환값앱 구동 기기의 배터리 온도( |
Number |
반환값앱 구동 기기의 배터리 전압(mV) |
Number |
반환값앱 구동 기기의 배터리 상태를 나타내는 상수
|
android.content.Intent |
반환값
|
Event
Event
객체는 API2에서 제공하는 이벤트들에 대한 상수들을 제공하는 객체입니다.
Event 객체의 프로퍼티 / 메소드 | |
---|---|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
FileStream
FileStream
객체는 내부 저장소의 파일을 다루는 객체입니다.
FileStream 객체의 프로퍼티 / 메소드 | |
---|---|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
Boolean |
반환값파일 삭제에 성공할 경우 매개변수
|
GlobalLog
GlobalLog
객체는 앱 내 글로벌 로그에 로그를 기록할 수 있게 하는 객체입니다.
GlobalLog 객체의 프로퍼티 / 메소드 | |
---|---|
void |
매개변수
|
void |
매개변수
|
void |
매개변수
|
void |
|
Http
Http
객체는 웹 상에서의 request(리퀘스트; 요청)에 관한 기능을 제공하는 객체입니다.
Http 객체의 프로퍼티 / 메소드 | |
---|---|
void |
매개변수
|
org.jsoup.nodes.Document |
반환값요청에 대한 응답 ( 매개변수
|
request 옵션 구조
JSON
{ "url": String, // request를 보낼 URL "timeout": Number, // request 타임아웃 (밀리초; 기본값: 3000) "method": String, // request 메소드 (기본값: "GET") "headers": { /* Header */ } // request 헤더 (기본값: null) }
Log
Log
객체는 앱 내 스크립트 로그에 로그를 기록할 수 있게 하는 객체입니다.
Log 객체의 프로퍼티 / 메소드 | |
---|---|
void |
매개변수
|
void |
매개변수
|
void |
매개변수
|
void |
|
sessionManager
sessionManager
객체는 채팅방 세션을 수동으로 등록할 수 있게 해주는 객체입니다.
sessionManager 객체의 프로퍼티 / 메소드 | |
---|---|
Boolean |
반환값
매개변수
|
Security
Security
객체는 각종 암호화/복호화에 관한 기능들을 제공하는 객체입니다.
Security 객체의 프로퍼티 / 메소드 | |
---|---|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값생성한 DES 보조키 |
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
String |
반환값
매개변수
|
이벤트
API2는 이벤트 리스너가 지정되어 있지 않으며, 여러 이벤트가 존재합니다.
activityBackPressed
activityBackPressed
이벤트는 스크립트 액티비티의 onBackPressed
가 호출되면 발생하는 이벤트입니다.
activityBackPressed 이벤트의 인자 | |
---|---|
android.app.Activity |
|
activityCreate
activityCreate
이벤트는 스크립트 액티비티의 onCreate
가 호출되면 발생하는 이벤트입니다.
activityCreate 이벤트의 인자 | |
---|---|
android.app.Activity |
|
activityDestroy
activityDestroy
이벤트는 스크립트 액티비티의 onDestroy
가 호출되면 발생하는 이벤트입니다.
activityDestroy 이벤트의 인자 | |
---|---|
android.app.Activity |
|
activityPause
activityPause
이벤트는 스크립트 액티비티의 onPause
가 호출되면 발생하는 이벤트입니다.
activityPause 이벤트의 인자 | |
---|---|
android.app.Activity |
|
activityRestart
activityRestart
이벤트는 스크립트 액티비티의 onRestart
가 호출되면 발생하는 이벤트입니다.
activityRestart 이벤트의 인자 | |
---|---|
android.app.Activity |
|
activityResume
activityResume
이벤트는 스크립트 액티비티의 onResume
가 호출되면 발생하는 이벤트입니다.
activityResume 이벤트의 인자 | |
---|---|
android.app.Activity |
|
activityStart
activityStart
이벤트는 스크립트 액티비티의 onStart
가 호출되면 발생하는 이벤트입니다.
activityStart 이벤트의 인자 | |
---|---|
android.app.Activity |
|
activityStop
activityStop
이벤트는 스크립트 액티비티의 onStop
가 호출되면 발생하는 이벤트입니다.
activityStop 이벤트의 인자 | |
---|---|
android.app.Activity |
|
notificationPosted
notificationPosted
이벤트는 기기에 알림이 발생할 때 마다 발생하는 이벤트입니다.
notificationPosted 이벤트의 인자 | |
---|---|
android.service.notification.StatusBarNotification |
|
SessionManager |
|
startCompile
startCompile
이벤트는 컴파일 요청을 감지했을 때 컴파일 시작 전에 발생하는 이벤트입니다. 이 이벤트는 인자를 필요로 하지 않습니다.
tick
주의
이 이벤트는 아직 구현되지 않았습니다.
tick
이벤트는 매 틱마다 발생하는 이벤트입니다.
message
message
이벤트는 메신저 앱에 메시지가 수신되었을 때 마다 발생하는 이벤트입니다.
message 이벤트의 인자 | |
---|---|
Object |
|
msg 인자 정보
JSON
{ "room": String, // 메시지가 온 방의 이름 "channelId": BigInt, // 메시지가 온 방의 고유 아이디 "content": String, // 메시지의 내용 "isGroupChat": Boolean, // 방 내 인원이 3인 이상인지의 여부 "isDebugRoom": Boolean, // 디버깅룸에서 온 메시지인지의 여부 "image": { // 메시지에 포함된 사진에 대한 정보를 담고 있는 객체 (카카오톡 알림 구조 변경에 따라 안될 가능성이 높음) "getBase64": Function, // 채팅속 사진의 Base64 값을 반환 "getBitmap": Function // 채팅속 사진의 android.graphics.Bitmap을 반환 }, "isMention": Boolean, // 채팅에 멘션 포함 여부, "logId": BigInt, // 각 채팅에 대한 고유 아이디 "author": { // 메시지 전송자에 대한 정보를 담고 있는 객체 "name": String, // 메시지를 보낸 유저의 이름 "avatar": { // 메시지 전송자 프로필에 대한 정보 "getBase64": Function, // 전송자 프로필의 Base64 값을 반환 "getBitmap": Function // 전송자 프로필의 android.graphics.Bitmap을 반환 }, "hash": String // 안드로이드 11이상에서만 사용가능, 동일 방에 한하여, 같은 유저는 프로필이 변경되어도 같은 값 }, "reply": Function(content), // 메시지가 온 방에 content를 전송 (content: String) "markAsRead": Function, // 메시지가 온 방의 알림을 읽음 처리 "packageName": String // 메시지가 온 메신저 앱의 패키지명 }
command
command
이벤트는 Bot.setCommandPrefix()
에 의해 정해진 접두어로 시작하는 메시지가 수신되었을 때마다 발생하는 이벤트입니다.
command 이벤트의 인자 | |
---|---|
Object |
|
msg 인자 정보
JSON
{ "command": String, // 명령어의 이름 ('/angles 30 60 90' 이라는 메시지일 때 "angles") "args": Array, // 명령어의 인자들의 배열 (인자가 없을 경우 길이가 0인 배열 반환; 가령, '/angles 30 60 90' 이라는 메시지일 때 ["30", "60", "90"]) "room": String, // 메시지가 온 방의 이름 "channelId": BigInt, // 메시지가 온 방의 고유 아이디 "content": String, // 메시지의 내용 "isGroupChat": Boolean, // 방 내 인원이 3인 이상인지의 여부 "isDebugRoom": Boolean, // 디버깅룸에서 온 메시지인지의 여부 "image": { // 메시지에 포함된 사진에 대한 정보를 담고 있는 객체 (카카오톡 알림 구조 변경에 따라 안될 가능성이 높음) "getBase64": Function, // 채팅속 사진의 Base64 값을 반환 "getBitmap": Function // 채팅속 사진의 android.graphics.Bitmap을 반환 }, "isMention": Boolean, // 채팅에 멘션 포함 여부, "logId": BigInt, // 각 채팅에 대한 고유 아이디 "author": { // 메시지 전송자에 대한 정보를 담고 있는 객체 "name": String, // 메시지를 보낸 유저의 이름 "avatar": { // 메시지 전송자 프로필에 대한 정보 "getBase64": Function, // 전송자 프로필의 Base64 값을 반환 "getBitmap": Function // 전송자 프로필의 android.graphics.Bitmap을 반환 }, "hash": String // 안드로이드 11이상에서만 사용가능, 동일 방에 한하여, 같은 유저는 프로필이 변경되어도 같은 값 }, "reply": Function(content), // 메시지가 온 방에 content를 전송 (content: String) "markAsRead": Function, // 메시지가 온 방의 알림을 읽음 처리 "packageName": String // 메시지가 온 메신저 앱의 패키지명 }