KOUserShippingAddress Class Reference

Inherits from NSObject
Declared in KOUserShippingAddress.h

Overview

앱에 가입한 사용자의 배송지 정보 API 응답 클래스

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

  userId

배송지 정보를 요청한 사용자 아이디

@property (nonatomic, readonly, nullable) NSString *userId

See Also

Declared In

KOUserShippingAddress.h

  shippingAddresses

사용자의 배송지 정보 리스트

@property (nonatomic, readonly, nullable) NSArray<KOShippingAddress*> *shippingAddresses

Discussion

최신 수정순 (단, 기본 배송지는 수정시각과 상관없이 첫번째에 위치)
shippingAddresses 는 사용자의 동의를 받지 않은 경우 nil이 반환됩니다.
shippingAddresses 가 nil이면 shippingAddressNeedsAgreement 속성 값을 확인하여 사용자에게 정보 제공에 대한 동의를 요청하고 정보 획득을 시도해 볼 수 있습니다.
동의를 받은 후 [KOSessionTask userMeTaskWithCompletion:]를 다시 호출하면 shippingAddresses 값이 반환됩니다.

Declared In

KOUserShippingAddress.h

  shippingAddressNeedsAgreement

shippingAddresses 제공에 대한 사용자 동의 필요 여부

@property (nonatomic, readonly) BOOL shippingAddressNeedsAgreement

Discussion

@property shippingAddressNeedsAgreement

shippingAddressNeedsAgreement 값이 true인 경우 새로운 동의 요청이 가능한 상태이며 [KOSession updateScopes:completionHandler:] 메소드를 이용하여 동의를 받을 수 있습니다.
updateScopes의 파라미터로 전달할 shippingAddresses 동의항목에 대한 scope ID는 “shipping_addresses"입니다.

Declared In

KOUserShippingAddress.h