IMSConfiguration Class Reference

Inherits from	NSObject
Declared in	IMSConfiguration.h

Overview

API 通道配置信息

此分类供宿主App使用、用于将配置信息写入AppGroup共享内存区域中

此分类供AppExtension使用、例如TodayExtension、用于从appGroup共享内存区域中读取配置信息

Other Methods

`authCode`

安全图片的 authCode，不指定时默认为 “07e8"；该值必须和安全图片 yw_1222_xxx.jpg 的 xxx 部分一致

@property (nonatomic, copy) NSString *authCode

Discussion

安全图片的 authCode，不指定时默认为 “07e8"；该值必须和安全图片 yw_1222_xxx.jpg 的 xxx 部分一致

Declared In

IMSConfiguration.h

`appKey`

移动应用 appKey，该值自动从安全图片中读取

@property (nonatomic, copy, readonly) NSString *appKey

Discussion

移动应用 appKey，该值自动从安全图片中读取

Declared In

IMSConfiguration.h

`host`

API 通道官方服务器域名

@property (nonatomic, copy, readonly) NSString *host

Discussion

API 通道官方服务器域名

Declared In

IMSConfiguration.h

`language`

API 通道请求支持的语言，格式标准为：[language designator][region designator]，当前支持：en-US，zh-CN，未指定默认使用 zh-CN

@property (nonatomic, copy) NSString *language

Discussion

API 通道请求支持的语言，格式标准为：[language designator][region designator]，当前支持：en-US，zh-CN，未指定默认使用 zh-CN

Declared In

IMSConfiguration.h

`serverEnv`

API 通道服务器环境，不指定时默认为线上

@property (nonatomic, assign, readonly) IMSServerEnviroment serverEnv

Discussion

API 通道服务器环境，不指定时默认为线上

Declared In

IMSConfiguration.h

`timeoutInterval`

API 通道请求超时时间，单位为秒，默认请求超时时间为10秒

@property (nonatomic, assign) NSUInteger timeoutInterval

Discussion

API 通道请求超时时间，单位为秒，默认请求超时时间为10秒

Declared In

IMSConfiguration.h

`+ initWithHost:serverEnv:`

初始化 API 通道配置信息

+ (void)initWithHost:(NSString *)host serverEnv:(IMSServerEnviroment)serverEnv

Parameters

`host`	指定 API 通道服务器域名
`serverEnv`	指定 API 通道服务器环境

Discussion

初始化 API 通道配置信息

Declared In

IMSConfiguration.h

`+ sharedInstance`

获取 API 通道配置信息单例，需要先调用方法 initWithHost:serverEnv: 进行初始化

+ (instancetype)sharedInstance

Return Value

API 通道配置信息实例

Discussion

获取 API 通道配置信息单例，需要先调用方法 initWithHost:serverEnv: 进行初始化

Declared In

IMSConfiguration.h

ContainingApp Methods

`– storeConfigToAppGroup:`

把配置信息写入对应AppGroup的共享内存区域中、调用该方法前、应该使用initWithHost:serverEnv:初始化

- (BOOL)storeConfigToAppGroup:(NSString *)appGroupName

Parameters

`appGroupName`	AppGroup的名称、可以通过该名称找到对应的共享内存区域

Return Value

成功返回 YES，失败返回 NO

Discussion

把配置信息写入对应AppGroup的共享内存区域中、调用该方法前、应该使用initWithHost:serverEnv:初始化

Declared In

IMSConfiguration+AppGroup.h

AppExtension Methods

`+ initWithAppGroupName:`

根据传入的AppGroup的名称、找到共享内存区域中存储的config信息、初始化 API 通道配置信息

+ (BOOL)initWithAppGroupName:(NSString *)appGroupName

Parameters

`appGroupName`	AppGroup的名称

Discussion

根据传入的AppGroup的名称、找到共享内存区域中存储的config信息、初始化 API 通道配置信息

Declared In

IMSConfiguration+AppGroup.h

`– synchronizeConfigFromAppGroup`

根据初始化之时传入的AppGroups的名称、从对应的共享内存区域中更新配置信息。

- (void)synchronizeConfigFromAppGroup

Discussion

根据初始化之时传入的AppGroups的名称、从对应的共享内存区域中更新配置信息。

Declared In

IMSConfiguration+AppGroup.h