Type Method

localizedUserNotificationString(forKey:arguments:)

Returns a localized string intended for display in a notification alert.

Declaration

class func localizedUserNotificationString(forKey key: String, arguments: [Any]?) -> String

Parameters

key

The key to use when looking up the string in the app’s Localizable.strings file.

arguments

An array of values to substitute for escaped characters in the string.

Return Value

A string whose value is created dynamically from a localized string resource. If a string resource corresponding to the specified key cannot be found, the returned string is empty.

Discussion

When configuring the content of a local notification using the User Notifications framework, use this method to create strings whose contents are stored in your app’s Localizable.strings file. When the notification is about to be displayed, the string object uses the key and arguments you specify to load the appropriate localized version of the string. If the localized string has any escaped character sequences—that is, special characters proceeded by a percent (%) sign—those character sequences are replaced by the values in the arguments parameter.

For information about how strings are formatted, see String Resources in Resource Programming Guide.