action.command('password', password STRING)

  입장 비밀번호를 서버에 보냅니다. 입장 비밀번호가 적용되어 있는 채팅방에 접속시에만 쓰입니다.

해당 명령어는 before.join에서만 사용 가능합니다. 또한, 이벤트 결과에서 false를 return 해야지 정상 작동합니다.

U.chat('*').on('before.create', function(room, data){
  room.action.command('password', '1234');
  return false;
});

action.command('ban', target STRING, reason STRING)

  특정 유저를 차단합니다. target은 차단할 유저의 닉네임을, reason은 차단 사유를 의미합니다.

room.action.command('ban', '차단할_닉네임', '지속적 도배로 인한 차단');

action.command('whisper', target STRING, message STRING)

  특정 유저한테 귓말을 전송합니다. target은 귓말을 수신할 대상의 닉네임을, 메세지는 보낼 메세지를 의미합니다. 귓말 명령어는 별도의 글씨 스타일을 지원하지 않습니다.

room.action.command('whisper', '귓말을_받을_대상의_닉네임', '귓말 메세지');

action.command('upload', callback CALLBACK)

  이미지 업로드를 할 수 있게 팝업을 띄웁니다. 팝업 차단이 되어있을 경우 비정상적으로 작동될 수 있습니다.

callback에는 결과값에 대한 JSON이 인자로 넘어갑니다. 인자로 넘어가는 JSON은 다음과 같습니다:

{
status INTEGER: 0 or 1 // 0 이면 실패, 1이면 성공입니다.
, url STRING: ‘url’ // 업로드된 이미지의 주소입니다.
, msg STRING: ‘’ // 에러 메세지 입니다.
}

room.action.command('upload', function(result){
  if(status == 0) { alert('이미지 업로드에 실패하였습니다.\r\n참고 메세지: ' + result.msg); return; }

  alert('이미지가 정상적으로 업로드 되었습니다. 이미지는 ' + result.url + '에 저장되었습니다.');
}

action.command('mute', target STRING, period INTEGER(MINUTE), reason STRING)

  특정 유저를 벙어리 상태로 만듭니다. 부 관리자 권한 이상을 필요로 합니다. target은 벙어리로 만들 유저의 닉네임을, period는 벙어리를 유지할 기간(분 단위)을, reason은 벙어리를 적용하는 이유를 의미합니다.

room.action.command('mute', '벙어리_먹일_닉네임', 15, '도배가 심해서 15분간 벙어리');

action.command('unmute', target STRING)

  특정 유저의 벙어리 상태를 해제합니다. 부 관리자 권한 이상을 필요로 합니다. target은 벙어리 상태를 해제할 유저의 닉네임 입니다.

room.action.command('unmute', '벙어리_먹은_닉네임');

action.command('call', target STRING)

  특정 유저를 호출합니다. target은 호출할 대상의 닉네임 입니다.

room.action.command('call', '호출_대상_닉네임');

action.command('ip', target STRING)

  특정 유저의 IP를 확인합니다. target은 IP를 확인할 대상의 닉네임 입니다.

room.action.command('ip', 'IP를_확인할_대상');

action.command('ignore', target STRING)

  특정 유저의 채팅을 모두 무시합니다. 자신의 채팅창에서만 특정 접속자의 채팅을 숨기는 명령어로, 관리자 권한은 필요 없습니다. target은 무시할 대상의 닉네임 입니다.

room.action.command('ignore', '무시할_대상');

action.command('un_ignore', target STRING)

  특정 유저에게 적용했던 무시하기를 해제합니다. 해제 이후의 채팅부터 정상 표시 되며, 해제 이전에 대상이 입력한 채팅 내용은 다시 보여주거나 하지는 않습니다. target은 무시하기를 해제할 대상의 닉네임 입니다.

room.action.command('un_ignore', '무시했던_대상');

action.command('popup')

  현재 채팅방을 새창으로 띄웁니다.

action.command('invite', target STRING)

  개인 채팅방을 만들어 둔 상태에서만 작동되는 명령어로, 특정 유저를 자신의 개인 채팅방에 초대할 수 있습니다. target은 초대할 대상의 닉네임 입니다.

room.action.command('invite', '개인채팅방에_초대할_대상');

action.command('individual', target STRING)

  내 개인 채팅방에 상대방을 초대 합니다. 필요하다고 판단되면 (개인 채팅방이 없는경우) 개인 채팅방을 팝업으로 띄웁니다.

room.action.command('individual', '개인채팅방에_초대할_대상');

action.command('noticeList')

  입장 공지사항을 가져옵니다. 유챗의 기본 스킨에서 접속시 1회 자동으로 호출합니다. 아래 코드는 5분에 한번씩 공지사항을 출력하는 예제입니다.

setInterval(
  function(){ room.action.command('noticeList'); },
  5 * 60 * 1000
);

action.command('io', TRUE / FALSE)

  입·퇴장 정보를 수신할지 여부입니다. FALSE로 설정될 경우 접속자 목록을 갱신하지 않고 접속자 수만 서버에서 불러옵니다. (before.user.count, after.user.count 이벤트 실행됨). TRUE로 설정될 경우 접속자 목록을 실시간 갱신하며, 실시간 접속자 수를 서버에서 불러오지는 않습니다. (before.user.count, after.user.count 이벤트가 실행되지 않습니다.)

  before.user.count, after.user.count는 입퇴장 목록을 갱신하지 않는 대신에 발생하는 이벤트 입니다. 그 결과, 전체 입퇴장 목록을 갱신하는 대신, 실시간 접속자 수만 갱신합니다.

room.action.command('io', TRUE);

action.command('chatList', count INTEGER)

  최근 채팅 리스트를 불러옵니다. count는 최근 채팅의 갯수이며, 서버내 갯수 제한이 있을수 있습니다. 이 경우, 아무리 큰 수를 count에 할당해도 제한된 갯수만 서버에서 반환됩니다.

var numLoadMessage = 25; //25개의 최근 메세지를 서버에서 받아옴

room.action.command('chatList', numLoadMessage);

action.command('changeInfo', json JSON)

  자신의 정보를 바꿀수 있습니다. 일부 채팅방에서는 (특히 회원 연동이 작동되는 경우) 사용 불가할 수 있습니다.

  인자로 넘어가는 JSON은 다음과 같은 구조를 가집니다:

{
  '키_값': '바꿀 값'
}

room.action.command('changeInfo', { 'nick': '새로_바꿀_닉네임' });

action.command('notice', html STRING)

  관리자가 공지사항을 전송할 때 사용됩니다. 해당 명령어를 사용하면 채팅방 내의 모든 접속자에게 메세지를 출력시킵니다. html은 출력할 내용으로, 단순 텍스트 및 HTML 둘 다를 지원합니다.

if(HTML로_보내고_싶으면)
  room.action.commmand('notice', '<p>test</p><img src="1234">');
else
  room.action.command('notice', '테스트 메세지 입니다.');

action.command('clearLog')

  대화 로그를 지웁니다. 관리자 권한을 가지고 있으면 전체 유저의 화면을 지웁니다. 관리자 권한이 없다면 자신의 화면만 지웁니다.

action.command('op', target STRING)

  관리자(금색 왕관)가 특정 유저에게 부관리자 권한(은색 왕관)을 줄 수 있습니다. target은 대상의 닉네임을 의미합니다.

room.action.command('op', '은색_왕관을_받을_유저_닉네임');

action.command('deop', target STRING)

  관리자(금색 왕관)가 특정유저의 부관리자 권한을 뺏을수 있습니다. target은 부관리자중 권한을 회수할 대상의 닉네임 입니다.

room.action.command('op', '은색_왕관을_뺏을_유저_닉네임');

action.command('login', password STRING)

  채팅방에 로그인 합니다. 로그인 가능한 채팅방에서만 사용 가능한 명령어로서, 로그인에 성공할 경우 관리자 권한을 받을 수 있습니다. password는 채팅방의 비밀번호 입니다.

room.action.command('login', '비밀번호1234');

action.command('adminPage')

  관리 페이지를 띄웁니다. 관리자인 경우에만 사용 가능하며, 팝업 차단 시스템이 있으면 비정상적으로 작동할 수 있습니다,

room.action.command('adminPage');

id

TEXT

  플러그인의 이름(ID)입니다. 해당값은 수정하시면 안됩니다.

var plugin = room.plugin.add('testPlugin');
alert('플러그인이 등록되었습니다. 플러그인 ID: ' + plugin.id);

receiver

ARRAY

  플러그인 전용 통신채널에서 메세지가 왔을때 일을 처리할 콜백들의 목록입니다. 직접 항목을 삭제·추가·수정을 하실 수 있으며, 이를 통해 메세지 송수신 콜백을 관리하실 수 있습니다.

parser

ARRAY

  채팅방에서 플러그인 명령이 들어왔을때 실행될 콜백들의 목록입니다. 플러그인 명령은 채팅방에서 ![플러그인 ID] 인수1 인수2 ··· 와 같은 구조로 메세지가 입력되면 발생합니다. !플러그인ID 는 고정값이며, 해당 문자열로 시작되는 메세지가 입력되면 parser 목록에 있는 모든 콜백들이 순차적으로 실행됩니다.  직접 항목을 삭제·추가·수정을 하실 수 있으며, 이를 통해 파서 콜백을 관리하실 수 있습니다.

send

FUNCTION( ARRAY )

  플러그인 전용 통신채널에 메세지를 보냅니다. 보낸 메세지는 채팅방 내의 각 접속자들이 수신하게 되며, receiver가 이를 처리하게 됩니다.

  함수의 인수로 배열만을 사용하실 수 있습니다.

var plugin = room.plugin.add('testPlugin');
plugin.send(['배열도', '보낼 수', '있습니다.']);

onReceived

FUNCTION( CALLBACK )

  수신된 데이터를 처리할 콜백을 등록합니다. 콜백의 인자는 배열 하나가 사용됩니다.

var plugin = room.plugin.add('testPlugin');
plugin.onReceived(function(data){

});

onReceived의 함수에 사용된 data인자는 JSON으로서, 구조는 http://uchat.io/doc/2.2/이벤트#before-plugin를 참고하시길 바랍니다.

addParser

  플러그인 명령어를 처리할 콜백을 등록합니다. 콜백의 인자는 배열 하나가 사용됩니다.

  채팅방에서 !플러그인ID 인자1 인자2 인자3 인자4 ··· 와 같은 구조로 이루어진 메세지가 입력되면 등록된 파서가 실행됩니다. 각 인자들은 콜백에 배열로 담겨 전달됩니다.

var plugin = room.plugin.add('testPlugin');
plugin.addParser(function(data){
  //!testPlugin 테스트값 1234
  //data => ['테스트값', '1234']
});

sendTo

  특정 대상에게 데이터를 보냅니다. 이 함수로 특정 대상에게만 데이터를 보내면 데이터의 타입에 room.plugin.ONLY_ME가 설정됩니다.

destory

  이 플러그인을 삭제합니다. listener와 parser 모두 무력화됩니다. listener와 parser를 이용하기 위해서는 다시 플러그인을 초기화(등록)해 주셔야 합니다.

U.chat('*').on('after.create', function(room, data){
    //window에 전역변수로 등록
    testPlugin = room.plugin.add('testPlugin');

    testPlugin.addParser(function(data){
        //!testPlugin 만 입력된 경우
        if(data.length == 0){
            room.print('사용법: !testPlugin 전송 [숫자]');
            return;
        }
        if(data[0] == '전송'){
             testPlugin.send(data[1]);
         }else if(data[0] == '상태'){
             alert('등록된 파서 갯수:' + testPlugin.parser.length + '\r\n등록된 리시버' + testPlugin.receiver.length);
         }
     });
     testPlugin.onReceived(function(data){
         //data는 array 입니다.
         room.print('메세지가 수신되었습니다.\r\n메세지 수:' + data.length + '\r\n첫번째 메세지:' + data[0]);
     });
});