/*
 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 WLAPSItem.h
 The WLAPSItem object is used to model the parameters of the received Remote 
 Notification (Push) on how to notify user, in a structured way.
 @copyright Warply Inc.
 */
#import <Foundation/Foundation.h>

/*!
 @class WLAPSItem
 @discussion This object contains the parameters for the received Remote Notification 
 (Push), on how to notify the user, such as badge number and both alert text and sound.
 */
@interface WLAPSItem : NSObject
{
@private
    NSUInteger _badge;
    NSString  *_alert;
    NSString  *_sound;
}
/*!
 @property badge
 @abstract The number that will be shown as notification badge.
 */
@property (nonatomic) NSUInteger badge;
/*!
 @property alert
 @abstract A string object of the alert text
 */
@property (nonatomic, copy) NSString  *alert;
/*!
 @property sound
 @abstract A string object of the file for the alert sound.
 */
@property (nonatomic, copy) NSString  *sound;

/*!
 @methodgroup Initializing a WLAPSItem Object
 */
/*!
 @abstract Initialise a WLAPSItem 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 WLAPSItem object.
 */
- (id)initWithAttributes:(NSDictionary *)attributes;

@end