FBRewardedVideoAd - Documentation

FBRewardedVideoAd

A modal view controller to represent a Facebook rewarded video ad. This is a full-screen ad shown in your application.

Superclass:	`NSObject`
Declared in:	`FBRewardedVideoAd.h`

Properties

adValid

Returns true if the rewarded video ad has been successfully loaded.

@property (nonatomic,
    getter=isAdValid,
    readonly) BOOL adValid;

Discussion:

You should check isAdValid before trying to show the ad.

Declared In: FBRewardedVideoAd.h

delegate

The delegate

@property (nonatomic,
    weak,
    nullable) id<FBRewardedVideoAdDelegate> delegate;

Declared In: FBRewardedVideoAd.h

placementID

Typed access to the id of the ad placement.

@property (nonatomic,
    copy,
    readonly) NSString *placementID;

Declared In: FBRewardedVideoAd.h

Instance Methods

initWithPlacementID:

This is a method to initialize an FBRewardedVideoAd matching the given placement id.

Parameter	Description
`placementID`	The id of the ad placement. You can create your placement id from Facebook developers page.

- (instancetype) initWithPlacementID:(NSString *)placementID;

Declared In: FBRewardedVideoAd.h

initWithPlacementID:withUserID:withCurrency:withAmount:

This is a method to initialize an FBRewardedVideoAd matching the given placement id and allows the publisher to set the reward to give to a user.

Parameter	Description
`placementID`	The id of the ad placement. You can create your placement id from Facebook developers page.
`userID`	The id of the user
`currency`	Reward currency type
`amount`	Reward amount

- (instancetype)

`initWithPlacementID:`	`(NSString *)placementID`
`withUserID:`	`(nullable NSString *)userID`
`withCurrency:`	`(nullable NSString *)currency`
`withAmount:`	`(NSInteger)amount;`

Declared In: FBRewardedVideoAd.h

loadAd

Begins loading the FBRewardedVideoAd content.

- (void) loadAd;

Discussion:

You can implement rewardedVideoAdDidLoad: and rewardedVideoAd:didFailWithError: methods of FBRewardedVideoAdDelegate if you would like to be notified as loading succeeds or fails.

Declared In: FBRewardedVideoAd.h

showAdFromRootViewController:

Presents the rewarded video ad modally from the specified view controller.

Parameter	Description
`rootViewController`	The view controller that will be used to present the rewarded video ad.

- (BOOL) showAdFromRootViewController:(UIViewController *)rootViewController;

Discussion:

You can implement rewardedVideoAdDidClick: and rewardedVideoAdWillClose: methods of FBRewardedVideoAdDelegate if you would like to stay informed for those events.

Declared In: FBRewardedVideoAd.h

showAdFromRootViewController:animated:

Presents the rewarded video ad modally from the specified view controller.

Parameter	Description
`rootViewController`	The view controller that will be used to present the rewarded video ad.
`flag`	Pass YES to animate the presentation; otherwise, pass NO.

- (BOOL)

`showAdFromRootViewController:`	`(UIViewController *)rootViewController`
`animated:`	`(BOOL)flag;`

Discussion:

You can implement rewardedVideoAdDidClick: and rewardedVideoAdWillClose: methods of FBRewardedVideoAdDelegate if you would like to stay informed for those events.

Declared In: FBRewardedVideoAd.h