PayloadKit

Renew - Second Son Consulting

com.secondsonconsulting.renew

Renew Configuration

macOS

Configuration Keys (2)

KeyTypeDescriptionDefaultRange

Required Arguments

required
dictThere are four required arguments to make a valid Renew configuration.Default: —Range: —

Maximum number of deferrals

required
integerThis is the maximum number of deferrals a user receives before Renew enters "Aggressive" mode. Set to '-1' to disable deferrals.Default: —Range: -1 – —

Uptime Threshold

required
integerThe number of days which a device is online prior to the Renew experience starting.Default: —Range: 0 – —

Notification Threshold

required
integerThe number of times the user will get a macOS Notification Center event prior to the full Swift Dialog experience. Set to '-1' to configure an infinite threshold.Default: —Range: -1 – —

Deferral Duration

required
integerThe minimum number of hours between when a user is notified that they need to restart.Default: —Range: 0 – —

Optional Arguments

dictThere are a number of optional arguments to change Renew to look and act how you want.Default: —Range: —

Notification Action Enabled

booleanIf enabled, interacting with the notification will initiate a restart. Defaults to true.Default: trueRange: —

Notification Style

stringCorrelates with the --style option of Dialog. Defaults to pseudo-alert on Dialog 3.1 or newer, ignored on any older version.Default: —Range: Pseudo Alert (pseudo-alert), Pseudo Banner (pseudo-banner), Alert (alert), Banner (banner)
Titlestring

Title

stringThe title of your dialog windows and notifications. Maps to the swiftDialog option: --titleDefault: —Range: —

Aggressive Message

stringThe message body you want in your Aggressive Mode dialog windows. Maps to SwiftDialog option: --messageDefault: —Range: —

Normal Message

string—Default: —Range: —

Notification Message

stringThe message body you want in your Notification Center alerts. Maps to SwiftDialog option: --messageDefault: —Range: —

Notification Subtitle

stringThe subtitle field of your notifications. Maps to SwiftDialog option: --subtitleDefault: —Range: —

Deferral Button Text

stringWhat do you want your deferral button to say? Maps to SwiftDialog option: --button1textDefault: —Range: —

"No Deferrals Remaining" Button Text

stringWhat do you want your deferral button to say when it's greyed out in Aggressive Mode? Maps to SwiftDialog option: --button1textDefault: —Range: —

Restart Button Text

stringWhat do you want your "Restart Now" button to say? Maps to SwiftDialog option: --infobuttontextDefault: —Range: —

Show Deferral Count

booleanIf true, an additional sentence is added to your Normal Mode dialog windows indicating how many deferrals the user has remaining. Omit this key if you don't want the extra information.Default: —Range: —

Notification Icon

stringThis is the icon included on the right side of the Dialog Notification. Can be an app or a file path. Maps to SwiftDialog option: --iconDefault: —Range: —

Notification Icon Dark Mode

stringThis is the icon included on the right side of the Dialog Notification. Can be an app or a file path. Use this key if you have to differentiate between light and dark mode icons. Maps to SwiftDialog option: --iconDefault: —Range: —

Message Icon

stringThe icon used in your Normal and Aggressive Mode dialogs. Use "none" to disable. This can be a path to an image file, an app, or an SF symbol by using "SF=symbol.name". This maps to SwiftDialog option: --iconDefault: —Range: —

Message Icon Dark Mode

stringThe icon used in your Normal and Aggressive Mode dialogs. Use this key if you have to differentiate between light and dark mode icons.This can be a path to an image file, an app, or an SF symbol by using "SF=symbol.name". This maps to SwiftDialog option: --iconDefault: —Range: —

Banner Image

stringUse this key to designate a file path to a Banner Image for your Normal and Aggressive Mode dialog windows. Maps to SwiftDialog option: --bannerimageDefault: —Range: —

Banner Image Dark Mode

stringUse this key to designate a file path to a Banner Image for your Normal and Aggressive Mode dialog windows. Use this key if you have to differentiate between light and dark mode banners. Maps to SwiftDialog option: --bannerimageDefault: —Range: —

Additional Dialog Options

stringUse this key to pass additional options you want for all dialog events. See SwiftDialog documentation for advanced options.Default: —Range: —

Additional Aggressive Mode Options

stringUse this key to pass additional options you want for only Aggressive Mode dialog events. See SwiftDialog documentation for advanced options.Default: —Range: —

Additional Normal Options

stringUse this key to pass additional options you want for only Normal Mode dialog events. See SwiftDialog documentation for advanced options.Default: —Range: —

Additional Notification Options

stringUse this key to pass additional options you want for only Notification Mode dialog events. See SwiftDialog documentation for advanced options.Default: —Range: —

Applications to Ignore

arrayThe applications which Renew ignores when checking for display assertions. (You can specify one or more, EX: zoom.us firefox).Default: —Range: —
string

Applications

string—Default: —Range: —
Deadlineinteger

Deadline

integerUse this option to enable "Deadline" mode. If a device's uptime exceeds the "Deadline" value in days, Renew will enter Aggressive Mode regardless of the remaining deferrals.Default: —Range: —

Secret Quit Key

stringThis key in combination with the "Command" key will allow you to quit a dialog window without restarting. Cannot be set to Q! Omit this to leave the default combination (Cmd+]. Maps to SwiftDialog option --quitkeyDefault: —Range: —