register #

Registers a new realtime subscription on behalf of a client. The subscription works exactly like the one created by the realtime:subscribe action. The notifications will be sent to the connection identified by the connection identifier passed to the method.

Arguments #

register(connectionId: string, index: string, collection: string, filters: JSONObject): Promise<{ roomId: string }>

string

string

string

object

Return #

Resolves to the room ID associated with the registered subscription.

Example #

async subscribeToSomething(request) {
  const options = {};
  const roomId = await this.context.accessors.subscription.register(
    request.context.connection.id, 
    'myindex', 
    'mycollection', 
    {
      // subscription filters
    });
  return { roomId };
}

Use cases #

The most common use-case of this method is to implement the realtime subscriptions on the server-side. Instead of leaving the client-side with the freedom (and the responsibility) of specifying the filters for a subscription, you can open a custom API endpoint in your plugin and call accessors.subscription.register inside it by passing the incoming KuzzleRequest. When the client hits this endpoint, they will start receiving the notifications from the newly created subscription. This way, the client will only be aware of a subscribeToSomething business-specific endpoint, but won't see the set of filters the endpoint encapsulates.