Web Push Server

Overview

TsgcWSServer_API_WebPush is a component that provides functionality for handling WebPush subscriptions. WebPush is a protocol for delivering real-time notifications to web applications that run in the browser. This component can be used to manage subscriptions and send notifications to subscribed clients. Find below the properties, events, and methods provided by TsgcWSServer_API_WebPush class, along with code examples that demonstrate how to use them.

At a glance

Features

• Native Delphi implementation with full ANSI/Unicode support.

Technical specification

Main properties

The principal published / public properties used to configure and drive the component. Consult the online help for the full list.

Main methods

The principal public methods exposed by the component.

Public events

The component exposes the following published events; consult the online help for full event-handler signatures.

Quick Start

Drop the component on a form, configure the properties below and activate it. The snippet that follows shows the typical TsgcWebPush_Client configuration sourced from the online help.

Delphi (VCL / FireMonkey)

procedure SendWebPushNotification;
    var
      oSubscription: TsgcHTTP_API_WebPush_PushSubscription;
      oWebPush: TsgcWebPush_Client ;
    begin
      oSubscription := TsgcHTTP_API_WebPush_PushSubscription.Create;
      try
        oSubscription.Endpoint := 'endpoint';
       oSubscription.PublicKey := 'public key';
        oSubscription.AuthSecret := 'authentication secret';
        oWebPush := TsgcHTTP_API_WebPush_Client.Create(nil);
        try
          oWebPush.VAPID.PEM.PrivateKey.Text := 'private_key_pem';
          oWebPush.VAPID.DER.PrivateKey := 'private_key';
          oWebPush.VAPID.DER.PublicKey := 'public_key';
          oWebPush.SendNotification(oSubscription, '{"title": "eSeGeCe Notification", "body": "Hello from eSeGeCe!!!"}');
        finally
          oWebPush.Free;
        end;
      finally
        oSubscription.Free;
      end;
    end;

C++ Builder

void SendWebPushNotification()
    {
        TsgcHTTP_API_WebPush_PushSubscription* oSubscription = new TsgcHTTP_API_WebPush_PushSubscription();
        try
        {
            oSubscription->Endpoint = "endpoint";
            oSubscription->PublicKey = "public key";
            oSubscription->AuthSecret = "authentication secret";
            TsgcHTTP_API_WebPush_Client* oWebPush = new TsgcHTTP_API_WebPush_Client(NULL);
            try
            {
                oWebPush->VAPID->PEM->PrivateKey->Text = "private_key_pem";
                oWebPush->VAPID->DER->PrivateKey = "private_key";
                oWebPush->VAPID->DER->PublicKey = "public_key";
                oWebPush->SendNotification(oSubscription, "{\"title\": \"eSeGeCe Notification\", \"body\": \"Hello from eSeGeCe!!!\"}");
            }
            __finally
            {
                oWebPush->Free();
            }
        }
        __finally
        {
            oSubscription->Free();
        }
    }

.NET (C#)

public void SendWebPushNotification()
    {
        var oSubscription = new TsgcHTTP_API_WebPush_PushSubscription();
        oSubscription.Endpoint = "endpoint";
        oSubscription.PublicKey = "public key";
        oSubscription.AuthSecret = "authentication secret";
        var oWebPush = new TsgcWebPush_Client();
        oWebPush.VAPID.PEM.PrivateKey.Text = "private_key_pem";
        oWebPush.VAPID.DER.PrivateKey = "private_key";
        oWebPush.VAPID.DER.PublicKey = "public_key";
        oWebPush.SendNotification(oSubscription, "{\"title\": \"eSeGeCe Notification\", \"body\": \"Hello from eSeGeCe!!!\"}");
    }

Sources used to build this document

Every external claim links back to a primary source. The online-help references decode the canonical deep-link the company maintains for this component.