개발 가이드

Web Push SDK Reference

.initialize
SDK를 초기화합니다. 
Params
options: InitializeOptions
projectId
serviceWorkerPath
JS
FlareLane.initialize({ projectId: "<PROJECT_ID>" });
FlareLane.initialize({ projectId: "<PROJECT_ID>" });
﻿
﻿
.setLogLevel
SDK의 로그레벨을 설정합니다.
Params
logLevel: 'none' | 'error' | 'verbose'
none: 없음
error: 에러만 표시
verbose: 전부 표시 (default)
JS
FlareLane.setLogLevel('verbose');
FlareLane.setLogLevel('verbose');
﻿
﻿
.trackEvent
이벤트를 트리거합니다.
Params
type: string
(optional) data: Record<string, string | number>
JS
FlareLane.trackEvent('test_event');
// OR
FlareLane.trackEvent('test_event', { "dataKey": "dataValue" });
FlareLane.trackEvent('test_event');
// OR
FlareLane.trackEvent('test_event', { "dataKey": "dataValue" });
﻿
﻿
﻿
.getIsSubscribed
현재 기기의 구독 여부를 확인합니다.
Params
callback: (Boolean) => {}
JS
FlareLane.getIsSubscribed((isSubscribed) => {
    // Do something...
    console.log(isSubscribed);
});
FlareLane.getIsSubscribed((isSubscribed) => {
    // Do something...
    console.log(isSubscribed);
});
﻿
﻿
.setIsSubscribed
현재 기기의 구독 여부를 설정합니다. 
서비스 내 설정UI 등을 통해 직접 구독 여부를 관리하려는 경우 사용합니다.
true 지정 시 구독을 위한 권한 획득 과정이 한꺼번에 진행됩니다.
Params
isSubscribed: Boolean
callback: (Boolean) => {}
JS
const callback = (isSubscribed) => {
    // Do something...
    console.log(isSubscribed);
};

// SUBSCRIBE
FlareLane.setIsSubscribed(true, callback);
// UNSUBSCRIBE
FlareLane.setIsSubscribed(false, callback);
const callback = (isSubscribed) => {
    // Do something...
    console.log(isSubscribed);
};

// SUBSCRIBE
FlareLane.setIsSubscribed(true, callback);
// UNSUBSCRIBE
FlareLane.setIsSubscribed(false, callback);
﻿
﻿
.setUserId
현재 기기에 유저 ID를 설정합니다. 일반적으로, 로그인/로그아웃 시 유저 ID를 변경하도록 관리합니다.
Params
userId: string | null
JS
// SET
FlareLane.setUserId("example@flarelane.com");
// REMOVE
FlareLane.setUserId(null);
// SET
FlareLane.setUserId("example@flarelane.com");
// REMOVE
FlareLane.setUserId(null);
﻿
﻿
.setTags
태그 값은 문자열(string) 혹은 숫자(number) 타입만 입력 가능합니다.
시간 표현은 second 가 아닌 millisecond 단위의 Unix Timestamp 값을 입력합니다. (ex. 1681721331085)
현재 기기에 태그를 설정합니다. 전체 태그가 아닌 입력한 태그들 중에서 반영됩니다. 없으면 생성되고 이미 있으면 덮어씌워집니다.
Params
tags: Record<string, string | number>
JS
// SET
FlareLane.setTags({ gender: "men", age: 24 });
// SET
FlareLane.setTags({ gender: "men", age: 24 });
﻿
﻿
.getDeviceId
현재 기기의 플레어레인 기기 ID를 가져옵니다
Params
callback: (string | null) => {}
JS
FlareLane.getDeviceId((deviceId) => {
    // Do something...
    console.log(deviceId);
 });
FlareLane.getDeviceId((deviceId) => {
    // Do something...
    console.log(deviceId);
 });
﻿
﻿
.setConvertedHandler
알림 클릭 후 서비스 진입 시 실행할 콜백 핸들러를 등록합니다.
Params
callback: (Notification) => {}
JS
FlareLane.setConvertedHandler((notification) => {
    // Do something...
    console.log(notification);
 });
FlareLane.setConvertedHandler((notification) => {
    // Do something...
    console.log(notification);
 });
﻿
﻿
﻿

REST API Reference

Mobile Push SDK Reference

Docs powered by Archbee

TABLE OF CONTENTS