Skip to main content
Table of Contents

TTMSFNCWebPushSender.SendNotificationById Method

Sends a raw JSON payload to every active subscription of a user using default delivery options. Requires an assigned subscription store.

API unit family: TMS.TMSFNCWebPushSender Declaring type: TTMSFNCWebPushSender Inherited from: TTMSFNCCustomWebPushSender

Overloads

Overload 1

Sends a raw JSON payload to every active subscription of a user using default delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, APayLoad: string); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString APayLoad)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
APayLoad JSON payload string to send.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 2

Sends a raw JSON payload to every active subscription of a user using the specified delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, APayLoad: string; AMessageSettings: TTMSFNCWebPushMessageSettings); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString APayLoad, const TTMSFNCWebPushMessageSettings &AMessageSettings)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
APayLoad JSON payload string to send.
AMessageSettings Urgency and topic options for this message.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 3

Sends a notification with title, body, icon, and activation URL to every active subscription of a user using default delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, ATitle, ABody, AIconURL, AURL: string); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString ATitle, const System::UnicodeString ABody, const System::UnicodeString AIconURL, const System::UnicodeString AURL)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
ATitle Notification title.
ABody Notification body text.
AIconURL URL of the notification icon image.
AURL URL opened when the recipient activates the notification.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 4

Sends a notification with title, body, icon, and activation URL to every active subscription of a user using the specified delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, ATitle, ABody, AIconURL, AURL: string; AMessageSettings: TTMSFNCWebPushMessageSettings); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString ATitle, const System::UnicodeString ABody, const System::UnicodeString AIconURL, const System::UnicodeString AURL, const TTMSFNCWebPushMessageSettings &AMessageSettings)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
ATitle Notification title.
ABody Notification body text.
AIconURL URL of the notification icon image.
AURL URL opened when the recipient activates the notification.
AMessageSettings Urgency and topic options for this message.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 5

Sends a fully composed notification object to every active subscription of a user using default delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID: string; APayLoad: TTMSFNCWebPushNotification); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, TTMSFNCWebPushNotification* APayLoad)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
APayLoad Notification to serialize and send.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 6

Sends a fully composed notification object to every active subscription of a user using the specified delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID: string; APayLoad: TTMSFNCWebPushNotification; AMessageSettings: TTMSFNCWebPushMessageSettings); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, TTMSFNCWebPushNotification* APayLoad, const TTMSFNCWebPushMessageSettings &AMessageSettings)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
APayLoad Notification to serialize and send.
AMessageSettings Urgency and topic options for this message.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 7

Sends a raw JSON payload to the active subscription matching a specific user and browser using default delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, ABrowserID, APayLoad: string); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString ABrowserID, const System::UnicodeString APayLoad)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
ABrowserID Identifier of the target browser.
APayLoad JSON payload string to send.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 8

Sends a raw JSON payload to the active subscription matching a specific user and browser using the specified delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, ABrowserID, APayLoad: string; AMessageSettings: TTMSFNCWebPushMessageSettings); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString ABrowserID, const System::UnicodeString APayLoad, const TTMSFNCWebPushMessageSettings &AMessageSettings)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
ABrowserID Identifier of the target browser.
APayLoad JSON payload string to send.
AMessageSettings Urgency and topic options for this message.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 9

Sends a notification with title, body, icon, and activation URL to the active subscription matching a specific user and browser using default delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, ABrowserID, ATitle, ABody, AIconURL, AURL: string); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString ABrowserID, const System::UnicodeString ATitle, const System::UnicodeString ABody, const System::UnicodeString AIconURL, const System::UnicodeString AURL)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
ABrowserID Identifier of the target browser.
ATitle Notification title.
ABody Notification body text.
AIconURL URL of the notification icon image.
AURL URL opened when the recipient activates the notification.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 10

Sends a notification with title, body, icon, and activation URL to the active subscription matching a specific user and browser using the specified delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, ABrowserID, ATitle, ABody, AIconURL, AURL: string; AMessageSettings: TTMSFNCWebPushMessageSettings); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString ABrowserID, const System::UnicodeString ATitle, const System::UnicodeString ABody, const System::UnicodeString AIconURL, const System::UnicodeString AURL, const TTMSFNCWebPushMessageSettings &AMessageSettings)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
ABrowserID Identifier of the target browser.
ATitle Notification title.
ABody Notification body text.
AIconURL URL of the notification icon image.
AURL URL opened when the recipient activates the notification.
AMessageSettings Urgency and topic options for this message.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 11

Sends a fully composed notification object to the active subscription matching a specific user and browser using default delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, ABrowserID: string; const APayLoad: TTMSFNCWebPushNotification); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString ABrowserID, TTMSFNCWebPushNotification* const APayLoad)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
ABrowserID Identifier of the target browser.
APayLoad Notification to serialize and send.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.

Overload 12

Sends a fully composed notification object to the active subscription matching a specific user and browser using the specified delivery options. Requires an assigned subscription store.

TMS.TMSFNCWebPushSender.hppPascalC++
procedure SendNotificationById(const AUserID, ABrowserID: string; const APayLoad: TTMSFNCWebPushNotification; AMessageSettings: TTMSFNCWebPushMessageSettings); overload;

void __fastcall SendNotificationById(const System::UnicodeString AUserID, const System::UnicodeString ABrowserID, TTMSFNCWebPushNotification* const APayLoad, const TTMSFNCWebPushMessageSettings &AMessageSettings)/* overload */;

Parameters

Name Description
AUserID Identifier of the target user.
ABrowserID Identifier of the target browser.
APayLoad Notification to serialize and send.
AMessageSettings Urgency and topic options for this message.

Exceptions

Exception Description
EWebPush Raised when no subscription store is assigned.