@PublicApi
public interface AttributeSubscriptionService
AttributeSubscriptionService
manages attribute subscriptions. A subscription allows the client to "watch" a particular
set of values, identified by a set of rows and attributes, retrieve updates to this set of values in versioned manner, and perform
background loading.
Subscriptions are kept in a cache and may be deleted / closed if not used or if there are too many subscriptions.
AttributeSubscription
Modifier and Type | Method and Description |
---|---|
AttributeSubscription |
createSubscription()
Creates a new empty subscription.
|
void |
dropSubscription(Long subscriptionId)
Deletes the subscription.
|
AttributeSubscription |
getSubscription(Long subscriptionId)
Retrieves a previously created subscription.
|
@NotNull AttributeSubscription createSubscription()
Creates a new empty subscription.
The subscription will be attached to the current user, and only that user will have the access to this subscription.
AttributeSubscription.changeSubscription(java.util.function.Consumer<com.almworks.jira.structure.api.attribute.subscription.AttributeSubscriptionPatch>)
@NotNull AttributeSubscription getSubscription(@Nullable Long subscriptionId) throws StructureException
AttributeSubscription.getSubscriptionId()
.subscriptionId
- subscription IDStructureException
- if the current user is not the owner of the specified subscription, or if the subscription with this ID is not foundvoid dropSubscription(@Nullable Long subscriptionId) throws StructureException
subscriptionId
- subscription IDStructureException
- if the current user is not the owner of the specified subscription, or if the subscription with this ID is not foundCopyright © 2023 ALM Works. All Rights Reserved.