website logo
⌘K
🚀시작하기
📈마케터용 가이드
🛠️개발자용 가이드
플레어레인 홈페이지
플레어레인 콘솔
플레어레인 콘솔(데모)
Docs powered by archbee 

Web Push SDK Reference

FlareLane

.initialize(options)

SDK를 초기화합니다.

Params

  • options: InitializeOptions
    • projectId
    • serviceWorkerPath
JS
|

.setLogLevel(logLevel)

SDK의 로그레벨을 설정합니다.

Params

  • logLevel: 'none' | 'error' | 'verbose'
    • none: 없음
    • error: 에러만 표시
    • verbose: 전부 표시 (default)
JS
|

.getIsSubscribed(callback)

현재 기기의 구독 여부를 확인합니다.

Params

  • callback: (Boolean) => {}
JS
|

.setIsSubscribed(isSubscribed, callback)

현재 기기의 구독 여부를 설정합니다. 서비스 내에서 직접 구독 여부를 관리하려는 경우 사용합니다.

true 지정 시 구독을 위한 권한 획득 과정이 한꺼번에 진행됩니다.

Params

  • isSubscribed: Boolean
  • callback: (Boolean) => {}
JS
|

.setUserId(userId)

현재 기기에 유저 ID를 설정합니다. 일반적으로, 로그인/로그아웃 시 유저 ID를 변경하도록 관리합니다.

Params

  • userId: string | null
JS
|

.setTags(tags)

현재 기기에 태그를 설정합니다. 전체 태그가 아닌 입력한 태그들 중에서 반영됩니다. 없으면 생성되고 이미 있으면 덮어씌워집니다. 태그 값으로 문자 및 숫자 타입만 입력 가능합니다.

Params

  • tags: Record<string, string | number>
JS
|

.getDeviceId(callback)

현재 기기의 플레어레인 기기 ID를 가져옵니다

Params

  • callback: (string | null) => {}
JS
|

.setConvertedHandler(callback)

알림 클릭 후 서비스 진입 시 실행할 콜백 핸들러를 등록합니다.

Params

  • callback: (Notification) => {}
JS
|

.setCurrentPath(path) for SPA

React 등 SPA 앱에서 위젯 노출 경로를 갱신하기 위해 URL Path를 전달합니다.

Params

  • path: string
JS
|
Did this page help you?
Yes
No
UP NEXT
App Push SDK Reference
Docs powered by archbee 
TABLE OF CONTENTS
FlareLane
.initialize(options)
.setLogLevel(logLevel)
.getIsSubscribed(callback)
.setIsSubscribed(isSubscribed, callback)
.setUserId(userId)
.setTags(tags)
.getDeviceId(callback)
.setConvertedHandler(callback)
.setCurrentPath(path) for SPA