/**
 * Copyright 2015-2018 Kakao Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*!
 @header KOFriend.h
 @abstract 카카오톡, 카카오스토리 친구 정보 관련 기능을 정의합니다.
 */
#import <Foundation/Foundation.h>
#import "KOUserInfo.h"

/*!
 @abstract KOOSPropertyType 카카오톡 사용자의 디바이스 OS 타입
 @constant KOOSPropertyTypeUnknown 알수없음
 @constant KOOSPropertyTypeIOS ios
 @constant KOOSPropertyTypeAndroid 안드로이드
 */
typedef NS_ENUM(NSInteger, KOOSPropertyType) {
    KOOSPropertyTypeUnknown = 0,
    KOOSPropertyTypeIOS = 1,
    KOOSPropertyTypeAndroid = 2
};

/*!
 @abstract KORelationValue 친구 관계
 @constant KORelationValueFriend 친구인 상태
 @constant KORelationValueNotFriend 친구가 아닌 상태
 @constant KORelationValueNotAvailable 친구인지 아닌지 알 수 없는 상태 (카카오톡 친구를 요청 했을 때, 카카오스토리 친구 관계를 알 수 없게 된다.)
 */
typedef NS_ENUM(NSInteger, KORelationValue) {
    KORelationValueFriend = 0,
    KORelationValueNotFriend = 1,
    KORelationValueNotAvailable = 2
};

extern NSString* convertOSPropertyTypeString(KOOSPropertyType type);

/*!
 @class KOFriend
 @abstract 카카오톡, 카카오스토리 친구 정보를 담는 구조체
 @see KOTalkMessageSending 카카오톡 메시지를 전송하기 위해 구현해야 하는 프로토콜
 */
@interface KOFriend : KOUserInfo

/*!
 @property appRegistered
 @abstract 친구의 앱 가입 여부
 */
@property (nonatomic, readonly, getter=isAppRegistered) BOOL appRegistered;

/*!
 @property nickName
 @abstract 친구의 대표 프로필 닉네임. 앱 가입친구의 경우 앱에서 설정한 닉네임. 미가입친구의 경우 톡 또는 스토리의 닉네임
 */
@property (nonatomic, readonly) NSString *nickName;

/*!
 @property thumbnailURL
 @abstract 친구의 썸네일 이미지
 */
@property (nonatomic, readonly) NSString *thumbnailURL;

/*!
 @property talkOS
 @abstract 톡에 가입된 기기의 os 정보 (android / ios)
 */
@property (nonatomic, readonly) KOOSPropertyType talkOS;

/*!
 @property allowedTalkMessaging
 @abstract 메시지 수신이 허용되었는지 여부. 앱가입 친구의 경우는 feed msg에 해당. 앱미가입친구는 invite msg에 해당
 */
@property (nonatomic, readonly, getter=isAllowedTalkMessaging) BOOL allowedTalkMessaging;

/*!
 @property talkRelation
 @abstract 나와의 카카오톡 친구 관계
 */
@property (nonatomic, readonly) KORelationValue talkRelation;

/*!
 @property storyRelation
 @abstract 나와의 카카오스토리 친구 관계
 */
@property (nonatomic, readonly) KORelationValue storyRelation;

+ (instancetype)responseWithDictionary:(NSDictionary *)dictionary;

@end