SmartclipSDKiOS 3.0.0
Smartclip Advertisement Framework for iOS
SCAdConfiguration.h
1//
2// SCAdConfiguration.h
3// SmartclipSDKiOS
4//
5// Copyright © 2018 smartclip. All rights reserved.
6//
7
8#import <Foundation/Foundation.h>
9#import <CoreGraphics/CoreGraphics.h>
10
11NS_ASSUME_NONNULL_BEGIN
12
13@class SCAdEnvironment, SCAdVariants, UIColor;
14
20typedef enum SCClickType {
21 NotClickable,
22 ClickableOnFullArea,
23 ClickableOnAssociatedButtonOrLink,
24 ClickableWithConfirmationDialog
25} SCClickType;
26
27
29@interface SCAdConfiguration : NSObject
31@property (nonatomic, copy) NSString* _Nullable adURL;
33@property (nonatomic, copy) NSString* _Nullable bundleId;
35@property (nonatomic, strong) SCAdEnvironment* _Nullable environment;
37@property (nonatomic, strong) SCAdVariants* _Nullable variants;
39@property (nonatomic, copy) NSString* _Nullable customTitle;
41@property (nonatomic, strong) UIColor* _Nullable customTitleColor;
43@property (nonatomic, strong) UIColor* _Nullable customProgressBarColor;
45@property (nonatomic) BOOL allowAdSkipping;
47@property (nonatomic) NSInteger skipOffset;
49@property (nonatomic) BOOL initialMuted;
51@property (nonatomic, copy) NSString* _Nonnull clickThroughDialogMessage;
53@property (nonatomic, copy) NSString* _Nonnull clickThroughPositiveAnswer;
55@property (nonatomic, copy) NSString* _Nonnull clickThroughNegativeAnswer;
57@property (nonatomic) enum SCClickType clickType;
59@property (nonatomic) BOOL customizableClickThroughAlert;
61@property (nonatomic, copy) NSString* _Nullable replayButtonImageName;
62
65- (void)setOMIDVerificationVendorWhitelist:(NSArray*)vendors;
66
68+ (SCAdConfiguration*)defaultConfigurationWith:(NSString*)requestURL variants:(SCAdVariants*)variants environment:(SCAdEnvironment*)environment;
70+ (SCAdConfiguration*)defaultInstreamConfigurationWith:(SCAdEnvironment*)environment;
72+ (NSString*)sdkVersionString;
74+ (NSString*)omidSDKVersionString;
75@end
76
77NS_ASSUME_NONNULL_END
This class is used to configure the advertisement behavior.
Definition: SCAdConfiguration.h:30
NSString *_Nonnull clickThroughDialogMessage
message to be displayed on the clickThrough dialog (default: "Open in Browser?")
Definition: SCAdConfiguration.h:51
BOOL allowAdSkipping
You can prevent ad skipping with this boolean value, defaults to true.
Definition: SCAdConfiguration.h:45
NSString *_Nullable customTitle
Use this property to specify a custom title for the ad.
Definition: SCAdConfiguration.h:39
SCAdVariants *_Nullable variants
If you use opener, closer or bumper, SCAdVariants is the place to define them.
Definition: SCAdConfiguration.h:37
NSString *_Nonnull clickThroughPositiveAnswer
string to be displayed on the clickThrough dialog`s positive answer button (default: "YES")
Definition: SCAdConfiguration.h:53
NSString *_Nullable replayButtonImageName
name of the image asset used for the replay button (outstream only)
Definition: SCAdConfiguration.h:61
UIColor *_Nullable customTitleColor
Use this property to specify a custom title color for the ad.
Definition: SCAdConfiguration.h:41
NSString *_Nullable bundleId
BundleId of the app.
Definition: SCAdConfiguration.h:33
enum SCClickType clickType
clickType for clickThrough handling (default: ClickableWithConfirmationDialog)
Definition: SCAdConfiguration.h:57
NSString * sdkVersionString()
SpotXSDK version string.
NSString * omidSDKVersionString()
OMIDSDK version string.
UIColor *_Nullable customProgressBarColor
Use this property to specify a custom progress bar color for the ad.
Definition: SCAdConfiguration.h:43
NSString *_Nonnull clickThroughNegativeAnswer
string to be displayed on the clickThrough dialog`s negative answer button (default: "NO")
Definition: SCAdConfiguration.h:55
NSInteger skipOffset
You can define an offset value, when you want to allow ad skipping (defaults to -1,...
Definition: SCAdConfiguration.h:47
SCAdEnvironment *_Nullable environment
Use this to enable bitrate calculation, or set desiredBitrate.
Definition: SCAdConfiguration.h:35
NSString *_Nullable adURL
The request url for you advertisement content.
Definition: SCAdConfiguration.h:31
BOOL initialMuted
true if the audio of the advertisement should be muted from the beginning. Defaulting to false.
Definition: SCAdConfiguration.h:49
BOOL customizableClickThroughAlert
if you want to have control over the UIAlertController during clickThrough set this to "YES" (and lea...
Definition: SCAdConfiguration.h:59
This class is used to specify certain environment variables like desired bitrate, deviceType and scre...
Definition: SCAdEnvironment.h:17
This class holds an opener, closer and/or bumper for an adTag.
Definition: SCAdVariants.h:15