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.

See Also

Creating and Initializing Strings

init()

Returns an initialized NSString object that contains no characters.

init?(bytes: UnsafeRawPointer, length: Int, encoding: UInt)

Returns an initialized NSString object containing a given number of bytes from a given buffer of bytes interpreted in a given encoding.

init?(bytesNoCopy: UnsafeMutableRawPointer, length: Int, encoding: UInt, freeWhenDone: Bool)

Returns an initialized NSString object that contains a given number of bytes from a given buffer of bytes interpreted in a given encoding, and optionally frees the buffer.

init(characters: UnsafePointer<unichar>, length: Int)

Returns an initialized NSString object that contains a given number of characters from a given C array of UTF-16 code units.

init(charactersNoCopy: UnsafeMutablePointer<unichar>, length: Int, freeWhenDone: Bool)

Returns an initialized NSString object that contains a given number of characters from a given C array of UTF-16 code units.

init(string: String)

Returns an NSString object initialized by copying the characters from another given string.

init?(cString: UnsafePointer<Int8>, encoding: UInt)

Returns an NSString object initialized using the characters in a given C array, interpreted according to a given encoding.

init?(utf8String: UnsafePointer<Int8>)

Returns an NSString object initialized by copying the characters from a given C array of UTF8-encoded bytes.

init(format: String, arguments: CVaListPointer)

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted without any localization. This method is meant to be called from within a variadic function, where the argument list will be available.

init(format: String, locale: Any?, arguments: CVaListPointer)

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted according to given locale information. This method is meant to be called from within a variadic function, where the argument list will be available.

init?(data: Data, encoding: UInt)

Returns an NSString object initialized by converting given data into UTF-16 code units using a given encoding.