SmartclipSDKiOS 3.0.0
Smartclip Advertisement Framework for iOS
Loading...
Searching...
No Matches
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
32@property (nonatomic) BOOL enableCoreDebugLogging;
34@property (nonatomic, copy) NSString* _Nullable adURL;
36@property (nonatomic, copy) NSString* _Nullable bundleId;
38@property (nonatomic, strong) SCAdEnvironment* _Nullable environment;
40@property (nonatomic, strong) SCAdVariants* _Nullable variants;
42@property (nonatomic, copy) NSString* _Nullable customTitle __deprecated_msg("Setting this property no longer has any effect!");
44@property (nonatomic, strong) UIColor* _Nullable customTitleColor __deprecated_msg("Setting this property no longer has any effect!");
46@property (nonatomic, strong) UIColor* _Nullable customProgressBarColor __deprecated_msg("Setting this property no longer has any effect!");
48@property (nonatomic) BOOL allowAdSkipping;
50@property (nonatomic) NSInteger skipOffset;
52@property (nonatomic) BOOL initialMuted __deprecated_msg("Setting this property no longer has any effect!");
54@property (nonatomic, copy) NSString* _Nonnull clickThroughDialogMessage;
56@property (nonatomic, copy) NSString* _Nonnull clickThroughPositiveAnswer;
58@property (nonatomic, copy) NSString* _Nonnull clickThroughNegativeAnswer;
60@property (nonatomic) enum SCClickType clickType;
62@property (nonatomic) BOOL customizableClickThroughAlert;
64@property (nonatomic, copy) NSString* _Nullable replayButtonImageName __deprecated_msg("DEPRECATED: Setting this property no longer has any effect!");
65
68- (void)setOMIDVerificationVendorWhitelist:(NSArray*)vendors;
69
71+ (SCAdConfiguration*)defaultConfigurationWith:(NSString*)requestURL variants:(SCAdVariants*)variants environment:(SCAdEnvironment*)environment;
73+ (SCAdConfiguration*)defaultInstreamConfigurationWith:(SCAdEnvironment*)environment;
75+ (NSString*)frameworkBundleVersion;
77+ (NSString*)sdkVersionString;
79+ (NSString*)omidSDKVersionString;
80@end
81
82NS_ASSUME_NONNULL_END
This class is used to configure the advertisement behavior.
Definition: SCAdConfiguration.h:30
NSString *_Nullable replayButtonImageName __deprecated_msg("DEPRECATED: Setting this property no longer has any effect!")
DEPRECATED: Setting this property no longer has any effect!
BOOL initialMuted __deprecated_msg("Setting this property no longer has any effect!")
DEPRECATED: Setting this property no longer has any effect!
NSString *_Nonnull clickThroughDialogMessage
message to be displayed on the clickThrough dialog (default: "Open in Browser?")
Definition: SCAdConfiguration.h:54
BOOL allowAdSkipping
You can prevent ad skipping with this boolean value, defaults to true.
Definition: SCAdConfiguration.h:48
SCAdVariants *_Nullable variants
If you use opener, closer or bumper, SCAdVariants is the place to define them.
Definition: SCAdConfiguration.h:40
NSString *_Nonnull clickThroughPositiveAnswer
string to be displayed on the clickThrough dialog`s positive answer button (default: "YES")
Definition: SCAdConfiguration.h:56
NSString *_Nullable customTitle __deprecated_msg("Setting this property no longer has any effect!")
DEPRECATED: Setting this property no longer has any effect!
NSString *_Nullable bundleId
BundleId of the app.
Definition: SCAdConfiguration.h:36
enum SCClickType clickType
clickType for clickThrough handling (default: ClickableWithConfirmationDialog)
Definition: SCAdConfiguration.h:60
NSString * sdkVersionString()
SmartclipSDK version string (bundleVersion/buildNumber)
NSString * omidSDKVersionString()
OMIDSDK version string.
NSString * frameworkBundleVersion()
framework bundle version
BOOL enableCoreDebugLogging
Definition: SCAdConfiguration.h:32
UIColor *_Nullable customTitleColor __deprecated_msg("Setting this property no longer has any effect!")
DEPRECATED: Setting this property no longer has any effect!
UIColor *_Nullable customProgressBarColor __deprecated_msg("Setting this property no longer has any effect!")
DEPRECATED: Setting this property no longer has any effect!
NSString *_Nonnull clickThroughNegativeAnswer
string to be displayed on the clickThrough dialog`s negative answer button (default: "NO")
Definition: SCAdConfiguration.h:58
NSInteger skipOffset
You can define an offset value, when you want to allow ad skipping (defaults to -1,...
Definition: SCAdConfiguration.h:50
SCAdEnvironment *_Nullable environment
Use this to enable bitrate calculation, or set desiredBitrate.
Definition: SCAdConfiguration.h:38
NSString *_Nullable adURL
The request url for you advertisement content.
Definition: SCAdConfiguration.h:34
BOOL customizableClickThroughAlert
if you want to have control over the UIAlertController during clickThrough set this to "YES" (and lea...
Definition: SCAdConfiguration.h:62
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