사용자 (user)
개요
user 네임스페이스는 사용자 고유 ID를 네이티브 레이어에서 관리하는 기능을 제공합니다.
- 사용자 ID를 네이티브 레이어에 저장
- 저장된 사용자 ID를 조회
- 저장된 사용자 ID를 삭제
정보
클라이언트의 사용자 ID를 설정하면 사용자 추적, 분석, 개인화 푸시 알림 등의 기능에서 일관된 사용자 식별이 가능합니다.
마케팅 푸시에 관련하여 사용자 ID 설정 여부에 따라 게스트(비로그인) 동의와 유저(로그인) 동의가 구분되어 관리됩니다.
자세한 내용은 마케팅 푸시 가이드를 참고하세요.
메서드 목록
| 메서드 | 설명 | 추가된 버전 |
|---|---|---|
setUserId(userId) | 네이티브 레이어에 사용자 ID를 설정합니다. | v1.10.0 |
getUserId() | 네이티브 레이어에 저장된 사용자 ID를 조회합니다. | v1.10.0 |
deleteUserId() | 네이티브 레이어에 저장된 사용자 ID를 삭제합니다. | v1.10.0 |
메서드 상세
setUserId(userId)
- since : v1.10.0
타입 정의
function setUserId(userId: string): void;
설명
네이티브 레이어에 사용자 ID를 설정합니다. 사용자가 로그인할 때 호출하여 사용자를 식별할 수 있도록 합니다.
마케팅 푸시 관련
setUserId() 호출 시 앱이 로그인 상태로 전환되며, 이후 Nachocode.push.setMarketingAllowed()를 호출하면 유저(로그인) 마케팅 동의가 저장됩니다.
자세한 내용은 마케팅 푸시 가이드를 참고하세요.
매개변수
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
userId | string | ✅ | 클라이언트 사용자 식별자 |
반환 값
해당 메서 드는 반환 값을 가지지 않습니다.
사용 예제
// 사용자 로그인 시 사용자 ID 설정
Nachocode.user.setUserId('user_12345');
// 로그인 핸들러에서 사용
function handleLogin(userId) {
// 로그인 성공 후 사용자 ID 설정
Nachocode.user.setUserId(userId);
console.log('사용 자 ID가 설정되었습니다:', userId);
}
푸시 토큰과 함께 사용
Nachocode.push.registerPushToken(userId)는 내부적으로 setUserId()를 호출하므로, 푸시 토큰 등록 시 별도로 호출할 필요가 없습니다.
getUserId()
- since : v1.10.0
타입 정의
function getUserId(): Promise<string | null>;
설명
네이티브 레이어에 저장된 사용자 ID를 비동기로 조회합니다.
저장된 사용자 ID가 없거나 조회할 수 없는 경우 null을 반환합니다.
반환값
| 타입 | 설명 |
|---|---|
Promise<string | null> | 저장된 사용자 ID, 없으면 null |
사용 예제
// 저장된 사용자 ID 조회
const userId = await Nachocode.user.getUserId();
if (userId) {
console.log('저장된 사용자 ID:', userId);
} else {
console.log('저장된 사용자 ID가 없습니다.');
}
deleteUserId()
- since : v1.10.0
타입 정의
function deleteUserId(): void;