Minitalk.user

정의 파일 /scripts/widget.user.js

미니톡 채팅위젯 접속자(user) 관련 변수 및 함수가 정의되어 있습니다.

표시	의미
사용중단	이 기능은 문제의 소지가 있어 제거되었거나 제거될 예정입니다.
불안정	아직 안정적이라고 고려될만큼 충분한 테스트를 거치지 않았습니다.(합당하다면 하위호환성이 보장됩니다.)
안정	API가 충분히 검증되었지만, 기반이 되는 코드의 정리 때문에 마이너한 변경이 있을 수 있습니다.(하위호환성이 보장됩니다.)
잠김	심각한 버그가 발견되지 않는 한 이 코드는 절대 변경되지 않습니다.

메서드 (Methods)

이름	설명
appendMenu()	미니톡 채팅위젯의 접속자 메뉴를 추가합니다.
call()	특정유저를 호출합니다.
getCount()	현재 접속자수를 가져온다.
getUser()	유저정보를 서버로부터 가져옵니다.

appendMenu()

메서드 안정 v6.4.0부터

Minitalk.user.appendMenu(menu: string | object): void

미니톡 채팅위젯의 접속자 메뉴를 추가합니다.

매개변수

이름	타입	설명
menu	string | object	추가할 메뉴를 아래를 참고하여 정의합니다.

반환값 void

미니톡 채팅위젯 스크립트를 정의할 때가 아닌 플러그인이나, 이벤트 리스너 등에서 미니톡 채팅위젯에서 접속자 닉네임을 클릭했을 때 나타날 유저별 메뉴를 추가하는데 사용할 수 있습니다.

position 에는 메뉴를 추가할 위치를 숫자 또는 메뉴명으로 입력하면 해당 메뉴 뒤에 추가되며, position 값이 비어있는 경우, 메뉴 제일 마지막에 해당메뉴가 추가됩니다.

미리 정의된 문자열

값	설명
-	메뉴 구분선
configs	환경설정
create	개인박스생성 (자기 자신에게만 보임)
whisper	귓속말보내기 메뉴 (자기 자신을 제외한 경우에만 보임)
call	호출하기 메뉴 (자기 자신을 제외한 경우에만 보임)
invite	개인박스 초대하기 메뉴 (자기 자신에게만 보임)
showip	해당유저의 IP보기 (관리자인 경우에만 보임)
banip	해당유저의 IP차단 (관리자인 경우에만 보임)
op	관리자권한 부여 (관리자인 경우에만 보임)
deop	관리자권한 해제 (관리자인 경우에만 보임)

사용자정의 툴버튼 추가

필드	타입	설명
name	string	고유값으로 영문 및 숫자로만 이루어져야합니다.
icon	string	메뉴 아이콘 이미지 경로
iconClass	string	메뉴 아이콘 스타일시트 (아이콘폰트 등의 스타일을 지정할 수 있습니다.)
visible	function(minitalk, me)	해당메뉴 보임여부 (minitalk : 미니톡객체, user : 클릭한 유저정보, me : 나의정보)
handler	function(minitalk, user, e)	해당메뉴 클릭시 실행될 함수 (minitalk : 미니톡객체, user : 클릭한 유저정보, e : 클릭이벤트)

예제

CodePen에서 열기

최종수정일 : 2021.04.05

call()

메서드 안정 v6.4.0부터

Minitalk.user.call(nickname: string, callback: function): void

특정유저를 호출합니다.

매개변수

이름	타입	설명
nickname	string	호출할 유저의 닉네임
callback	function	호출하기 후 실행할 함수

반환값 void

유저메뉴에서 호출하기 메뉴를 클릭했을 때와 동일한 기능을 제공합니다.

호출하기 권한이 없거나, beforeCall 이벤트로 호출이 차단되었을 경우에는 동작하지 않습니다.

// 플러그인이나, 미니톡 이벤트리스너 내에서 사용되는 경우
Minitalk.user.call("손님",function(result) {
  if (result.success == true) {
    alert(nickname + "님을 호출하였습니다.");
  }
});


// 미니톡 외부에서 사용할 경우, 미니톡 채팅위젯의 id 값이 example 인 경우
MinitalkComponent.get("example").user.call("손님",function(result) {
  if (result.success == true) {
    alert(nickname + "님을 호출하였습니다.");
  }
});

최종수정일 : 2021.04.05

getCount()

메서드 안정 v6.4.0부터

Minitalk.user.getCount(): int

현재 접속자수를 가져온다.

반환값 int

현재 채널에 접속한 유저수를 가져온다.

예제

CodePen에서 열기

최종수정일 : 2021.04.15

getUser()

메서드 안정 v6.4.0부터

Minitalk.user.getUser(nickname: string, callback: function): void

유저정보를 서버로부터 가져옵니다.

매개변수

이름	타입	설명
nickname	string	정보를 가져올 유저닉네임
callback	function	정보를 가져온 뒤 실행할 함수

반환값 void

// 플러그인이나, 미니톡 이벤트리스너 내에서 사용되는 경우
Minitalk.user.getUser("손님",function(result) {
  if (result.success == true) {
    alert(result.user.nickname + "님의 정보를 가져왔습니다.");
  }
});


// 미니톡 외부에서 사용할 경우, 미니톡 채팅위젯의 id 값이 example 인 경우
MinitalkComponent.get("example").user.call("손님",function(result) {
  if (result.success == true) {
     alert(result.user.nickname + "님의 정보를 가져왔습니다.");
  }
});

최종수정일 : 2021.04.05