One Logo Pool Ball
CloudKit · IOS API REFERENCE

CKSubscription.NotificationInfo

class · iOS 8.0+ · SDK 27.1

class NotificationInfo

Members (37)

get · iOS 8.0+

alertActionLocalizationKey

TypeScript
get alertActionLocalizationKey(): (string) | null
Swift declaration
var alertActionLocalizationKey: String? { get set }
set · iOS 8.0+

alertActionLocalizationKey

TypeScript
set alertActionLocalizationKey(value: (string) | null)
Swift declaration
var alertActionLocalizationKey: String? { get set }
get · iOS 8.0+

alertBody

TypeScript
get alertBody(): (string) | null
Swift declaration
var alertBody: String? { get set }
set · iOS 8.0+

alertBody

TypeScript
set alertBody(value: (string) | null)
Swift declaration
var alertBody: String? { get set }
get · iOS 8.0+

alertLaunchImage

TypeScript
get alertLaunchImage(): (string) | null
Swift declaration
var alertLaunchImage: String? { get set }
set · iOS 8.0+

alertLaunchImage

TypeScript
set alertLaunchImage(value: (string) | null)
Swift declaration
var alertLaunchImage: String? { get set }
get · iOS 8.0+

alertLocalizationKey

TypeScript
get alertLocalizationKey(): (string) | null
Swift declaration
var alertLocalizationKey: String? { get set }
set · iOS 8.0+

alertLocalizationKey

TypeScript
set alertLocalizationKey(value: (string) | null)
Swift declaration
var alertLocalizationKey: String? { get set }
get · iOS 9.0+

category

TypeScript
get category(): (string) | null
Swift declaration
var category: String? { get set }
set · iOS 9.0+

category

TypeScript
set category(value: (string) | null)
Swift declaration
var category: String? { get set }
get · iOS 11.0+

collapseIDKey

TypeScript
get collapseIDKey(): (string) | null
Swift declaration
var collapseIDKey: String? { get set }
set · iOS 11.0+

collapseIDKey

TypeScript
set collapseIDKey(value: (string) | null)
Swift declaration
var collapseIDKey: String? { get set }
get · iOS 8.0+

shouldBadge

TypeScript
get shouldBadge(): boolean
Swift declaration
var shouldBadge: Bool { get set }
set · iOS 8.0+

shouldBadge

TypeScript
set shouldBadge(value: boolean)
Swift declaration
var shouldBadge: Bool { get set }
get · iOS 8.0+

shouldSendContentAvailable

TypeScript
get shouldSendContentAvailable(): boolean
Swift declaration
var shouldSendContentAvailable: Bool { get set }
set · iOS 8.0+

shouldSendContentAvailable

TypeScript
set shouldSendContentAvailable(value: boolean)
Swift declaration
var shouldSendContentAvailable: Bool { get set }
get · iOS 11.0+

shouldSendMutableContent

TypeScript
get shouldSendMutableContent(): boolean
Swift declaration
var shouldSendMutableContent: Bool { get set }
set · iOS 11.0+

shouldSendMutableContent

TypeScript
set shouldSendMutableContent(value: boolean)
Swift declaration
var shouldSendMutableContent: Bool { get set }
get · iOS 8.0+

soundName

TypeScript
get soundName(): (string) | null
Swift declaration
var soundName: String? { get set }
set · iOS 8.0+

soundName

TypeScript
set soundName(value: (string) | null)
Swift declaration
var soundName: String? { get set }
get · iOS 11.0+

subtitle

TypeScript
get subtitle(): (string) | null
Swift declaration
var subtitle: String? { get set }
set · iOS 11.0+

subtitle

TypeScript
set subtitle(value: (string) | null)
Swift declaration
var subtitle: String? { get set }
get · iOS 11.0+

subtitleLocalizationKey

TypeScript
get subtitleLocalizationKey(): (string) | null
Swift declaration
var subtitleLocalizationKey: String? { get set }
set · iOS 11.0+

subtitleLocalizationKey

TypeScript
set subtitleLocalizationKey(value: (string) | null)
Swift declaration
var subtitleLocalizationKey: String? { get set }
get · iOS 11.0+

title

TypeScript
get title(): (string) | null
Swift declaration
var title: String? { get set }
set · iOS 11.0+

title

TypeScript
set title(value: (string) | null)
Swift declaration
var title: String? { get set }
get · iOS 11.0+

titleLocalizationKey

TypeScript
get titleLocalizationKey(): (string) | null
Swift declaration
var titleLocalizationKey: String? { get set }
set · iOS 11.0+

titleLocalizationKey

TypeScript
set titleLocalizationKey(value: (string) | null)
Swift declaration
var titleLocalizationKey: String? { get set }
get · iOS 8.0+

desiredKeys

TypeScript
get desiredKeys(): (Array<string>) | null
Swift declaration
var desiredKeys: [CKRecord.FieldKey]? { get set }

The names of fields to include in the push notification's payload. This property contains an array of strings, each of which corresponds to the name of a field in the record that triggers the notification. When the system receives a notification, it includes the keys and their corresponding values. You can request a maximum of three keys. For the keys you specify, the allowable types are <doc://com.apple.documentation/documentation/foundation/nsstring>, <doc://com.apple.documentation/documentation/foundation/nsnumber>, <doc://com.apple.documentation/documentation/corelocation/cllocation>, <doc://com.apple.documentation/documentation/foundation/nsdate>, and ``CKRecord/Reference``. You can't specify keys with values that contain other data types. CloudKit may truncate strings that are more than 100 characters when it adds them to the notification's payload.

set · iOS 8.0+

desiredKeys

TypeScript
set desiredKeys(value: (Array<string>) | null)
Swift declaration
var desiredKeys: [CKRecord.FieldKey]? { get set }

The names of fields to include in the push notification's payload. This property contains an array of strings, each of which corresponds to the name of a field in the record that triggers the notification. When the system receives a notification, it includes the keys and their corresponding values. You can request a maximum of three keys. For the keys you specify, the allowable types are <doc://com.apple.documentation/documentation/foundation/nsstring>, <doc://com.apple.documentation/documentation/foundation/nsnumber>, <doc://com.apple.documentation/documentation/corelocation/cllocation>, <doc://com.apple.documentation/documentation/foundation/nsdate>, and ``CKRecord/Reference``. You can't specify keys with values that contain other data types. CloudKit may truncate strings that are more than 100 characters when it adds them to the notification's payload.

get · iOS 8.0+

alertLocalizationArgs

TypeScript
get alertLocalizationArgs(): (Array<string>) | null
Swift declaration
var alertLocalizationArgs: [CKRecord.FieldKey]? { get set }

The fields for building a notification's alert. This property is an array of fields that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%@` for your substitution variables, CloudKit replaces those variables by traversing the array in order. If you use variables of the form `%n$@`, where `n` is an integer, `n` represents the index (starting at 1) of the item in the array to use. So, the first item in the array replaces the variable `%1$@`, the second item replaces the variable `%2$@`, and so on. You can use indexed substitution variables to change the order of items in the resulting string, which might be necessary when you localize your app's content.

set · iOS 8.0+

alertLocalizationArgs

TypeScript
set alertLocalizationArgs(value: (Array<string>) | null)
Swift declaration
var alertLocalizationArgs: [CKRecord.FieldKey]? { get set }

The fields for building a notification's alert. This property is an array of fields that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%@` for your substitution variables, CloudKit replaces those variables by traversing the array in order. If you use variables of the form `%n$@`, where `n` is an integer, `n` represents the index (starting at 1) of the item in the array to use. So, the first item in the array replaces the variable `%1$@`, the second item replaces the variable `%2$@`, and so on. You can use indexed substitution variables to change the order of items in the resulting string, which might be necessary when you localize your app's content.

get · iOS 11.0+

titleLocalizationArgs

TypeScript
get titleLocalizationArgs(): (Array<string>) | null
Swift declaration
var titleLocalizationArgs: [CKRecord.FieldKey]? { get set }

The fields for building a notification's title. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%@` for your substitution variables, CloudKit replaces those variables by traversing the array in order. If you use variables of the form `%n$@`, where `n` is an integer, `n` represents the index (starting at 1) of the item in the array to use. So, the first item in the array replaces the variable `%1$@`, the second item replaces the variable `%2$@`, and so on. You can use indexed substitution variables to change the order of items in the resulting string, which might be necessary when you localize your app's content.

set · iOS 11.0+

titleLocalizationArgs

TypeScript
set titleLocalizationArgs(value: (Array<string>) | null)
Swift declaration
var titleLocalizationArgs: [CKRecord.FieldKey]? { get set }

The fields for building a notification's title. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%@` for your substitution variables, CloudKit replaces those variables by traversing the array in order. If you use variables of the form `%n$@`, where `n` is an integer, `n` represents the index (starting at 1) of the item in the array to use. So, the first item in the array replaces the variable `%1$@`, the second item replaces the variable `%2$@`, and so on. You can use indexed substitution variables to change the order of items in the resulting string, which might be necessary when you localize your app's content.

get · iOS 11.0+

subtitleLocalizationArgs

TypeScript
get subtitleLocalizationArgs(): (Array<string>) | null
Swift declaration
var subtitleLocalizationArgs: [CKRecord.FieldKey]? { get set }

The fields for building a notification's subtitle. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%@` for your substitution variables, CloudKit replaces those variables by traversing the array in order. If you use variables of the form `%n$@`, where `n` is an integer, `n` represents the index (starting at 1) of the item in the array to use. So, the first item in the array replaces the variable `%1$@`, the second item replaces the variable `%2$@`, and so on. You can use indexed substitution variables to change the order of items in the resulting string, which might be necessary when you localize your app's content.

set · iOS 11.0+

subtitleLocalizationArgs

TypeScript
set subtitleLocalizationArgs(value: (Array<string>) | null)
Swift declaration
var subtitleLocalizationArgs: [CKRecord.FieldKey]? { get set }

The fields for building a notification's subtitle. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%@` for your substitution variables, CloudKit replaces those variables by traversing the array in order. If you use variables of the form `%n$@`, where `n` is an integer, `n` represents the index (starting at 1) of the item in the array to use. So, the first item in the array replaces the variable `%1$@`, the second item replaces the variable `%2$@`, and so on. You can use indexed substitution variables to change the order of items in the resulting string, which might be necessary when you localize your app's content.

init · iOS 8.0+

init

TypeScript
static init(alertBody?: (string) | null, alertLocalizationKey?: (string) | null, alertLocalizationArgs?: Array<string>, title?: (string) | null, titleLocalizationKey?: (string) | null, titleLocalizationArgs?: Array<string>, subtitle?: (string) | null, subtitleLocalizationKey?: (string) | null, subtitleLocalizationArgs?: Array<string>, alertActionLocalizationKey?: (string) | null, alertLaunchImage?: (string) | null, soundName?: (string) | null, desiredKeys?: Array<string>, shouldBadge?: boolean, shouldSendContentAvailable?: boolean, shouldSendMutableContent?: boolean, category?: (string) | null, collapseIDKey?: (string) | null): CKSubscription_NotificationInfo
Swift declaration
convenience init(alertBody: String? = nil, alertLocalizationKey: String? = nil, alertLocalizationArgs: [CKRecord.FieldKey] = [], title: String? = nil, titleLocalizationKey: String? = nil, titleLocalizationArgs: [CKRecord.FieldKey] = [], subtitle: String? = nil, subtitleLocalizationKey: String? = nil, subtitleLocalizationArgs: [CKRecord.FieldKey] = [], alertActionLocalizationKey: String? = nil, alertLaunchImage: String? = nil, soundName: String? = nil, desiredKeys: [CKRecord.FieldKey] = [], shouldBadge: Bool = false, shouldSendContentAvailable: Bool = false, shouldSendMutableContent: Bool = false, category: String? = nil, collapseIDKey: String? = nil)

Creates a notification with the specified values. - Parameters: - alertBody: The text for the notification's alert. - alertLocalizationKey: The key that identifies the localized string for the notification's alert. - alertLocalizationArgs: The fields for building a notification's alert. - title: The notification's title. - titleLocalizationKey: The key that identifies the localized string for the notification's title. - titleLocalizationArgs: The fields for building a notification's title. - subtitle: The notification's subtitle. - subtitleLocalizationKey: The key that identifies the localized string for the notification's subtitle. - subtitleLocalizationArgs: The fields for building a notification's subtitle. - alertActionLocalizationKey: The key that identifies the localized string for the notification's action. - alertLaunchImage: The filename of an image to use as a launch image. - soundName: The filename of the sound file to play when a notification arrives. - desiredKeys: The names of fields to include in the push notification's payload. - shouldBadge: A Boolean value that determines whether an app's icon badge increments its value. - shouldSendContentAvailable: A Boolean value that indicates whether the push notification includes the content available flag. - shouldSendMutableContent: A Boolean value that indicates whether the push notification includes the content available flag. - category: The name of the action group that corresponds to this notification. - collapseIDKey: The value that the system uses to coalesce unseen push notifications. See the corresponding properties for more details about each parameter.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CKSubscription.NotificationInfo.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All CloudKit types →