1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
// Copyright 2004-present Facebook. All Rights Reserved.
//
// You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
// copy, modify, and distribute this software in source code or binary form for use
// in connection with the web services and APIs provided by Facebook.
//
// As with any software that integrates with the Facebook platform, your use of
// this software is subject to the Facebook Developer Principles and Policies
// [http://developers.facebook.com/policy/]. This copyright notice shall be
// included in all copies or substantial portions of the software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#import <Foundation/Foundation.h>
#import <FBAudienceNetwork/FBAdDefines.h>
NS_ASSUME_NONNULL_BEGIN
/**
Audience Network error domain (returned in NSErrors generated by the SDK)
*/
FB_EXPORT NSString * const FBAudienceNetworkErrorDomain;
/**
Audience Network SDK logging levels
*/
typedef NS_ENUM(NSInteger, FBAdLogLevel) {
/// No logging
FBAdLogLevelNone,
/// Notifications
FBAdLogLevelNotification,
/// Errors only
FBAdLogLevelError,
/// Warnings only
FBAdLogLevelWarning,
/// Standard log level
FBAdLogLevelLog,
/// Debug logging
FBAdLogLevelDebug,
/// Log everything (verbose)
FBAdLogLevelVerbose
};
/**
Determines what method is used for rendering FBMediaView content
*/
typedef NS_ENUM(NSInteger, FBMediaViewRenderingMethod) {
/// Automatic selection of rendering method
FBMediaViewRenderingMethodDefault,
/// Force Metal rendering (only use for devices with support)
FBMediaViewRenderingMethodMetal,
/// Force OpenGL rendering
FBMediaViewRenderingMethodOpenGL,
/// Software fallback
FBMediaViewRenderingMethodSoftware
};
/**
AdSettings contains global settings for all ad controls.
*/
FB_CLASS_EXPORT FB_SUBCLASSING_RESTRICTED
@interface FBAdSettings : NSObject
/**
Returns test mode on/off.
*/
+ (BOOL)isTestMode;
/**
Returns the hashid of the device to use test mode on.
*/
+ (NSString *)testDeviceHash;
/**
Adds a test device.
- Parameter deviceHash: The id of the device to use test mode, can be obtained from debug log or testDeviceHash
Copy the current device Id from debug log and add it as a test device to get test ads. Apps
running on emulator will automatically get test ads. Test devices should be added before loadAd is called.
*/
+ (void)addTestDevice:(NSString *)deviceHash;
/**
Add a collection of test devices. See `+addTestDevices:` for details.
- Parameter devicesHash: The array of the device id to use test mode, can be obtained from debug log or testDeviceHash
*/
+ (void)addTestDevices:(FB_NSArrayOf(NSString *)*)devicesHash;
/**
Clear all the added test devices
*/
+ (void)clearTestDevices;
/**
Clears the added test device
- Parameter deviceHash: The id of the device using test mode, can be obtained from debug log or testDeviceHash
*/
+ (void)clearTestDevice:(NSString *)deviceHash;
/**
Configures the ad control for treatment as child-directed.
- Parameter isChildDirected: Indicates whether you would like your ad control to be treated as child-directed
Note that you may have other legal obligations under the Children's Online Privacy Protection Act (COPPA).
Please review the FTC's guidance and consult with your own legal counsel.
*/
+ (void)setIsChildDirected:(BOOL)isChildDirected;
/**
If an ad provided service is mediating Audience Network in their sdk, it is required to set the name of the mediation service
- Parameter service: Representing the name of the mediation that is mediation Audience Network
*/
+ (void)setMediationService:(NSString *)service;
/**
Gets the url prefix to use when making ad requests.
This method should never be used in production.
*/
+ (nullable NSString *)urlPrefix;
/**
Sets the url prefix to use when making ad requests.
This method should never be used in production.
*/
+ (void)setUrlPrefix:(nullable NSString *) urlPrefix;
/**
Gets the current SDK logging level
*/
+ (FBAdLogLevel)getLogLevel;
/**
Sets the current SDK logging level
*/
+ (void)setLogLevel:(FBAdLogLevel)level;
/**
Gets the FBMediaView rendering method
*/
+ (FBMediaViewRenderingMethod)mediaViewRenderingMethod;
/**
Sets the FBMediaView rendering method
- Parameter mediaViewRenderingMethod:
FBMediaViewRenderingMethodDefault: SDK chooses optimized rendering method
FBMediaViewRenderingMethodMetal: use Metal kit rendering method
FBMediaViewRenderingMethodOpenGL: use OpenGL rendering method
FBMediaViewRenderingMethodSoftware: use software rendering method
*/
+ (void)setMediaViewRenderingMethod:(FBMediaViewRenderingMethod)mediaViewRenderingMethod;
@end
NS_ASSUME_NONNULL_END
|
