/*
 Copyright 2010-2016 Warply Inc. All rights reserved.
 
 Redistribution and use in source and binary forms, without modification, 
 are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.
 
 2. Redistributions in binaryform must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE WARPLY LTD ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 EVENT SHALL WARPLY LTD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*!
 @header WLBaseItem.h
 The WLAPSItem object is used to model the attributes for the received Remote 
 Notification (Push) in a structured way.
 @copyright Warply Inc.
 */
#import <Foundation/Foundation.h>
#import "WLAPSItem.h"

/*!
 @class WLBaseItem
 @discussion This object contains the attributes for the received Remote Notification 
 (Push) such as message, custom data, action etc.
 */
@interface WLBaseItem : NSObject
{
@private
    NSInteger _action;
    NSString *_session_uuid;
    NSString *_trace;
    NSString *_message;
    WLAPSItem *_apsItem;
    NSDictionary *_customData;
}
/*!
 @property action
 @abstract An integer id for the action need to be executed for the received 
 remote notification (push).
 */
@property (nonatomic) NSInteger action;
/*!
 @property openedCount
 @abstract An integer counter of the times the offer html has been loaded by the user. 
 */
@property (nonatomic) NSInteger openedCount;
/*!
 @property session_uuid
 @abstract A string object with unique identification of the received remote
 notification (push).
 */
@property (nonatomic, copy) NSString *session_uuid;
/*!
 @property trace
 @abstract A string object with a tracing identification of the received remote
 notification (push).
 */
@property (nonatomic, copy) NSString *trace;
/*!
 @property message
 @abstract A string object with a message of the received remote notification
 (push).
 */
@property (nonatomic, copy) NSString *message;
/*!
 @property apsItem
 @abstract A WLAPSItem object with a user notification parameters of the 
 received remote notification (push).
 @seealso //apple_ref/occ/cl/WLAPSItem WLAPSItem
 */
@property (nonatomic, strong) WLAPSItem *apsItem;
/*!
 @property customData
 @abstract A dictionary object with key-value arbitrary data contained inside the 
 received remote notification (push).
 */
@property (nonatomic, strong) NSDictionary *customData;

/*!
 @methodgroup Initializing a WLBaseItem Object
 */
/*!
 @abstract Initialise a WLBaseItem Object.
 @discussion Initializes and returns a newly allocated WLAPSItem object with the 
 specified attributes.
 @param attributes A dictionary object which contains remote notification attributes.
 @return Returns WLBaseItem object.
 */
- (id)initWithAttributes:(NSDictionary *)attributes;

/*!
 @methodgroup Getting WLBaseItem URLs
 */
/*!
 @abstract Get Remote Notification (Push) page url.
 @discussion Returns the url for the web page of the offer related to the received 
 Remote Notification (push).
 @return Returns a string object with offer web page url.
 */
- (NSString *)getPageURL;
/*!
 @abstract Get Remote Notification (Push) image url.
 @discussion Returns the url for the placeholder image of the offer related to the 
 received Remote Notification (push).
 @return Returns a string object with the offer placeholder url.
 */
- (NSString *)getImageURL;

@end