UserApi class

KO: 카카오 로그인 API 클래스
EN: Class for the Kakao Login APIs

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

accessTokenInfo() → Future<AccessTokenInfo>
KO: 액세스 토큰 정보 조회
EN: Access token information
loginWithKakao(BuildContext context, {LoginUiMode uiMode = LoginUiMode.auto, AccountLoginParams? accountParams, List<String>? channelPublicIds, List<String>? serviceTerms, String? nonce}) → Future<OAuthToken>
KO: 카카오톡으로 로그인과 카카오계정으로 로그인 중 하나를 선택할 수 있는 화면 제공
uiMode에 로그인 선택 화면 모드 전달
accountParams에 카카오계정으로 로그인 기능을 위한 설정 전달
channelPublicIds에 카카오톡 채널 프로필 ID 전달
serviceTerms 서비스 약관 목록 전달
ID 토큰 재생 공격 방지를 위한 검증 값, 임의의 문자열은 nonce에 전달

EN: Provides a screen where users can choose between logging in with Kakao Talk or Kakao Account.
Pass the login selection screen mode to uiMode
Pass the settings for the Kakao Account login feature to accountParams
Pass list of Kakao Talk Channel IDs to channelPublicIds
Pass list of service terms to serviceTerms
Pass a random string to prevent replay attacks to nonce
loginWithKakaoAccount({List<Prompt>? prompts, List<String>? channelPublicIds, List<String>? serviceTerms, String? loginHint, String? nonce}) → Future<OAuthToken>
KO: 카카오계정으로 로그인
prompts에 상호작용 추가 요청 프롬프트 전달
channelPublicIds에 카카오톡 채널 프로필 ID 전달
serviceTerms 서비스 약관 목록 전달
loginHint에 카카오계정 로그인 페이지의 ID란에 자동 입력할 값 전달
ID 토큰 재생 공격 방지를 위한 검증 값, 임의의 문자열은 nonce에 전달

EN: Login with Kakao Account
Pass the prompts to prompts for requests to add interactions
Pass List of Kakao Talk Channel IDs to channelPublicIds
Pass list of service terms to serviceTerms
Pass a value to fill in the ID field of the Kakao Account login page to loginHint
Pass a random string to prevent replay attacks to nonce
loginWithKakaoTalk({List<String>? channelPublicIds, List<String>? serviceTerms, String? nonce}) → Future<OAuthToken>
KO: 카카오톡으로 로그인
channelPublicIds에 카카오톡 채널 프로필 ID 전달
serviceTerms 서비스 약관 목록 전달

EN: Login with Kakao Talk
Pass list of Kakao Talk Channel IDs to channelPublicIds
Pass list of service terms to serviceTerms
loginWithNewScopes(List<String> scopes, {String? nonce}) → Future<OAuthToken>
KO: 동의항목 추가 동의 요청
동의 항목 ID 목록은 scopes에 전달

EN: Request additional consent
Pass a list of the scope IDs to scopes
logout() → Future<UserIdResponse>
KO: 로그아웃
EN: Logout
me({List<String>? properties, bool secureResource = true}) → Future<User>
KO: 사용자 정보 조회
EN: Retrieve user information
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
revokeScopes({required List<String> scopes}) → Future<ScopeInfo>
KO: 동의 철회
동의 항목 ID 목록은 scopes에 전달

EN: Revoke consent
Pass a list of the scope IDs to scopes
revokeServiceTerms({required List<String> tags}) → Future<UserRevokedServiceTerms>
KO: 서비스 약관 동의 철회
서비스 약관 태그 목록은 tags에 전달

EN: Revoke consent for service terms
Pass the tags of service terms to tags
scopes({List<String>? scopes}) → Future<ScopeInfo>
KO: 동의 내역 조회
EN: Retrieve consent details
selectShippingAddress({bool? mobileView, bool? enableBackButton}) → Future<int>
KO: 배송지 선택
enableBackButton과 mobileView는 웹 플랫폼 전용 파라미터
mobileView로 배송지 피커를 모바일 디바이스에 맞춘 레이아웃으로 고정할 것인지 지정
enableBackButton로 배송지 피커의 뒤로 가기 버튼 노출 여부 지정

EN: Select shipping address
enableBackButton and mobileView are web platform only parameters
Use mobileView to specify whether the picker is pinned to a layout adapted for mobile device
Use enableBackButton to show or hide the back button in the picker
serviceTerms({List<String>? tags, String? result}) → Future<UserServiceTerms>
KO: 서비스 약관 동의 내역 조회
서비스 약관 태그 목록은 tags에 전달
result에 조회 대상(agreed_service_terms: 사용자가 동의한 서비스 약관 목록 | app_service_terms: 앱에 사용 설정된 서비스 약관 목록, 기본값: agreed_service_terms) 전달

EN: Retrieve consent details for service terms
Pass the tags of service terms to tags
Pass the result type (agreed_service_terms: List of service terms the user has agreed to | app_service_terms: List of service terms enabled for the app, Default: agreed_service_terms) to result
shippingAddresses({int? addressId, DateTime? fromUpdatedAt, int? pageSize}) → Future<UserShippingAddresses>
KO: 배송지 조회
addressId에 배송지 ID 전달
fromUpdatedAt에 이전 페이지의 마지막 배송지 수정 시각 전달, 0 전달 시 처음부터 조회
pageSize에 한 페이지에 포함할 배송지 수 전달(기본값: 10)

EN: Retrieve shipping address
Pass the Shipping address ID to addressId
Pass the last shipping address modification on the previous page to fromUpdatedAt, retrieve from beginning if passing `0'
Pass the number of shipping addresses displayed on a page to pageSize(Default: 10)
signup({Map<String, String>? properties}) → Future<void>
KO: 수동 연결
EN: Manual signup
toString() → String
A string representation of this object.
inherited
KO: 연결 해제
EN: Unlink
updateProfile(Map<String, String> properties) → Future<void>
KO: 사용자 프로퍼티 저장
EN: Store user properties

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

instance → UserApi
final