WLInboxItemViewController.h 3.52 KB
/*
 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 WLInboxItemViewController.h
 The WLInboxItemViewController is a UIWebViewController that shows modally the 
 web page of the selected offer (WLInboxItem).
 @copyright Warply Inc.
 */
#import <UIKit/UIKit.h>
#import <WebKit/WebKit.h>

@class WLInboxItem;

/*!
 @class WLInboxItemViewController
 @discussion This controller shows up modally and renders the web page of the 
 selected offer (WLInboxItem). Also handles the click-to-action functionality 
 specified such as pre-populated sms, QR Scanner etc.
 */
@interface WLInboxItemViewController : UIViewController <UIWebViewDelegate, UIAlertViewDelegate>
/*!
 @property requestedUrl
 @abstract An url object with link of the request offer web page.
 */
@property (nonatomic, readonly) NSURL *requestedUrl;
/*!
 @property session_uuid
 @abstract An string object with a unique session identifier.
 */
@property (nonatomic, readonly) NSString *session_uuid;

/*!
 @property hideNavigationArrows
 @abstract A BOOL flag that determines if the navigation arrows of the toolbar that control the back / forward funtionality in the webview are hidden or not.
 */
@property (nonatomic) BOOL hideNavigationArrows;

/*!
 @property webView
 @abstract The UIWebView that displays the offer's html content. By default, the scalesPageToFit property of the webView is set to YES.
 */
@property (nonatomic, readonly) WKWebView *webView;
/*!
 @property fromFullPage
 @abstract It can be set to YES when we want to present the WLInboxViewController modally, so there is an option to close the comtroller. Default is NO and the controller assumes a push segue.
 */
@property (nonatomic) BOOL fromFullPage;
/*!
 @property fromNativeAd
 @abstract It can be set to YES when we want to present the WLInboxViewController modally, so there is an option to close the comtroller. Default is NO and the controller assumes a push segue.
 */
@property (nonatomic) BOOL fromNativeAd;

/*!
@methodgroup Initializing a WLInboxItem View
*/
/*!
 @abstract Initialise a WLInboxItem View.
 @discussion Initializes and returns a newly allocated WLInboxItem View controller 
 with the specified WLInboxItem object.
 @param anItem A WLInboxItem object.
 @return Returns WLInboxItemViewController object.
 @see //apple_ref/occ/cl/WLInboxItem WLInboxItem
 */
- (id)initWithItem:(WLInboxItem*)anItem;

@end