Minitalk

정의 파일 /scripts/minitalk.js

Minitalk 자바스크립트 클래스의 경우, 미니톡 채팅위젯을 홈페이지상에 출력하기 위해 사용하는 API 클래스입니다.

CONFIGS 의 설정값들을 이용하여 미니톡 채팅위젯을 웹사이트내에 원하는 곳에 삽입하여 사용이 가능합니다.

회원연동 등을 하기 위해서는 별도의 서버사이드언어(PHP, ASP, JSP 등)을 이용하여 유저코드(usercode)를 생성하여 사용하셔야 하며, 해당 코드를 생성하는 방법은 CONFIGS 의 usercode 부분을 참고하시면 설명되어 있습니다.

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

설정 (Configs)

이름	설명
channel	미니톡 채팅위젯에서 접속할 채널명을 설정합니다.
height	미니톡의 세로크기를 정의합니다.
id	현재의 미니톡 객체를 가르키는 고유한 값을 설정합니다.
info	접속자의 부가정보를 정의합니다.
language	미니톡 채팅위젯의 언어를 정의합니다.
logLimit	서버접속시 가져올 이전대화기록의 갯수를 설정한다.
nickcon	접속자 닉이미지를 설정한다.
nickname	접속자 닉네임을 설정한다.
opperCode	접속자의 권한코드를 생성하여 해당 권한으로 채팅방에 참여할 수 있도록 설정한다.
skin	미니톡 채팅위젯의 스킨명을 설정합니다.
splitString	대화내용에서 닉네임과 대화내용을 구분할 문자를 설정한다.
statusIconPath	사용자정의 상태아이콘 경로를 지정합니다.
toolType	툴바버튼의 형식을 지정한다.
type	미니톡 채팅위젯의 가로/세로모드를 설정한다.
userListHeight	유저목록의 세로높이를 설정한다. (세로모드에서만 적용됨)
userListWidth	유저목록의 가로너비를 설정한다. (가로모드에서만 적용됨)
viewAlert	유저의 접속/접속종료 안내메시지를 보일지 설정합니다.
viewAlertLimit	유저의 접속/접속종료 안내메시지를 보일 최소권한을 설정합니다.
viewStatusIcon	유저목록에서 유저의 상태아이콘을 보일지 여부를 설정한다.
viewUser	유저목록을 기본적으로 보일지 숨길지 여부를 설정합니다.
viewUserLimit	유저목록에 보일 최소 유저권한을 설정합니다.
width	미니톡의 가로크기를 정의합니다.

channel

설정 필수 잠김 v6.0.0부터

channel: string

미니톡 채팅위젯에서 접속할 채널명을 설정합니다.

타입 string

미니톡 채팅위젯에서 접속하게 될 채널명을 입력합니다.

해당 채널명은 미니톡 클라이언트 관리자 채널관리에서 생성한 채널명을 의미합니다.

예제

CodePen에서 열기

최종수정일 : 2020.12.22

height

설정 잠김 v6.0.0부터

height: int | string

미니톡의 세로크기를 정의합니다.

타입 int | string · 기본값 500

미니톡의 세로크기를 픽셀(px)또는 퍼센트(%) 단위로 설정합니다.

픽셀(px) 단위로 정의할 경우 int 형식으로 설정하셔야 하며, 퍼센트(%) 단위일 경우 string 형식으로 설정하셔야 합니다.

퍼센트(%) 단위의 경우 미니톡 채팅위젯이 들어가는 상위 DOM 객체의 세로크기에 영향을 받습니다.

예제

CodePen에서 열기

최종수정일 : 2020.12.22

id

설정 필수 잠김 v6.0.0부터

id: string

현재의 미니톡 객체를 가르키는 고유한 값을 설정합니다.

타입 string

미니톡 위젯의 고유값을 지정합니다.

이 값은 미니톡 위젯의 설정을 사용자의 브라우저에 저장하기 위한 용도로 사용되거나, MinitalkComponent 에서 현재의 미니톡 위젯을 호출하기 위해 사용될 수 있습니다.

이 값은 HTML 의 id 와 동일한 역할을 하며, 하나의 웹페이지내에서 모든 HTML 요소에 사용된 id 값과 중복되지 않는 유일한 값이어야 합니다.

예제

CodePen에서 열기

최종수정일 : 2020.12.22

info

설정 사용중단 v6.4.0까지

info: object

접속자의 부가정보를 정의합니다.

타입 object

접속자의 부가적인정보 (회원시스템의 회원아이디, 회원의 홈페이지주소 등)를 정의하여, 유저메뉴나 툴버튼 또는 각종 이벤트리스너에서 접속자의 부가정보를 이용할 수 있습니다.

접속자정보를 활용하는 방법은 tools 나 menus 설정값을 참고하시거나, Minitalk.ui.addTool() 또는 이벤트리스너 등을 참고하시기 바랍니다.

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

usercode API 문서를 참고하여 주시기 바랍니다.

최종수정일 : 2021.02.02

language

설정 안정 v6.0.0부터

language: string

미니톡 채팅위젯의 언어를 정의합니다.

타입 string

미니톡 채팅위젯에 표시되는 언어를 설정합니다.

언어는 한국어(ko) 와 같이 ISO-639 에 정의된 2글자 영문명을 사용하여야 하며, 해당 언어코드에 따른 언어팩이 미니톡 클라이언트 설치폴더의 languages 폴더에 ko.json 과 같이 존재해야합니다.

미니톡 v6.4.0 부터는 사용자 브라우저의 언어설정에 따라 자동으로 지정됩니다.

최종수정일 : 2021.02.02

logLimit

설정 사용중단 v6.4.0까지

logLimit: int

서버접속시 가져올 이전대화기록의 갯수를 설정한다.

타입 int · 기본값 15

미니톡에 최초접속시 접속이전에 이루어진 이전대화기록을 가져올 갯수를 설정합니다.

0 으로 설정할 경우 이전대화기록을 불러오지 않으며, 최대 30개 까지 설정할 수 있습니다.

이전대화기록은 서버의 상태에 따라 설정된 갯수보다 적게 불러올 수 있습니다.

이 설정값은 v6.4.0 버전부터 logCount 로 변경되었습니다.

최종수정일 : 2021.02.02

nickcon

설정 사용중단 v6.4.0까지

nickcon: string

접속자 닉이미지를 설정한다.

타입 string

PHP, ASP, JSP 등 미니톡 채팅위젯을 사용하는 홈페이지 회원시스템을 이용하여 회원시스템의 닉네임과 연동하여 사용할 수 있습니다.

닉이미지의 전체 이미지경로 (https://www.yourdomain.com/image.jpg) 를 적어주셔야 하며, 여러개의 닉이미지를 사용할 경우 콤마(,) 로 구분하여 사용할 수 있습니다.

닉이미지에 {nickname} 을 입력시 설정된 회원닉네임의 텍스트가 함께 나타나도록 설정할 수 있습니다.

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

usercode API 문서를 참고하여 주시기 바랍니다.

최종수정일 : 2021.02.02

nickname

설정 사용중단 v6.4.0까지

nickname: string

접속자 닉네임을 설정한다.

타입 string

PHP, ASP, JSP 등 미니톡 채팅위젯을 사용하는 홈페이지 회원시스템을 이용하여 회원시스템의 닉네임과 연동하여 사용할 수 있습니다.

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

usercode API 문서를 참고하여 주시기 바랍니다.

최종수정일 : 2021.02.02

opperCode

설정 사용중단 v6.4.0까지

opperCode: string

접속자의 권한코드를 생성하여 해당 권한으로 채팅방에 참여할 수 있도록 설정한다.

타입 string

미니톡 채팅위젯에서 회원정보를 연동하여, 유저의 권한을 설정합니다.

유저권한은 ADMIN, MEMBER, NICKGUEST, GUEST 로 정의됩니다.

해당 유저코드는 보안을 위하여 서버사이드언어(PHP, ASP, PHP 등)을 이용하여 생성한 뒤 정의해주셔야 합니다.

유저코드를 생성하기 위한 암호화 방식은 PHP Minitalk 클래스 (/classes/Minitalk.class.php)의 getOpperCode() 함수를 확인하여 생성하실 수 있습니다.

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

usercode API 문서를 참고하여 주시기 바랍니다.

자세한 사용은 사용자매뉴얼 > 미니톡 채팅위젯 회원 연동하기 문서를 참고하여 주시기 바랍니다.

최종수정일 : 2021.02.02

skin

설정 필수 안정 v6.0.0부터

skin: string

미니톡 채팅위젯의 스킨명을 설정합니다.

타입 string

스킨명은 미니톡 스킨폴더(/skin) 아래의 스킨 폴더명(예 : default)을 입력하면 됩니다.

해당 변수는 미니톡 v6.4.0 버전부터 templet 변수로 변경되었습니다.

최종수정일 : 2021.04.05

splitString

설정 사용중단 v6.4.0까지

splitString: string

대화내용에서 닉네임과 대화내용을 구분할 문자를 설정한다.

타입 string

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

최종수정일 : 2021.02.02

statusIconPath

설정 사용중단 v6.4.0까지

statusIconPath: string

사용자정의 상태아이콘 경로를 지정합니다.

타입 string

미니톡에서 기본적으로 사용하는 상태아이콘(미니톡클라이언트폴더/images/status) 외에 사용자가 지정한 상태아이콘을 사용하고자 할 경우 해당 아이콘이 존재하는 경로를 설정합니다.

해당경로에는 디바이스별(PC, iOS, Android) 모든 상태값(online, offline, away, otherwork, working, pray)에 대한 아이콘이 존재하여야 합니다.

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

최종수정일 : 2021.02.02

toolType

설정 안정 v6.0.0부터

toolType: string

툴바버튼의 형식을 지정한다.

타입 string · 기본값 icon

값	설명
icon	툴바아이콘만 표시한다.
text	툴바명칭만 표시한다.
icontext	툴바아이콘 및 명칭만 표시한다.

일부 미니톡 채팅위젯 템플릿에 따라 설정값이 적용되지 않을 수 있습니다.

예제

CodePen에서 열기

최종수정일 : 2020.12.22

type

설정 안정 v6.0.0부터

type: string

미니톡 채팅위젯의 가로/세로모드를 설정한다.

타입 string · 기본값 auto

값	설명
horizontal	가로모드 (접속자목록이 우측에 표시됩니다.)
vertical	세로모드 (접속자목록이 상단에 표시됩니다.)
auto	자동 (가로너비에 따라 자동으로 적절한 상태로 표시됩니다.)

예제

CodePen에서 열기

최종수정일 : 2020.12.22

userListHeight

설정 사용중단 v6.4.0까지

userListHeight: int

유저목록의 세로높이를 설정한다. (세로모드에서만 적용됨)

타입 int · 기본값 100

미니톡 채팅위젯의 type이 vertical로 지정되었을 때나, auto 로 설정되어 있고, 세로형태로 나타나고 있을 때 유저목록의 세로높이를 설정합니다.

이 값은 % 단위로 설정되지 않으므로 반드시 픽셀단위의 int 형식으로 설정하여야 합니다.

v6.4.0 버전부터 채팅위젯 템플릿에 따라 정의되도록 수정되었습니다.

최종수정일 : 2020.12.24

userListWidth

설정 사용중단 v6.4.0까지

userListWidth: int

유저목록의 가로너비를 설정한다. (가로모드에서만 적용됨)

타입 int · 기본값 160

미니톡 채팅위젯의 type이 horizontal로 지정되었을 때나, auto 로 설정되어 있고, 가로형태로 나타나고 있을 때 유저목록의 가로너비를 설정합니다.

이 값은 % 단위로 설정되지 않으므로 반드시 픽셀단위의 int 형식으로 설정하여야 합니다.

v6.4.0 버전부터 채팅위젯 템플릿에 따라 정의되도록 수정되었습니다.

최종수정일 : 2020.12.24

viewAlert

설정 사용중단 v6.4.0까지

viewAlert: boolean

유저의 접속/접속종료 안내메시지를 보일지 설정합니다.

타입 boolean · 기본값 true

유저가 접속하거나 접속을 끊을 때 안내메시지를 보일지 설정합니다.

이 설정값을 false 로 설정할 경우 모든 유저의 접속/접속종료 안내메시지가 보이지 않습니다.

만약, 일부유저의 접속/접속종료 안내메시지는 보이도록 설정하고 싶은 경우 이 설정값을 true 로 설정하고 viewAlertLimit 설정값을 참고하여 설정할 수 있습니다.

이 설정값은 v6.4.0 버전부터 viewUserNotification 으로 변경되었습니다.

예제

CodePen에서 열기

최종수정일 : 2020.12.22

viewAlertLimit

설정 사용중단 v6.4.0까지

viewAlertLimit: string

유저의 접속/접속종료 안내메시지를 보일 최소권한을 설정합니다.

타입 string · 기본값 ALL

유저가 접속하거나 접속을 끊을 때 안내메시지를 보일 최소 유저권한을 설정합니다.

유저권한설정은 opperCode 설정을 참고하여 주시기 바랍니다.

값	설명
ADMIN	관리자만 접속/접속종료 안내메시지를 보이도록 설정합니다.
MEMBER	회원권한이상의 유저만 접속/접속종료 안내메시지를 보이도록 설정합니다.
NICKGUEST	닉네임을 변경한적이 있는 손님권한 이상만 접속/접속종료 안내메시지를 보이도록 설정합니다.
ALL	모든 유저의 접속/접속종료 안내메시지를 보이도록 설정합니다.

이 설정값은 v6.4.0 버전부터 viewUserNotificationLimit 으로 변경되었습니다.

예제

CodePen에서 열기

최종수정일 : 2020.12.22

viewStatusIcon

설정 사용중단 v6.4.0까지

viewStatusIcon: boolean

유저목록에서 유저의 상태아이콘을 보일지 여부를 설정한다.

타입 boolean · 기본값 true

유저목록에서 유저의 상태아이콘(온라인, 자리비움, 다른용무중 등)을 보일지 여부를 설정한다.

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

최종수정일 : 2021.02.02

viewUser

설정 사용중단 v6.4.0까지

viewUser: boolean

유저목록을 기본적으로 보일지 숨길지 여부를 설정합니다.

타입 boolean · 기본값 true

미니톡 채팅서버에 접속시 유저목록을 보일지 숨길지 여부를 설정합니다.

기본적으로 유저목록이 보이게 설정되어 있으나, 유저수가 200명 이상인 경우 부하를 줄이기 위해 자동으로 유저목록을 숨깁니다.

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

해당 설정은 미니톡 클라이언트 관리자의 채널설정을 통해 지정할 수 있습니다.

최종수정일 : 2021.02.02

viewUserLimit

설정 사용중단 v6.4.0까지

viewUserLimit: string

유저목록에 보일 최소 유저권한을 설정합니다.

타입 string · 기본값 ALL

유저목록에 보일 접속자의 최소 유저권한을 설정합니다.

유저권한설정은 opperCode 설정을 참고하여 주시기 바랍니다.

값	설명
ADMIN	유저목록에 관리자만 보이도록 설정합니다.
MEMBER	유저목록에 회원권한이상만 보이도록 설정합니다.
NICKGUEST	유저목록에 닉네임을 변경한적이 있는 손님권한 이상만 보이도록 설정합니다.
ALL	유저목록에 모든 유저를 보이도록 설정합니다.

해당 설정변수는 미니톡 v6.4.0 버전부터 지원이 중단되었습니다.

해당 설정은 미니톡 클라이언트 관리자의 채널설정을 통해 지정할 수 있습니다.

최종수정일 : 2021.02.02

width

설정 잠김 v6.0.0부터

width: int | string

미니톡의 가로크기를 정의합니다.

타입 int | string · 기본값 180

미니톡의 가로크기를 픽셀(px)또는 퍼센트(%) 단위로 설정합니다.

픽셀(px) 단위로 정의할 경우 int 형식으로 설정하셔야 하며, 퍼센트(%) 단위일 경우 string 형식으로 설정하셔야 합니다.

퍼센트(%) 단위의 경우 미니톡 채팅위젯이 들어가는 상위 DOM 객체의 가로크기에 영향을 받습니다.

예제

CodePen에서 열기

최종수정일 : 2020.12.22

이벤트 (Events)

이름	설명
message	메시지를 수신하였을 때 발생합니다.
sendMessage	유저가 메시지를 전송한 직후 발생합니다.
sendWhisper	유저가 귓속말을 전송한 직후 발생합니다.

message

이벤트 안정 v6.0.0부터

message(minitalk: Minitalk, message: object)

메시지를 수신하였을 때 발생합니다.

매개변수

이름	타입	설명
minitalk	Minitalk	이벤트가 발생한 미니톡 객체
message	object	아래 구조 참고

message 구조

필드	타입	설명
id	string	메시지 고유ID
type	string	메시지 종류
message	string	메시지 내용
data	object	메시지에 포함된 추가 데이터
time	int	메시지 수신시각 (UNIXTIMESTAMP)
user	User
user.uuid	string	메시지 전송자 고유값
user.nickname	string	메시지 전송자 닉네임
user.nickcon	string	메시지 전송자 닉이미지
user.photo	string	메시지 전송자 프로필사진
user.level	int	메시지 전송자 레벨
user.extras	object	메시지 전송자 추가정보
to	object	전체 수신자인 경우 NULL
to.uuid	string	메시지 수신자 고유값
to.nickname	string	메시지 수신자 닉네임
to.nickcon	string	메시지 수신자 닉이미지
to.photo	string	메시지 수신자 프로필사진
to.level	int	메시지 수신자 레벨
to.extras	object	메시지 수신자 추가정보

자기 자신이 보낸 메시지에는 message 이벤트가 발생하지 않으므로, 자신이 보낸 메시지 객체는 afterSendMessage 이벤트를 통해 확인할 수 있습니다.

예제

CodePen에서 열기

최종수정일 : 2021.04.16

sendMessage

이벤트 안정 v6.0.0부터

sendMessage(minitalk: Minitalk, message: string)

유저가 메시지를 전송한 직후 발생합니다.

매개변수

이름	타입	설명
minitalk	Minitalk	이벤트가 발생한 미니톡 객체
message	string	전송한 메시지

예제

CodePen에서 열기

최종수정일 : 2021.04.16

sendWhisper

이벤트 안정 v6.0.0부터

sendWhisper(minitalk: Minitalk, nickname: string, message: string)

유저가 귓속말을 전송한 직후 발생합니다.

매개변수

이름	타입	설명
minitalk	Minitalk	이벤트가 발생한 미니톡 객체
nickname	string	귓속말 수신자 닉네임
message	string	전송한 메시지

예제

CodePen에서 열기

최종수정일 : 2021.04.16