개발 문서

플러그인 메서드

요약

Mindlogic Plugin은 프로그래밍 방식으로 상호작용할 수 있는 메서드 세트를 제공합니다. 이를 통해 플러그인의 상태를 제어하고, 메시지를 보내고, 세션을 초기화하고, 알림을 관리할 수 있습니다.

메서드 요약

아래 표는 사용 가능한 모든 메서드의 요약입니다. 각 메서드에 대한 자세한 설명은 아래에서 확인할 수 있습니다.

메서드	매개변수	반환값	설명
pushWelcomeMessage	message: `string`	`void`	환영 메시지 팝오버 표시
pushNotification	-	`void`	트리거 버튼에 알림 표시
pushChatUtm	keyword: `string`	`void`	AI 생성 환영 메시지 표시
deleteSession	-	`void`	사용자 세션 초기화
getSessionId	-	`string`	현재 세션 ID 가져오기
setSessionId	sessionId: `string`	`void`	세션 ID 설정
setLocale	locale: `string`	`void`	플러그인 언어 설정
open	-	`void`	플러그인 열기
hide	-	`void`	플러그인 닫기

사용자 인터페이스 제어 메서드

다음 메서드들은 플러그인의 사용자 인터페이스를 제어합니다.

pushWelcomeMessage

function

플러그인이 오픈되기 전 환영 메시지 팝오버를 표시합니다.


javascript
window.MLCPlugin.pushWelcomeMessage('안녕하세요! 오늘 어떻게 도와드릴까요?');

pushNotification

function

사용자에게 새로운 활동이나 업데이트가 있을 때 알림을 줄 수 있습니다.


javascript
window.MLCPlugin.pushNotification();

pushChatUtm

function

제공된 키워드를 기반으로 AI 생성 환영 메시지를 표시 할 수 있습니다.


javascript
window.MLCPlugin.pushChatUtm('AI 앱 구축하기');

메서드 콜 후 메시지가 보이기까지 시간이 몇 초 소요될 수 있습니다.

open

function

임의로 관리자가 지정한 버튼을 클릭한 경우에 플러그인을 열 수 있습니다.


javascript
window.MLCPlugin.open();

hide

function

임의로 관리자가 지정한 버튼을 클릭한 경우에 플러그인을 닫을 수 있습니다.


javascript
window.MLCPlugin.hide();

세션 관리 메서드

다음 메서드들은 플러그인의 세션을 관리합니다.

deleteSession

function

플러그인의 세션을 초기화하고 새로운 세션으로 다시 시작합니다.


javascript
window.MLCPlugin.deleteSession();

getSessionId

function

현재 사용자가 사용하는 세션 아이디를 가져올 수 있습니다.


javascript
const sessionId = window.MLCPlugin.getSessionId();
alert(sessionId);

setSessionId

function

사용자의 세션을 수동으로 설정하거나 직접 업데이트 할 수 있습니다.


javascript
window.MLCPlugin.setSessionId('<session_id>');

국제화 및 현지화 메서드

다음 메서드는 플러그인의 언어 및 지역 설정을 관리합니다.

setLocale

function

사용자에게 새로운 언어를 지정하면 대화가 자동으로 새로고침되고 선택한 언어로 환영 메시지가 표시됩니다.


javascript
window.MLCPlugin.setLocale('en'); // 플러그인을 영어로 전환

현재 언어는 한국어 (ko), 영어 (en), 일본어 (ja), 중국어 (zh), 스페인어 (es)를 지원합니다.

사용 예제

다음은 다양한 플러그인 메서드를 활용하는 예제입니다:


javascript
// 초기화
window.MLCPlugin.init('chat-window', {
  initialOpen: false,
  position: { right: 20, bottom: 20 },
});

// 플러그인 열기 및 환영 메시지 표시
document.getElementById('support-button').addEventListener('click', () => {
  window.MLCPlugin.open();
  window.MLCPlugin.pushWelcomeMessage('안녕하세요! 오늘 어떻게 도와드릴까요?');
});

// 언어 변경 버튼
document.getElementById('language-en').addEventListener('click', () => {
  window.MLCPlugin.setLocale('en');
});

// 세션 초기화 버튼
document.getElementById('reset-chat').addEventListener('click', () => {
  window.MLCPlugin.deleteSession();
  alert('대화가 초기화되었습니다.');
});

항상 플러그인이 완전히 초기화된 후에 메서드를 호출하세요. 이벤트 리스너나 프로미스를 사용하여 초기화가 완료될 때까지 기다리세요.

플러그인 메서드와 플러그인 옵션을 결합하여 고도로 맞춤화된 사용자 경험을 만들 수 있습니다. 예를 들어, initialOpen: true와 pushWelcomeMessage()를 함께 사용하여 사용자에게 자동으로 인사하세요.

마지막 수정 날짜: Apr 24, 2025

빠르게 시작하기

플러그인 옵션

Docs

플러그인 메서드

메서드 요약

사용자 인터페이스 제어 메서드

`pushWelcomeMessage`
function

`pushNotification`
function

`pushChatUtm`
function

`open`
function

`hide`
function

세션 관리 메서드

`deleteSession`
function

`getSessionId`
function

`setSessionId`
function

국제화 및 현지화 메서드

`setLocale`
function

사용 예제