Structures

The following structures are available globally.

  • 토큰 정보 요청 API 응답 클래스

    Seealso

    UserApi.accessTokenInfo()
    See more

    Declaration

    Swift

    public struct AccessTokenInfo : Codable
  • 사용자 정보 조회 API 응답으로 제공되는 사용자 정보 최상위 클래스입니다.

    Seealso

    UserApi.me(propertyKeys:secureResource:)
    See more

    Declaration

    Swift

    public struct User : Codable
  • 카카오계정에 등록된 사용자 개인정보를 제공합니다.

    내려오는 실제 정보는 https://accounts.kakao.com 으로 접속하여 해당 계정으로 로그인한 후 확인하실 수 있습니다.

    이 클래스에서 제공하는 카카오계정의 모든 개인정보는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다. 개인정보 필드의 값이 없으면 해당 필드와 매칭되는 {property}NeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다. {property}NeedsAgreement 값이 true인 경우 새로운 동의 요청이 가능한 상태이며 KOSession의 updateScopes 메소드를 이용하여 동의를 받을 수 있습니다. 동의를 받은 후 user/me를 다시 호출하면 해당 값이 반환될 것입니다. {property}NeedsAgreement 값이 false인 경우 사용자의 계정에 해당 정보가 없어서 값을 얻을 수 없음을 의미합니다.

    Important

    사용자관리 동의항목 설정에서 선택으로 설정된 정보의 동의 요청은 매우 주의해야 합니다. 동적 동의로 값을 필수로 획득하는 행위는 반드시 서비스 가입과 관계 없는 특정 시나리오에서 시도해야 합니다. 사용자가 동의하지 않아도 서비스 이용에 지장이 없어야 합니다. 카카오에서 제공하는 선택 동의 의도에 맞지 않는 구현은 이용제제 대상이 될 수 있습니다.
    See more

    Declaration

    Swift

    public struct Account : Codable
  • 카카오계정에 등록된 사용자의 프로필 정보를 제공합니다.

    Seealso

    Account.profile
    See more

    Declaration

    Swift

    public struct Profile : Codable
  • 사용자가 동의한 약관 조회 API 응답 클래스

    Seealso

    UserApi.serviceTerms()
    See more

    Declaration

    Swift

    public struct UserServiceTerms : Codable
  • 3rd party 서비스 약관 정보 클래스

    See more

    Declaration

    Swift

    public struct ServiceTerms : Codable
  • 앱에 가입한 사용자의 배송지 정보 API 응답 클래스

    Seealso

    UserApi.shippingAddresses(fromUpdatedAt:pageSize:)
    UserApi.shippingAddresses(addressId:)

    배송지의 정렬 순서는 기본배송지가 무조건 젤 먼저, 그후에는 배송지 수정된 시각을 기준으로 최신순으로 정렬되어 나가고, 페이지 사이즈를 주어서 여러 페이지를 나누어 조회하거나, 특정 배송지 아이디만을 지정하여 해당 배송지 정보만을 조회할 수 있습니다.

    See more

    Declaration

    Swift

    public struct UserShippingAddresses : Codable
  • 배송지 정보 클래스

    See more

    Declaration

    Swift

    public struct ShippingAddress : Codable