Wikibase
MediaWiki Wikibase extension
Wikibase\Client\Usage\SubscriptionManager Interface Reference

Service interface for tracking subscriptions of clients to entity change events generated on the repo. More...

+ Inheritance diagram for Wikibase\Client\Usage\SubscriptionManager:

Public Member Functions

 subscribe ( $subscriber, array $entityIds)
 Subscribes the given subscriber to notifications about changes on the specified entities. More...
 
 unsubscribe ( $subscriber, array $entityIds)
 Unsubscribes the given subscriber from notifications about changes on the specified entities. More...
 

Detailed Description

Service interface for tracking subscriptions of clients to entity change events generated on the repo.

See also
docs/usagetracking.wiki
Author
Daniel Kinzler

Member Function Documentation

◆ subscribe()

Wikibase\Client\Usage\SubscriptionManager::subscribe (   $subscriber,
array  $entityIds 
)

Subscribes the given subscriber to notifications about changes on the specified entities.

Parameters
string$subscriberGlobal site ID of the subscriber
EntityId[]$entityIdsThe entities to subscribe to.
Exceptions
UsageTrackerException

Implemented in Wikibase\Client\Usage\Sql\SqlSubscriptionManager, and Wikibase\Client\Usage\NullSubscriptionManager.

◆ unsubscribe()

Wikibase\Client\Usage\SubscriptionManager::unsubscribe (   $subscriber,
array  $entityIds 
)

Unsubscribes the given subscriber from notifications about changes on the specified entities.

Parameters
string$subscriberGlobal site ID of the subscriber
EntityId[]$entityIdsThe entities to subscribe to.
Exceptions
UsageTrackerException

Implemented in Wikibase\Client\Usage\Sql\SqlSubscriptionManager, and Wikibase\Client\Usage\NullSubscriptionManager.


The documentation for this interface was generated from the following file: