/*
 * Copyright 2017 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.
 */

#import <KakaoMessageTemplate/KMTTemplate.h>

NS_ASSUME_NONNULL_BEGIN

@class KMTContentObject;
@class KMTLinkObject;
@class KMTButtonObject;

@class KMTLinkBuilder;

/// 여러 개의 컨텐츠를 리스트 형태로 보여줄 수 있는 메시지 템플릿입니다.
/// @discussion 리스트 템플릿은 메시지 상단에 노출되는 헤더 타이틀과, 컨텐츠 목록, 버튼 등으로 구성됩니다. 헤더와 컨텐츠 각각의 링크를 가질 수 있습니다. 피드 템플릿과 마찬가지로 하나의 기본 버튼을 가지며 임의의 버튼을 설정할 수 있습니다.
@interface KMTListTemplate : KMTTemplate

/// @abstract 리스트 상단에 노출되는 헤더 타이틀 (최대 200자)
@property (copy, nonatomic) NSString *headerTitle;

/// @abstract 헤더 타이틀 내용에 해당하는 링크 정보
@property (copy, nonatomic) KMTLinkObject *headerLink;

/// @abstract 리스트 템플릿의 상단에 보이는 이미지 URL
@property (copy, nonatomic, nullable) NSURL *headerImageURL;

/// @abstract 리스트 템플릿의 상단에 보이는 이미지 widht, 권장 800 (단위: 픽셀)
@property (copy, nonatomic, nullable) NSNumber *headerImageWidth;

/// @abstract 리스트 템플릿의 상단에 보이는 이미지 height, 권장 190 (단위: 픽셀)
@property (copy, nonatomic, nullable) NSNumber *headerImageHeight;

/// @abstract 리스트에 노출되는 컨텐츠 목록 (최소 2개, 최대 3개)
@property (copy, nonatomic) NSArray<KMTContentObject *> *contents;

/// @abstract 기본 버튼 타이틀("자세히 보기")을 변경하고 싶을 때 설정
@property (copy, nonatomic, nullable) NSString *buttonTitle;

/// @abstract 버튼 목록. 버튼 타이틀과 링크를 변경하고 싶을때, 버튼 두개를 사용하고 싶을때 사용 (최대 2개)
@property (copy, nonatomic, nullable) NSArray<KMTButtonObject *> *buttons;

@end

@interface KMTListTemplate (Constructor)

+ (instancetype)listTemplateWithHeaderTitle:(NSString *)headerTitle
                                 headerLink:(KMTLinkObject *)headerLink
                                   contents:(NSArray<KMTContentObject *> *)contents;
- (instancetype)initWithHeaderTitle:(NSString *)headerTitle
                         headerLink:(KMTLinkObject *)headerLink
                           contents:(NSArray<KMTContentObject *> *)contents;

@end

@interface KMTListTemplateBuilder : NSObject

@property (copy, nonatomic) NSString *headerTitle;
@property (copy, nonatomic) KMTLinkObject *headerLink;
@property (copy, nonatomic, nullable) NSURL *headerImageURL;
@property (copy, nonatomic, nullable) NSNumber *headerImageWidth;
@property (copy, nonatomic, nullable) NSNumber *headerImageHeight;
@property (copy, nonatomic) NSMutableArray<KMTContentObject *> *contents;
@property (copy, nonatomic, nullable) NSString *buttonTitle;
@property (copy, nonatomic, nullable) NSMutableArray<KMTButtonObject *> *buttons;

- (void)addContent:(KMTContentObject *)content;
- (void)addButton:(KMTButtonObject *)button;
- (KMTListTemplate *)build;

@end

@interface KMTListTemplate (ConstructorWithBuilder)

+ (instancetype)listTemplateWithBuilderBlock:(void (^)(KMTListTemplateBuilder *listTemplateBuilder))builderBlock;
+ (instancetype)listTemplateWithBuilder:(KMTListTemplateBuilder *)builder;
- (instancetype)initWithBuilder:(KMTListTemplateBuilder *)builder;

@end

NS_ASSUME_NONNULL_END