TMS FNC Push Notifications API Reference

Use this reference for exact Delphi API contracts. Start from the component pages for purpose, setup, and task guides; use the class and member pages here for signatures, defaults, behavior notes, and event contracts.

Entry Points

Route	Use when
Components	You want component purpose, screenshots, guide links, and the component API map.
Product guides	You want cross-cutting workflows before drilling into component APIs.
Product overview	You want frameworks, dependencies, IDE support, and release notes.

Component Summary

Component	Use for
TMS FNC Web Push DB	Dataset-backed subscription store that persists browser push subscriptions and exposes an enumerable collection for use by the sender.
TMS FNC Web Push Sender	Component that signs and delivers Web Push Protocol notifications to subscribed browsers using VAPID authentication.
TMS FNC Web Push Server	HTTP(S) server component that accepts browser subscription registrations and manages the VAPID public key endpoint.

API By Component

TMS FNC Web Push DB

Classes And Records

Type	Description
`TTMSFNCCustomWebPushDB`	Stores push subscriptions in a dataset and exposes operations to add, update, delete, find, and iterate them. Acts as the base class for the published subscription store component.
`TTMSFNCWebPushDB`	Component that stores and manages push subscriptions in a dataset. Exposes the data source, field mapping, delete mode, and lifecycle events for design-time and run-time configuration.
`TTMSFNCWebPushDBEnumerator`	Iterates over the stored subscriptions, yielding one record per row in the underlying dataset. Enables `for ... in` iteration over the subscription store.
`TTMSFNCWebPushDBFields`	Maps the logical subscription values to the column names used in the underlying dataset and selects which optional columns are active.
`TTMSFNCWebPushSubscriptionEnum`	Holds a single subscription record returned while iterating the subscription store, combining the identifying values with the subscription payload.

Type	Kind	Description
`TTMSFNCWebPushDBBeforeSubscriptionEvent`	Event type	Signals that a subscription operation is about to run and lets the handler approve or veto it.
`TTMSFNCWebPushDBDeleteMode`	Enum	Selects how a subscription is removed from the store.
`TTMSFNCWebPushDBOptionalField`	Enum	Identifies an optional column that the subscription store can maintain in addition to the always-present endpoint and key columns.
`TTMSFNCWebPushDBOptionalFields`	Type alias	Set of optional columns that are active for the subscription store. A column is only read or written when its corresponding value is present in the set.
`TTMSFNCWebPushDBSubscriptionEvent`	Event type	Signals that a subscription operation has completed.

TMS FNC Web Push Sender

Classes And Records

Type	Description
`TTMSFNCCustomWebPushSender`	Base sender that delivers web push notifications to subscribed clients. It signs each request with the configured authentication keys and claims, resolves recipients from an attached subscription store, and reports delivery results through its events. Use the published TTMSFNCWebPushSender descendant on a form or data module.
`TTMSFNCWebPushMessageSettings`	Holds per-message delivery options applied when sending a notification.
`TTMSFNCWebPushNotification`	Describes the content and display options of a push notification message. Build an instance, set the desired properties, and pass it to a send method to deliver a fully customized notification.
`TTMSFNCWebPushNotificationClaims`	Holds the claims embedded in the signed authentication token (VAPID JWT) presented to the push service: the contact subject and the token expiration window.
`TTMSFNCWebPushSender`	Component that sends web push notifications to subscribed clients. Drop it on a form or data module, assign the authentication settings, claims, and subscription store, then call one of the send methods to deliver a notification to a single recipient, a specific user, or all subscribers.

Type	Kind	Description
`TTMSFNCWebPushBeforeSendNotificationEvent`	Event type	Fires just before each notification is sent, allowing the handler to inspect the target and cancel delivery to that recipient.
`TTMSFNCWebPushMessageUrgency`	Enum	Specifies the delivery urgency hint sent to the push service, allowing it to balance battery life and timeliness on the receiving device.
`TTMSFNCWebPushNotificationDirection`	Enum	Specifies the text direction used to display a notification.
`TTMSFNCWebPushNotificationErrorEvent`	Event type	Fires when the push service rejects a notification for a recipient, letting the handler decide whether the failed subscription is removed.
`TTMSFNCWebPushNotificationSentEvent`	Event type	Fires after a notification is accepted by the push service for a recipient. The handler is informational and cannot alter delivery.
`TTMSFNCWebPushSenderCreateIOHandlerEvent`	Event type	Fires when an HTTP IO handler is needed, letting the handler supply a custom secure transport instead of the built-in default.

TMS FNC Web Push Server

Classes And Records

Type	Description
`TTMSFNCCustomWebPushServer`	Base class for the web push application server. Hosts an HTTP and HTTPS listener that exposes the endpoints clients use to obtain the public application server key, register, update, and remove subscriptions, and activate or deactivate users.
`TTMSFNCWebPushRequestPath`	Defines the URL path segments the server listens on for each push subscription and user state operation.
`TTMSFNCWebPushSSLCertPath`	Holds the file paths to the SSL certificate, private key, and root certificate used to secure the server's HTTPS connections.
`TTMSFNCWebPushServer`	Web push application server component that exposes the endpoints clients use to obtain the public application server key and to register, update, remove, and (de)activate push subscriptions.
`TTMSFNCWebPushSubscription`	Holds the connection details a client browser returns when it subscribes to web push notifications. These values identify the push endpoint and provide the cryptographic material needed to encrypt messages for that subscriber.
`TTMSFNCWebPushVapid`	Stores and manages the VAPID (Voluntary Application Server Identification) key pair used to authenticate the application server to a push service. Provides loading, generation, and persistence of the public and private keys.

Type	Kind	Description
`TTMSFNCWebPushServerCreateIOHandlerEvent`	Event type	Event triggered while the server is constructed, allowing a custom secure connection handler to be supplied.
`TTMSFNCWebPushServerHTTPCommandEvent`	Event type	Event triggered for every incoming HTTP request before the built-in endpoint dispatching runs.
`TTMSFNCWebPushServerQuerySSLPortEvent`	Event type	Event triggered to decide whether a given listening port must use a secure connection.
`TTMSFNCWebPushServerSubscriptionEvent`	Event type	Event triggered when a subscription register, unregister, or update request arrives, allowing custom processing of the request payload.
`TTMSFNCWebPushServerUserActiveEvent`	Event type	Event triggered when a request changes whether a user is active or inactive, allowing custom processing of the request payload.

See Also