Skip to content

Commit

Permalink
added some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JanC committed Apr 29, 2015
1 parent dc15bdd commit 9c84e92
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
9 changes: 9 additions & 0 deletions Pod/Classes/TAITunesClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,14 @@ typedef void (^TAAppInfoCompletionBlock)(NSDictionary *response, NSError *error)

@interface TAITunesClient : NSObject

/**
* Fetches the json information about a specified iOS App from iTunes. See
* https://www.apple.com/itunes/affiliates/resources/documentation/itunes-store-web-service-search-api.html#searching
*
* @param appId The App Store app id
* @param country The two-letter country code for the store you want to search.
* @param completion The completion block that contains the json dictionary of the app
*/
- (void)fetchInfoForAppId:(NSInteger)appId country:(NSString *)country completion:(TAAppInfoCompletionBlock)completion;

@end
23 changes: 22 additions & 1 deletion Pod/Classes/TAPromotee.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Created by Jan on 26/04/15.
// Created by Jan Chaloupecky on 26/04/15.
//

#import <UIKit/UIKit.h>
Expand All @@ -16,12 +16,33 @@ typedef void (^TAPromoteeCompletion)(TAPromoteeUserAction userAction);
@interface TAPromotee : NSObject


/**
* This method fetches the app info via tha iTunes API and displays a interstitial view controller. The user can choose
* to close it or to install the app. If the user taps on install, a SKStoreProductViewController is presented.
* In both cases, the presented controller is dismissed and the completion block called
*
* @param viewController The view controller from which the interstitial ad will be displayed from
* @param appId The App Store app id of the app
* @param caption A short advert description dysplayed under the app icon
* @param backgroundImage The custom background image that takes the size of the entire screen. The bottom half is blurred
* @param completion The completion block called when the user closes or installs the app.
*/
+ (void)showFromViewController:(UIViewController *)viewController
appId:(NSInteger)appId
caption:(NSString *)caption
backgroundImage:(UIImage *)backgroundImage
completion:(TAPromoteeCompletion)completion;

/**
* This method fetches the app info via tha iTunes API and displays a interstitial view controller. The user can choose
* to close it or to install the app. If the user taps on install, a SKStoreProductViewController is presented.
* In both cases, the presented controller is dismissed and the completion block called
*
* @param viewController The view controller from which the interstitial ad will be displayed from
* @param appId The App Store app id of the app
* @param caption A short advert description dysplayed under the app icon
* @param completion The completion block called when the user closes or installs the app.
*/
+ (void)showFromViewController:(UIViewController *)viewController
appId:(NSInteger)appId
caption:(NSString *)caption
Expand Down

0 comments on commit 9c84e92

Please sign in to comment.