PushConfiguration

The storage implementation to use for Push credentials and notifications.

If nil, a default PushKeychainStorage will be created and used. Custom storage implementations must conform to the PushStorage protocol.

Example

config.storage = MyCustomPushStorage()

The policy evaluator to use for credential policy validation.

If nil, default policies from PingCommons will be used.

If nil, default policies from PingCommons will be used. Policy evaluators check for device security issues like jailbreak detection, debugger attachment, and other security concerns.

Example

config.policyEvaluator = MyCustomPolicyEvaluator()

Whether data encryption is enabled for storage.

When enabled, sensitive data (credentials, shared secrets) will be encrypted before being stored in the Keychain. This provides an additional layer of security.

Default value is true for enhanced security.

The timeout for network operations in milliseconds.

This timeout applies to all network requests made by the Push client, including registration, authentication, and device token updates.

Default value is 15000 milliseconds (15 seconds).

Example

config.timeoutMs = 30000  // 30 seconds

Whether to enable in-memory caching of credentials.

By default, this is disabled for security reasons. When enabled, credentials are cached in memory to reduce Keychain access overhead. However, this means credentials could potentially be accessed from memory dumps by an attacker.

Default value is false.

Security Note

Only enable this if you understand the security implications and your threat model allows for in-memory credential storage.

The logger instance used for logging messages.

If nil, no logging will be performed. When set, the Push client will log important events, errors, and debug information using this logger.

Example

config.logger = PingLogger(logLevel: .debug)

Map of custom PushHandlers that will be used along with default handlers.

The key is the platform identifier (e.g., “PING_AM”, “CUSTOM_PLATFORM”), and the value is the handler implementation conforming to PushHandler protocol.

Custom handlers allow you to extend the Push client to support additional push notification platforms beyond the built-in PingAM support.

Default value is an empty dictionary.

Example

config.customPushHandlers = [
    "MY_PLATFORM": MyCustomPushHandler()
]

Configuration for automatic cleanup of push notifications.

This determines how old or excessive notifications are automatically removed to manage storage. The cleanup can happen automatically when processing new notifications, or manually by calling cleanup methods.

Default value uses count-based cleanup with a maximum of 100 notifications.

Example

// Keep only 50 notifications
config.notificationCleanupConfig = .countBased(maxNotifications: 50)

// Remove notifications older than 7 days
config.notificationCleanupConfig = .ageBased(maxAgeDays: 7)

// Hybrid approach
config.notificationCleanupConfig = .hybrid(
    maxNotifications: 50,
    maxAgeDays: 14
)

Creates a new Push configuration with default values.

Use the build factory method instead for a more fluent configuration experience.

Creates a new instance of PushConfiguration with the provided configuration block.

This factory method provides a clean, DSL-style way to configure the Push client. The configuration block receives a PushConfiguration instance that can be customized before being returned.

Example

let config = PushConfiguration.build { config in
    config.storage = MyPushStorage()
    config.enableCredentialCache = false
    config.timeoutMs = 20000
    config.logger = PingLogger(logLevel: .info)
    config.notificationCleanupConfig = .hybrid(
        maxNotifications: 50,
        maxAgeDays: 14
    )
}

let client = try await PushClient.createClient(configuration: config)