NSUserDefaults

用于持久化存储少量用户/插件配置。通过 NSUserDefaults.standardUserDefaults() 获取标准实例。适合保存开关、计数、字符串等简单类型。

类成员 (Class members)

standardUserDefaults

获取标准用户默认设置实例。

static standardUserDefaults(): NSUserDefaults

Return Value:

• NSUserDefaults: 单例对象。

实例成员 (Instance members)

写入

setObjectForKey

存储任意对象（为字符串、数字、数组、字典等可序列化类型）。

setObjectForKey(value: any, key: string): void

Parameters:

setIntegerForKey

存储整数。

setIntegerForKey(value: number, key: string): void

Parameters:

setFloatForKey

存储浮点数。

setFloatForKey(value: number, key: string): void

Parameters:

setDoubleForKey

存储双精度浮点数。

setDoubleForKey(value: number, key: string): void

Parameters:

setBoolForKey

存储布尔值。

setBoolForKey(value: boolean, key: string): void

Parameters:

setURLForKey

存储 URL。

setURLForKey(url: NSURL, key: string): void

Parameters:

读取

objectForKey

读取任意对象。

objectForKey(key: string): any

Parameters:

Return Value:

• any: 存储的对象（若不存在则返回 undefined/null）。

stringForKey

读取字符串。

stringForKey(key: string): string | null

Return Value:

• string | null: 字符串值。

arrayForKey

读取数组。

arrayForKey(key: string): NSArray | null

Return Value:

• NSArray | null: 数组对象。

dictionaryForKey

读取字典。

dictionaryForKey(key: string): NSDictionary | null

Return Value:

• NSDictionary | null: 字典对象。

dataForKey

读取二进制数据。

dataForKey(key: string): NSData | null

Return Value:

• NSData | null: 数据对象。

stringArrayForKey

读取字符串数组。

stringArrayForKey(key: string): string[] | null

Return Value:

• string[] | null: 字符串数组。

integerForKey

读取整数。

integerForKey(key: string): number

Return Value:

• number: 整数值（若不存在默认返回 0）。

floatForKey

读取浮点数。

floatForKey(key: string): number

Return Value:

• number: 浮点数值。

doubleForKey

读取双精度浮点数。

doubleForKey(key: string): number

Return Value:

• number: 双精度数值。

boolForKey

读取布尔值。

boolForKey(key: string): boolean

Return Value:

• boolean: 布尔值（若不存在默认返回 false）。

URLForKey

读取 URL。

URLForKey(key: string): NSURL | null

Return Value:

• NSURL | null: URL 对象。

其他

removeObjectForKey

移除指定键的值。

removeObjectForKey(key: string): void

Parameters:

synchronize

强制立即写入磁盘。

synchronize(): boolean

Return Value:

• boolean: 是否写入成功。

Note: 系统默认会自动保存，仅在需要立即持久化时调用。

registerDefaults

注册默认值（在未设置值时生效）。

registerDefaults(registrationDictionary: NSDictionary): void

Parameters:

相关

• 教程：存储与文件、Cookbook：插件设置页