User.getDeclaredAgeRange

함수형 API getDeclaredAgeRange로도 같은 기능을 쓸 수 있어요.

기능 설명

iOS에서 선언된 연령 범위를 조회해요.

iOS 전용 API예요. iOS 26 이상이고, 토스앱 iOS 5.266.0 이상에서만 사용할 수 있어요 — 안드로이드는 지원하지 않아요. 호출 전에 User.getDeclaredAgeRange.isSupported()로 지원 여부를 확인할 수 있어요.

타입

User.getDeclaredAgeRange(params: GetDeclaredAgeRangeParams): Promise<DeclaredAgeRange>;

Params

interface GetDeclaredAgeRangeParams {
  ageGates: number[];
}

Response

interface DeclaredAgeRange {
  status:
    | "SHARING"
    | "DECLINED_SHARING"
    | "UNSUPPORTED_OS"
    | "NOT_AVAILABLE"
    | "INVALID_REQUEST"
    | "FAILED";
  lowerBound?: number;
  upperBound?: number;
  ageRangeDeclaration?: string;
  activeParentalControls: string[];
  isEligibleForAgeFeatures?: boolean;
  errorCode?: string;
}

에러

에러 코드는 catch한 에러의 error.code 값이에요.

코드	설명
UNSUPPORTED_OS_VERSION	기기의 OS가 iOS 26 미만이거나 iOS가 아니면 호출 즉시 발생해요. User.getDeclaredAgeRange.isSupported()로 사전 확인하고, 발생 시 error.message(OS 업데이트 안내 문구)를 사용자에게 보여주세요.
UNSUPPORTED_APP_VERSION	실행 중인 토스앱 버전이 iOS 5.266.0 미만이면 호출 즉시 발생해요. User.getDeclaredAgeRange.isSupported()로 사전 확인하고, 발생 시 error.message(토스앱 업데이트 안내 문구)를 사용자에게 보여주세요.

예시 코드

import { User } from "@apps-in-toss/web-framework";

async function handleGetDeclaredAgeRange() {
  try {
    const result = await User.getDeclaredAgeRange({
      ageGates: [13, 18],
    });

    console.log("연령 범위 상태:", result.status);
    console.log("lowerBound:", result.lowerBound);
    console.log("upperBound:", result.upperBound);
  } catch (error) {
    console.error(error);
  }
}