Minitalk Defined : /scripts/minitalk.js
Minitalk 자바스크립트 클래스의 경우, 미니톡 채팅위젯을 홈페이지상에 출력하기 위해 사용하는 API 클래스입니다.
CONFIGS 의 설정값들을 이용하여 미니톡 채팅위젯을 웹사이트내에 원하는 곳에 삽입하여 사용이 가능합니다.
회원연동 등을 하기 위해서는 별도의 서버사이드언어(PHP, ASP, JSP 등)을 이용하여 유저코드(usercode)를 생성하여 사용하셔야 하며, 해당 코드를 생성하는 방법은 CONFIGS 의 usercode 부분을 참고하시면 설명되어 있습니다.
- 이 기능은 문제의 소지가 있어 제거되었거나 제거될 예정입니다.
- 아직 안정적이라고 고려될만큼 충분한 테스트를 거치지 않았습니다.(합당하다면 하위호환성이 보장됩니다.)
- API가 충분히 검증되었지만, 기반이 되는 코드의 정리 때문에 마이너한 변경이 있을 수 있습니다.(하위호환성이 보장됩니다.)
- 심각한 버그가 발견되지 않는 한 이 코드는 절대 변경되지 않습니다.
CONFIGS
-
REQchannel:
미니톡 채팅위젯에서 접속할 채널명을 설정합니다.
최종수정일 :미니톡 채팅위젯에서 접속하게 될 채널명을 입력합니다.
해당 채널명은 미니톡 클라이언트 관리자 채널관리에서 생성한 채널명을 의미합니다.
-
dateFormat:
(기본값 : A mm:ss) 대화시각을 표시하는 형식을 지정한다.
최종수정일 :대화시각을 표시하는 형식을 지정한다.
이 설정값을 비워둘 경우 대화가 이루어진 시각표시가 되지 않습니다.
YYYY : 4자리 년도 (2021)
YY : 2자리 년도 (21)
MM : 2자리 월 (01 ~ 12)
M : 1자리 월 (1 ~ 12)
MMM : 월 이름 (1월 ~ 12월, 미니톡 채팅위젯의 언어가 영문일 경우 Jan ~ Dec)
MMMM : 월 이름 (1월 ~ 12월, 미니톡 채팅위젯의 언어가 영문일 경우 January ~ December)
DD : 2자리 일 (01 ~ 31)
D : 1자리 일 (1~31)
ddd : 요일 (월 ~ 일, 미니톡 채팅위젯의 언어가 영문일 경우 Mon ~ Sun)
dddd : 요일 (월요일 ~ 일요일, 미니톡 채팅위젯의 언어가 영문일 경우 Monday ~ Sunday)
HH : 2자리 24시간제 시간 (00 ~ 24)
H : 1자리 24시간제 시간 (0 ~ 24)
hh : 2자리 12시간제 시간 (00 ~ 12)
h : 1자리 12시간제 시간 (0 ~ 12)
mm : 2자리 분 (00 ~ 59)
m : 1자리 분 (0 ~ 59)
ss : 2자리 초 (00 ~ 59)
s : 1자리 초 (0 ~ 59)
a : 오전/오후 (미니톡 채팅위젯의 언어가 영문일 경우 am, pm)
A : 오전/오후 (미니톡 채팅위젯의 언어가 영문일 경우 AM, PM)
-
height:
(기본값 : 500) 미니톡의 세로크기를 정의합니다.
최종수정일 :미니톡의 세로크기를 픽셀(px)또는 퍼센트(%) 단위로 설정합니다.
픽셀(px) 단위로 정의할 경우 int 형식으로 설정하셔야 하며, 퍼센트(%) 단위일 경우 string 형식으로 설정하셔야 합니다.
퍼센트(%) 단위의 경우 미니톡 채팅위젯이 들어가는 상위 DOM 객체의 세로크기에 영향을 받습니다.
-
REQid:
현재의 미니톡 객체를 가르키는 고유한 값을 설정합니다.
최종수정일 :미니톡 위젯의 고유값을 지정합니다.
이 값은 미니톡 위젯의 설정을 사용자의 브라우저에 저장하기 위한 용도로 사용되거나, MinitalkComponent 에서 현재의 미니톡 위젯을 호출하기 위해 사용될 수 있습니다.
이 값은 HTML 의 id 와 동일한 역할을 하며, 하나의 웹페이지내에서 모든 HTML 요소에 사용된 id 값과 중복되지 않는 유일한 값이어야 합니다.
-
listeners:
이벤트 리스너를 정의합니다.
최종수정일 :이벤트 리스너를 정의합니다.
플러그인 등이나, 다른 방법으로 Minitalk.on() 함수를 사용하여 이벤트리스너를 추가로 정의할 수 있습니다.
이벤트 종류 및 이벤트 리스너의 매개변수는 이벤트함수를 참고하여 주시기 바랍니다.
-
logCount:
(기본값 : 15) 서버접속시 가져올 이전대화기록의 갯수를 설정한다.
최종수정일 :미니톡에 최초접속시 접속이전에 이루어진 이전대화기록을 가져올 갯수를 설정합니다.
0 으로 설정할 경우 이전대화기록을 불러오지 않으며, 최대 30개 까지 설정할 수 있습니다.
이전대화기록은 서버의 상태에 따라 설정된 갯수보다 적게 불러올 수 있습니다.
-
protocols:
사용자정의 프로토콜을 정의합니다.
최종수정일 :사용자정의 프로토콜을 정의합니다.
플러그인 등이나, 다른 방법으로 Minitalk.socket.setProtocol() 함수를 사용하여 사용자정의 프로토콜을 추가로 정의할 수 있습니다.
-
REQtemplet:
미니톡 채팅위젯의 템플릿을 설정한다.
최종수정일 :미니톡 채팅위젯의 템플릿을 설정합니다.
템플릿은 템플릿폴더(/templets) 아래의 템플릿 폴더명(예 : default 또는 dark 등)을 입력하시면 됩니다.
-
tools:
미니톡 툴바에 나타날 툴버튼을 정의한다.
최종수정일 :툴버튼은 아래의 미리 정의된 문자열을 사용하거나, 사용자정의 툴버튼을 사용할 수 있습니다.
기본값으로 ["bold","underline","italic","color","-","emoticon","file"] 으로 정의되어 있습니다.
미리 정의된 문자열
- : 툴버튼 구분선
bold : 폰트설정 굵게 (채팅권한설정에 폰트설정권한이 없는경우 보이지 않음)
underline : 폰트설정 밑줄 (채팅권한설정에 폰트설정권한이 없는경우 보이지 않음)
italic : 폰트설정 기울임 (채팅권한설정에 폰트설정권한이 없는경우 보이지 않음)
color : 폰트설정 색상 (채팅권한설정에 폰트설정권한이 없는경우 보이지 않음)
emoticon : 이모티콘
file : 파일첨부버튼
사용자정의 툴버튼 추가
Object {
name:string : 고유값으로 영문 및 숫자로만 이루어져야합니다.
text:string : 사용자에게 보일 툴버튼 명칭
icon:string : 툴버튼 아이콘 이미지 경로
iconClass:string : 툴버튼 아이콘 스타일시트 (아이콘폰트 등의 스타일을 지정할 수 있습니다.)
visible:function(minitalk,me) : 툴버튼 보임여부 (minitalk : 미니톡객체, me : 나의정보)
handler:function(minitalk,e) : 툴버튼 클릭시 실행될 함수 (minitalk : 미니톡객체, e : 클릭이벤트)
}
name:string 은 필수값으로 지정되어야 합니다.
icon:string 또는 iconClass:string 두개 설정값 중 한개 이상 설정이 되어 있어야 툴버튼 아이콘이 표시됩니다.
visible:function(minitalk,me) 에서 해당 함수가 false 를 반환할 경우 툴버튼이 보이지 않습니다.
handler:function(minitalk,e) 에서 minitalk 객체를 이용하여 미니톡 내부함수에 접근할 수 있습니다.
자세한 사용은 아래 예제를 참고하시기 바랍니다.
툴버튼은 Minitalk.ui.appendTool() 함수를 이용해서도 추가할 수 있습니다.
-
toolType:
(기본값 : icon) 툴바버튼의 형식을 지정한다.
최종수정일 :icon : 툴바아이콘만 표시한다.
text : 툴바명칭만 표시한다.
icontext : 툴바아이콘 및 명칭만 표시한다.
일부 미니톡 채팅위젯 템플릿에 따라 설정값이 적용되지 않을 수 있습니다.
-
type:
(기본값 : auto) 미니톡 채팅위젯의 가로/세로모드를 설정한다.
최종수정일 :horizontal : 가로모드 (접속자목록이 우측에 표시됩니다.)
vertical : 세로모드 (접속자목록이 상단에 표시됩니다.)
auto : 자동 (가로너비에 따라 자동으로 적절한 상태로 표시됩니다.)
-
usercode:
회원연동을 위한 유저코드를 설정합니다.
최종수정일 :미니톡 채팅위젯에서 회원정보를 연동하여 사용하기 위한 유저코드를 설정합니다.
해당 유저코드는 보안을 위하여 서버사이드언어(PHP, ASP, PHP 등)을 이용하여 생성한 뒤 정의해주셔야 합니다.
유저코드를 생성하기 위한 암호화 방식은 PHP Minitalk 클래스 (/classes/Minitalk.class.php)의 getUserCode() 함수를 확인하여 생성하실 수 있습니다.
자세한 사용은 사용자매뉴얼 > 미니톡 채팅위젯 회원 연동하기 문서를 참고하여 주시기 바랍니다.
-
usermenus:
미니톡 유저메뉴에 나타날 메뉴를 정의한다.
최종수정일 :유저메뉴는 아래의 미리 정의된 문자열을 사용하거나, 사용자정의 메뉴를 사용할 수 있습니다.
기본값으로 ["configs","create","-","whisper","call","invite","-","showip","banip","op","deop"] 으로 정의되어 있습니다.
미리 정의된 문자열
- : 메뉴 구분선
configs : 환경설정 (본인외에 보이지 않음)
create : 개인박스(개인채널)생성 (본인외에 보이지 않음)
whisper : 귓속말보내기 (본인에게 보이지 않음)
call : 호출하기 (본인에게 보이지 않음)
invite : 개인박스(개인채널)초대 (본인에게 보이지 않음)
showip : 아이피확인 (관리자외 보이지 않음)
banip : 아이피차단 (관리자외 보이지 않음)
op : 관리자권한 부여 (관리자외 보이지 않음)
deop : 관리자권한 해제 (관리자외 보이지 않음)
사용자정의 메뉴 추가
Object {
name:string : 고유값으로 영문 및 숫자로만 이루어져야합니다.
icon:string : 메뉴 아이콘 이미지 경로
iconClass:string : 메뉴 아이콘 스타일시트 (아이콘폰트 등의 스타일을 지정할 수 있습니다.)
visible:function(minitalk,user,me) : 메뉴 보임여부 (minitalk : 미니톡객체, user : 메뉴를 클릭한 유저, me : 접속자정보)
handler:function(minitalk,user,e) : 메뉴 클릭시 실행될 함수 (minitalk : 미니톡객체, user : 메뉴를 클릭한 유저, e : 클릭이벤트)
}
name:string 은 필수값으로 지정되어야 합니다.
icon:string 또는 iconClass:string 두개 설정값 중 한개 이상 설정이 되어 있어야 메뉴 아이콘이 표시됩니다.
visible:function(minitalk,user,me) 에서 해당 함수가 false 를 반환할 경우 메뉴가 보이지 않습니다.
handler:function(minitalk,user,e) 에서 minitalk 객체를 이용하여 미니톡 내부함수에 접근할 수 있습니다.
자세한 사용은 아래 예제를 참고하시기 바랍니다.
유저메뉴는 Minitalk.user.appendMenu() 함수를 이용해서도 추가할 수 있습니다.
-
viewConnectMessage:
(기본값 : true) 서버접속 안내메시지를 보일지 설정한다.
최종수정일 :미니톡 서버에 접속할 경우 [닉네임]님 [채널]에 접속하였습니다. 등의 접속안내 메시지를 보일지 말지 설정합니다.
false 로 설정할 경우 접속안내 메시지를 보이지 않습니다.
-
viewUserNotification:
유저의 접속/접속종료/정보변경 안내메시지를 보일지 설정합니다.
최종수정일 :유저의 접속/접속종료/정보변경 메시지를 보일지 설정합니다.
기본값으로 ["join", "leave", "update"] 으로 설정되어 있으며, 메시지를 출력하고 싶은 타입을 배열형태로 지정하면 됩니다.
join : 유저의 접속안내 메시지
leave : 유저의 접속종료 메시지
update : 유저의 정보변경 메시지
유저의 접속, 접속종료, 정보변경 메시지 모두를 보이지 않게 설정하려면 [] 으로 설정하시면 됩니다.
또한 유저접속 메시지는 viewUserNotificationLimit 에 의해 설정된 유저레벨 이상의 유저메시지만 표시됩니다.
-
viewUserNotificationLimit:
유저의 접속/접속종료/정보변경 안내메시지를 보일 유저의 최소레벨을 설정합니다.
최종수정일 :유저의 접속/접속종료/정보변경 안내메시지를 보일 대상 유저의 최소레벨을 설정합니다.
0 으로 설정시 모든 유저의 접속/접속종료/정보변경 안내메시지가 보입니다.
9 로 설정할 경우 관리자 유저의 접속/접속종료/정보변경 안내메시지가 보입니다.
-
width:
(기본값 : 180) 미니톡의 가로크기를 정의합니다.
최종수정일 :미니톡의 가로크기를 픽셀(px)또는 퍼센트(%) 단위로 설정합니다.
픽셀(px) 단위로 정의할 경우 int 형식으로 설정하셔야 하며, 퍼센트(%) 단위일 경우 string 형식으로 설정하셔야 합니다.
퍼센트(%) 단위의 경우 미니톡 채팅위젯이 들어가는 상위 DOM 객체의 가로크기에 영향을 받습니다.
METHODS
-
getErrorText( errorcode):
에러코드에 해당하는 에러메시지를 가져옵니다.
최종수정일 :미니톡 에러메시지는 각 언어팩내에 "error" 변수 아래에 정의되어 있습니다.
예를들어 한국어 언어팩의 경우 /languages/ko.json 파일을 열면, 아래와 같이 언어셋이 정의되어 있습니다.
{ ... "error":{ "NOT_SELECTED":"선택된 항목이 없습니다.", "UNKNOWN":"알 수 없는 에러가 발생하였습니다.", ...
위에서 "선택된 항목이 없습니다." 라는 텍스트를 가져오려면,
Minitalk.getErrorText("NOT_SELECTED"); // 또는 getText() 함수로도 가져올 수 있습니다. Minitalk.getText("error/NOT_SELECTED");
위와 같이 가져올 수 있습니다.
-
getPluginUrl( action):
플러그인 경로를 가져옵니다.
최종수정일 :미니톡 채팅위젯 스크립트가 https://www.yourdomain.com/minitalk/scripts/minitalk.js 에 있는 경우, 아래와 같이 함수를 호출하면, https://www.yourdomain.com/minitalk/plugins/hello 를 가져올 수 있습니다.
Minitalk.getPluginUrl("hello"); // https://www.yourdomain.com/minitalk/plugins/hello 반환
pluginName 에 경로를 가져올 플러그인 명을 입력합니다.
-
getProcessUrl( pluginName):
미니톡 프로세스 경로를 가져옵니다.
최종수정일 :미니톡 채팅위젯 스크립트가 https://www.yourdomain.com/minitalk/scripts/minitalk.js 에 있는 경우, 아래와 같이 함수를 호출하면, https://www.yourdomain.com/minitalk/process/getServer 를 가져올 수 있습니다.
Minitalk.getProcessUrl("getServer"); // https://www.yourdomain.com/minitalk/process/getServer 반환
action 변수에 프로세스를 호출할 action 값을 전달합니다.
해당 action 값은 미니톡 클라이언트가 설치된 폴더의 /process/ 폴더를 보시면 각각의 action 명으로 php 파일이 존재합니다.
-
getText( code [, replacement = null ]):
미니톡 클라이언트 언어팩에서 언어코드에 해당하는 문자열을 가져옵니다.
최종수정일 :미니톡 채팅위젯에서 설정된 언어에 따라, 미니톡 클라이언트 언어팩에서 언어코드에 해당하는 문자열을 가져옵니다.
언어파일은 json 으로 되어 있으며, languages 폴더안에 언어코드로 저장되어 있습니다.
예를들어 한국어 언어팩의 경우 /languages/ko.json 파일을 열면, 아래와 같이 언어셋이 정의되어 있습니다.
{ "text":{ "unit":"{COUNT}명", "me":"나", ...
위에서 "나" 라는 텍스트를 가져오려면,
Minitalk.getText("text/me");
위와 같이 가져올 수 있습니다.
-
getUrl():
미니톡 채팅위젯의 스크립트가 있는 경로를 가져옵니다.
최종수정일 :미니톡 채팅위젯 스크립트가 https://www.yourdomain.com/minitalk/scripts/minitalk.js 에 있는 경우, 아래와 같이 함수를 호출하면, https://www.yourdomain.com/minitalk/scripts 를 가져올 수 있습니다.
Minitalk.getUrl(); // https://www.yourdomain.com/minitalk/scripts 반환
-
on( eventName, callback):
이벤트리스너를 등록합니다.
최종수정일 :이벤트 리스너를 등록합니다.
미니톡 채팅위젯에 바로 설정할 경우 listeners 설정값을 통해 등록할 수 있습니다.
같은 이벤트명에 여러개의 이벤트 리스너를 정의할 경우, 이 함수를 이용하여 정의할 수 있습니다.
이벤트 종류 및 이벤트 리스너의 매개변수는 이벤트함수를 참고하여 주시기 바랍니다.
-
session( key [, value ]):
브라우저의 세션스토리지에 데이터를 저장합니다.
최종수정일 :미니톡 채팅위젯내에서 사용되는 임시 변수명을 저장하거나 가져올 수 있습니다.
세션 스토리지는 페이지가 완전히 닫히기전까지 데이터를 보관할 수 있습니다.
Minitalk.session("myKey","myValue"); // myKey 이름으로 myValue 값을 저장합니다. Minitalk.session("mykey"); // myKey 이름으로 저장된 데이터(여기선 myValue)를 가져옵니다.
저장되는 데이터 형식(object, int, string 등)에는 제한이 없습니다. (단, 함수는 저장되지 않습니다.)
-
storage( key [, value ]):
브라우저의 로컬스토리지에 데이터를 저장합니다.
최종수정일 :미니톡 채팅위젯내에서 사용되는 임시 변수명을 저장하거나 가져올 수 있습니다.
로컬 스토리지는 세션 스토리지와 다르게 브라우저를 종료하여도 데이터가 보존됩니다.
Minitalk.storage("myKey","myValue"); // myKey 이름으로 myValue 값을 저장합니다. Minitalk.storage("mykey"); // myKey 이름으로 저장된 데이터(여기선 myValue)를 가져옵니다.
저장되는 데이터 형식(object, int, string 등)에는 제한이 없습니다. (단, 함수는 저장되지 않습니다.)
EVENTS
-
activeTool( minitalk, tool, $tool)
사용자가 툴바 버튼을 클릭(활성화)하기 직후에 발생합니다.
최종수정일 :Minitalk minitalk : 이벤트가 발생한 미니톡 객체
string/object tool : 클릭한 툴 객체
DOM $tool : 클릭한 툴버튼 DOM jQuery 객체
string/object tool 에서 타입이 string 인 경우 기본 툴버튼(굵게, 밑줄, 기울임, 파일, 이모티콘 등)이며, object 인 경우 사용자가 직접 정의한 툴버튼입니다.
-
afterSendMessage( minitalk, success, message)
메시지 전송이 완료되었을 때 발생합니다.
최종수정일 :자신이 메시지를 전송한 후, 해당 메시지가 서버에 전송이 완료되어 전송결과를 받았을 때 발생합니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
boolean success : 메시지 전송성공여부
object message {
string id : 메시지 고유ID
string type : 메시지 종류
string message : 메시지 내용
object data : 메시지에 포함된 추가 데이터
int time : 메시지 수신시각 (UNIXTIMESTAMP)
User user {
string uuid : 메시지 전송자 고유값
string nickname : 메시지 전송자 닉네임
string nickcon : 메시지 전송자 닉이미지
string photo : 메시지 전송자 프로필사진
int level : 메시지 전송자 레벨
object extras : 메시지 전송자 추가정보
},
object to {
string uuid : 메시지 수신자 고유값
string nickname : 메시지 수신자 닉네임
string nickcon : 메시지 수신자 닉이미지
string photo : 메시지 수신자 프로필사진
int level : 메시지 수신자 레벨
object extras : 메시지 수신자 추가정보
} : 전체 수신자인 경우 NULL
}
-
beforeActiveTool( minitalk, tool, $tool)
사용자가 툴바 버튼을 클릭(활성화)하기 직전에 발생합니다.
최종수정일 :해당 이벤트리스너에서 false 를 반환하면, 툴바버튼 클릭(활성화)를 취소합니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
string/object tool : 클릭한 툴 객체
DOM $tool : 클릭한 툴버튼 DOM jQuery 객체
string/object tool 에서 타입이 string 인 경우 기본 툴버튼(굵게, 밑줄, 기울임, 파일, 이모티콘 등)이며, object 인 경우 사용자가 직접 정의한 툴버튼입니다.
-
beforeMessage( minitalk, message)
메시지가 수신되어 미니톡 채팅위젯에 출력되기 전에 발생합니다.
최종수정일 :beforeMessage 이벤트리스너에서 false 를 반환하면, 메시지 출력이 중단됩니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
object message {
string id : 메시지 고유ID
string type : 메시지 종류
string message : 메시지 내용
object data : 메시지에 포함된 추가 데이터
int time : 메시지 수신시각 (UNIXTIMESTAMP)
User user {
string uuid : 메시지 전송자 고유값
string nickname : 메시지 전송자 닉네임
string nickcon : 메시지 전송자 닉이미지
string photo : 메시지 전송자 프로필사진
int level : 메시지 전송자 레벨
object extras : 메시지 전송자 추가정보
},
object to {string uuid : 메시지 수신자 고유값
string nickname : 메시지 수신자 닉네임
string nickcon : 메시지 수신자 닉이미지
string photo : 메시지 수신자 프로필사진
int level : 메시지 수신자 레벨
object extras : 메시지 수신자 추가정보} : 전체 수신자인 경우 NULL
}
-
beforeSendCall( minitalk, nickname)
누군가를 호출하기 직전에 발생한다.
최종수정일 :유저가 누군가를 호출하기 직전에 발생하며, 해당 이벤트리스너에서 false 를 반환하면, 호출을 중단합니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
string nickname : 호출하려는 대상의 닉네임
-
beforeSendMessage( minitalk, message)
메시지를 전송하기 직전에 발생한다.
최종수정일 :유저가 메시지를 전송하기 직전에 발생하며, 해당 이벤트리스너에서 false 를 반환하면, 메시지 전송을 중단합니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
string message : 전송하려는 메시지
-
beforeSendWhisper( minitalk, nickname, message)
귓속말을 전송하기 직전에 발생한다.
최종수정일 :유저가 귓속말을 전송하기 직전에 발생하며, 해당 이벤트리스너에서 false 를 반환하면, 귓속말 전송을 중단합니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
string nickname : 귓속말 수신자 닉네임
string message : 전송하려는 메시지
-
call( minitalk, User user)
누군가에게 호출을 받았을 때 발생한다.
최종수정일 :누군가가 나를 호출하였을 때 발생하며, 호출한 대상이 전달됩니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
object User {
string uuid : 유저고유값
string nickname : 호출한 유저닉네임
string nickcon : 호출한 유저닉이미지
string photo : 호출한 유저 프로필 이미지
int level : 호출한 유저 레벨
object extras : 호출한 유저 부가정보
}
-
command( minitalk, command, data)
메시지 입력폼에 사용자정의 명령어가 실행되었을 때 발생합니다.
최종수정일 :Minitalk minitalk : 이벤트가 발생한 미니톡 객체
string command : 명령어
string data : 명령어를 제외한 사용자가 입력한 데이터
메시지 입력폼에 슬래시(/) 명령어 중 기본 명령어가 아닌 사용자정의된 명령어를 추가하여 사용할 경우 사용합니다.
자세한 예제소스는 주사위 플러그인을 참고하시기 바랍니다.
-
connect( minitalk, channel, me, count)
미니톡 서버에 접속되어 채널에 접속하였을 경우 발생합니다.
최종수정일 :Minitalk minitalk : 이벤트가 발생한 미니톡 객체
object channel {
string channel : 채널이름 (example)
string title : 채널명 (미니톡 예제체널)
}
User me {
string uuid : 유저고유값
string nickname : 나의 닉네임
string nickcon : 나의 닉이미지
string photo : 나의 프로필 이미지
int level : 나의 레벨
object extras : 나의 부가정보
}
int count : 접속한 채널에 현재 접속한 인원수
-
connecting( minitalk, channel, me, count)
서버에 접속하여 최근대화목록을 불러오기 직전에 발생합니다.
최종수정일 :Minitalk minitalk : 이벤트가 발생한 미니톡 객체
object channel {
string channel : 채널이름 (example)
string title : 채널명 (미니톡 예제체널)
}
User me {
string uuid : 유저고유값
string nickname : 나의 닉네임
string nickcon : 나의 닉이미지
string photo : 나의 프로필 이미지
int level : 나의 레벨
object extras : 나의 부가정보
}
int count : 접속한 채널에 현재 접속한 인원수
-
esc( minitalk)
미니톡 채팅위젯 내에서 사용자가 키보드의 ESC 키를 눌렀을 때 발생합니다.
최종수정일 :Minitalk minitalk : 이벤트가 발생한 미니톡 객체
-
init( minitalk)
미니톡 채팅위젯의 환경설정값을 모두 적용하였을 때 발생합니다.
최종수정일 :미니톡 채팅위젯의 환경설정값(CONFIGS)가 모두 적용되고 기본적인 DOM 이 랜더링되기전에 발생합니다.
각종 미니톡 채팅위젯의 환경설정값을 변경하고자 할때 이용하거나, 부가적인 설정을 할때 이용할 수 있습니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
-
initChannel( minitalk, channel)
채널의 설정값을 불러왔을 때 발생합니다.
최종수정일 :채널의 설정값을 불러온 뒤 미니톡 채팅위젯에 해당 설정값을 적용할 때 발생합니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
object channel {
string title : 채널명 (미니톡 예제체널)
string token : API 호출하기 위한 토큰정보
boolean use_boxes : 박스사용여부
boolean use_users : 접속자목록 사용여부
}
-
message( minitalk, message)
메시지를 수신하였을 때 발생합니다.
최종수정일 :메시지를 수신하였을 때 발생합니다.
자기 자신이 보낸 메시지에는 message 이벤트가 발생하지 않으므로, 자신이 보낸 메시지 객체는 afterSendMessage 이벤트를 통해 확인할 수 있습니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
object message {
string id : 메시지 고유ID
string type : 메시지 종류
string message : 메시지 내용
object data : 메시지에 포함된 추가 데이터
int time : 메시지 수신시각 (UNIXTIMESTAMP)
User user {
string uuid : 메시지 전송자 고유값
string nickname : 메시지 전송자 닉네임
string nickcon : 메시지 전송자 닉이미지
string photo : 메시지 전송자 프로필사진
int level : 메시지 전송자 레벨
object extras : 메시지 전송자 추가정보
},
object to {
string uuid : 메시지 수신자 고유값
string nickname : 메시지 수신자 닉네임
string nickcon : 메시지 수신자 닉이미지
string photo : 메시지 수신자 프로필사진
int level : 메시지 수신자 레벨
object extras : 메시지 수신자 추가정보
} : 전체 수신자인 경우 NULL
}
-
printMessage( minitalk, message, $content)
메시지가 출력된 이후에 발생한다.
최종수정일 :Minitalk minitalk : 이벤트가 발생한 미니톡 객체
object message {
string id : 메시지 고유ID
string type : 메시지 종류
string message : 메시지 내용
object data : 메시지에 포함된 추가 데이터
int time : 메시지 수신시각 (UNIXTIMESTAMP)
User user {
string uuid : 메시지 전송자 고유값
string nickname : 메시지 전송자 닉네임
string nickcon : 메시지 전송자 닉이미지
string photo : 메시지 전송자 프로필사진
int level : 메시지 전송자 레벨
object extras : 메시지 전송자 추가정보
},
object to {string uuid : 메시지 수신자 고유값
string nickname : 메시지 수신자 닉네임
string nickcon : 메시지 수신자 닉이미지
string photo : 메시지 수신자 프로필사진
int level : 메시지 수신자 레벨
object extras : 메시지 수신자 추가정보} : 전체 수신자인 경우 NULL
}
DOM $content : 메시지가 출력된 DOM jQuery 객체
message.type 이 message 이거나, file 인 경우 미니톡의 기본 메시지 타입으로 DOM $content 에 메시지 내용이 랜더링 되어 있으나, message.type 이 플러그인이나 기타 사용자가 정의한 경우 DOM $content 에 메시지내용이 랜더링 되어 있지 않으므로, 이 이벤트를 이용하여 해당 메시지 종류에 대응하는 HTML DOM 을 작성하여 주어야 메시지가 정상적으로 출력됩니다.
자세한 예제소스는 주사위 플러그인을 참고하시기 바랍니다.
-
ready( minitalk, $frame)
미니톡 채팅위젯의 HTML DOM 이 랜더링되었을때 발생합니다.
최종수정일 :미니톡 채팅위젯의 HTML DOM 이 랜더링되었을 때 발생하며, DOM 객체를 수정할 때 이용할 수 있습니다.
Minitalk minitalk : 이벤트가 발생한 미니톡 객체
DOM $frame : 미니톡을 감싸고 있는 frame 의 jQuery 객체 $("div[data-role=frame]")
-
sendMessage( minitalk, message)
유저가 메시지를 전송한 직후 발생합니다.
최종수정일 :Minitalk minitalk : 이벤트가 발생한 미니톡 객체
string message : 전송한 메시지
-
sendWhisper( minitalk, nickname, message)
유저가 귓속말을 전송한 직후 발생합니다.
최종수정일 :Minitalk minitalk : 이벤트가 발생한 미니톡 객체
string nickname : 귓속말 수신자 닉네임
string message : 전송한 메시지