UserApi
final public class UserApi
카카오 Open API의 사용자관리 API 호출을 담당하는 클래스입니다.
-
간편하게 API를 호출할 수 있도록 제공되는 공용 싱글톤 객체입니다.
Declaration
Swift
public static let shared: UserApi
-
User 클래스에서 제공되고 있는 사용자의 부가정보를 신규저장 및 수정할 수 있습니다.
저장 가능한 키 이름은 개발자사이트 앱 설정의
사용자 관리 > 사용자 목록 및 프로퍼티
메뉴에서 확인하실 수 있습니다. 앱 연결 시 기본 저장되는 nickanme, profile_image, thumbnail_image 값도 덮어쓰기 가능하며 새로운 컬럼을 추가하면 해당 키 이름으로 값을 저장할 수 있습니다.Seealso
User.properties
Declaration
Swift
public func updateProfile(properties: [String:Any], completion:@escaping (Error?) -> Void)
-
현재 토큰의 기본적인 정보를 조회합니다. me()에서 제공되는 다양한 사용자 정보 없이 가볍게 토큰의 유효성을 체크하는 용도로 사용하는 경우 추천합니다.
Seealso
AccessTokenInfo
Declaration
Swift
public func accessTokenInfo(completion: @escaping (AccessTokenInfo?, Error?) -> Void)
-
토큰을 강제로 만료시킵니다. 같은 사용자가 여러개의 토큰을 발급 받은 경우 로그아웃 요청에 사용된 토큰만 만료됩니다.
Declaration
Swift
public func logout(completion: @escaping (Error?) -> Void)
-
카카오 플랫폼 서비스와 앱 연결을 해제합니다.
Declaration
Swift
public func unlink(completion: @escaping (Error?) -> Void)
-
앱에 가입한 사용자의 배송지 정보를 얻어간다.
Seealso
UserShippingAddresses
Declaration
Swift
public func shippingAddresses(fromUpdatedAt: Int? = nil, pageSize: Int? = nil, completion: @escaping (UserShippingAddresses?, Error?) -> Void)
-
앱에 가입한 사용자의 배송지 정보를 얻어간다.
Seealso
UserShippingAddresses
Declaration
Swift
public func shippingAddresses(addressId: Int64, completion: @escaping (UserShippingAddresses?, Error?) -> Void)
-
사용자가 카카오 간편가입을 통해 동의한 서비스 약관 내역을 반환합니다.
Seealso
UserServiceTerms
Declaration
Swift
public func serviceTerms(completion: @escaping (UserServiceTerms?, Error?) -> Void)