/*
 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 WLBeacon.h
 The WLBeacon object is used to model the parameters of the iBeacon device
 that the Service is going to monitor
 @copyright Warply Inc.
 */

#import <Foundation/Foundation.h>

/*!
 @class WLBeacon
 @discussion This object contains the parameters for the iBeacon device
 that the WLBeaconManager will monitor.
 */
@interface WLBeacon : NSObject

/*!
 @property beaconIdentifier
 @abstract A string identifier for an iBeacon device.
 */
@property(nonatomic, copy) NSString *beaconIdentifier;
/*!
 @property beaconUUID
 @abstract The UUID string that is bounded with an iBeacon device.
 */
@property(nonatomic, strong) NSUUID *beaconUUID;

/*!
 @methodgroup Initializing a WLBeacon Object
 */
/*!
 @abstract Initialise a WLBeacon object.
 @discussion Initializes and returns a newly allocated WLBeacon object with the specified
 attributes.
 @param uuid A string that contains the UUID of the iBeacon device.
 @param identifier A string identifier that characterizes the iBeacon device.
 @return Returns WLBeacon object.
 */
- (instancetype)initWithUUID:(NSString*)uuid identifier:(NSString*)identifier;
@end