getAppBaseInfo
接口说明
getAppBaseInfo 用于获取当前应用的基础信息,包括 SDK 版本、调试开关、语言、应用版本、主题、字体缩放比例和字体大小设置等。
该接口为同步接口,调用后会直接返回包含应用基础信息的 NSDictionary。
方法声明
objectivec
/**
Retrieves the base information of the current application.
@return A dictionary containing app base information such as app version, host, etc.
*/
- (NSDictionary *)getAppBaseInfo;参数说明
该方法无需传入参数。
返回值说明
| 返回值类型 | 说明 |
|---|---|
NSDictionary * | 应用基础信息字典。 |
返回的字典中包含以下字段:
| 字段 | 类型 | 说明 |
|---|---|---|
SDKVersion | NSString * | 当前 SDK 版本号。 |
enableDebug | NSNumber * / BOOL | 是否开启 Debug 模式。YES 表示开启,NO 表示关闭。 |
language | NSString * | 当前应用或 SDK 使用的语言标识。 |
version | NSString * | 当前应用版本号。 |
theme | NSString * | 当前主题配置,例如浅色、深色或自定义主题。 |
fontSizeScaleFactor | NSNumber * | 字体大小缩放比例。 |
fontSizeSetting | NSString * / NSNumber * | 字体大小设置,具体类型和值以 SDK 实际返回为准。 |
使用示例
获取应用基础信息
objectivec
NSDictionary *appBaseInfo = [self getAppBaseInfo];
NSLog(@"App Base Info: %@", appBaseInfo);读取返回字段
objectivec
NSDictionary *appBaseInfo = [self getAppBaseInfo];
NSString *SDKVersion = appBaseInfo[@"SDKVersion"];
NSNumber *enableDebug = appBaseInfo[@"enableDebug"];
NSString *language = appBaseInfo[@"language"];
NSString *version = appBaseInfo[@"version"];
NSString *theme = appBaseInfo[@"theme"];
NSNumber *fontSizeScaleFactor = appBaseInfo[@"fontSizeScaleFactor"];
id fontSizeSetting = appBaseInfo[@"fontSizeSetting"];
NSLog(@"SDKVersion: %@", SDKVersion);
NSLog(@"enableDebug: %@", enableDebug);
NSLog(@"language: %@", language);
NSLog(@"version: %@", version);
NSLog(@"theme: %@", theme);
NSLog(@"fontSizeScaleFactor: %@", fontSizeScaleFactor);
NSLog(@"fontSizeSetting: %@", fontSizeSetting);安全读取字段
objectivec
NSDictionary *appBaseInfo = [self getAppBaseInfo];
NSString *SDKVersion = nil;
id SDKVersionValue = appBaseInfo[@"SDKVersion"];
if ([SDKVersionValue isKindOfClass:[NSString class]]) {
SDKVersion = SDKVersionValue;
}
BOOL enableDebug = NO;
id enableDebugValue = appBaseInfo[@"enableDebug"];
if ([enableDebugValue respondsToSelector:@selector(boolValue)]) {
enableDebug = [enableDebugValue boolValue];
}
NSString *language = nil;
id languageValue = appBaseInfo[@"language"];
if ([languageValue isKindOfClass:[NSString class]]) {
language = languageValue;
}
NSString *version = nil;
id versionValue = appBaseInfo[@"version"];
if ([versionValue isKindOfClass:[NSString class]]) {
version = versionValue;
}
NSString *theme = nil;
id themeValue = appBaseInfo[@"theme"];
if ([themeValue isKindOfClass:[NSString class]]) {
theme = themeValue;
}
CGFloat fontSizeScaleFactor = 1.0;
id fontSizeScaleFactorValue = appBaseInfo[@"fontSizeScaleFactor"];
if ([fontSizeScaleFactorValue respondsToSelector:@selector(floatValue)]) {
fontSizeScaleFactor = [fontSizeScaleFactorValue floatValue];
}
id fontSizeSetting = appBaseInfo[@"fontSizeSetting"];
NSLog(@"SDKVersion: %@", SDKVersion);
NSLog(@"enableDebug: %@", @(enableDebug));
NSLog(@"language: %@", language);
NSLog(@"version: %@", version);
NSLog(@"theme: %@", theme);
NSLog(@"fontSizeScaleFactor: %@", @(fontSizeScaleFactor));
NSLog(@"fontSizeSetting: %@", fontSizeSetting);返回数据示例
以下示例仅用于说明字段结构,具体值以 SDK 实际返回为准。
objectivec
{
SDKVersion = "1.0.0";
enableDebug = 1;
language = "zh-Hans";
version = "1.2.3";
theme = "light";
fontSizeScaleFactor = "1.0";
fontSizeSetting = "normal";
}或 JSON 表示:
json
{
"SDKVersion": "1.0.0",
"enableDebug": true,
"language": "zh-Hans",
"version": "1.2.3",
"theme": "light",
"fontSizeScaleFactor": 1.0,
"fontSizeSetting": "normal"
}注意事项
- 该接口不需要传入参数。
- 该接口为同步接口,调用后直接返回结果。
- 返回字段包含
SDKVersion、enableDebug、language、version、theme、fontSizeScaleFactor、fontSizeSetting。 - 建议读取字段时进行类型判断,避免因字段为空或类型不符合预期导致异常。
- 字段值类型以 SDK 实际返回为准。
