Class SpecialSubscription
Extends
Subscription.
Defined in: SubscriptionClasses.jsm.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
SpecialSubscription(url, title)
Class for special filter subscriptions (user's filters)
|
| Field Attributes | Field Name and Description |
|---|---|
|
Filter types that should be added to this subscription by default
(entries should correspond to keys in SpecialSubscription.defaultsMap).
|
- Fields borrowed from class Subscription:
- disabled, filters, fixedTitle, title, url
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
SpecialSubscription.create(title)
Creates a new user-defined filter group.
|
| <static> |
SpecialSubscription.createForFilter(filter)
Creates a new user-defined filter group and adds the given filter to it.
|
|
isDefaultFor(filter)
Tests whether a filter should be added to this group by default
|
|
|
serialize(buffer)
See Subscription.serialize()
|
- Methods borrowed from class Subscription:
- serializeFilters, toString
Class Detail
SpecialSubscription(url, title)
Class for special filter subscriptions (user's filters)
- Parameters:
- {String} url
- see Subscription()
- {String} title Optional
- see Subscription()
Field Detail
{Array of String}
defaults
Filter types that should be added to this subscription by default
(entries should correspond to keys in SpecialSubscription.defaultsMap).
Method Detail
<static>
SpecialSubscription.create(title)
Creates a new user-defined filter group.
- Parameters:
- {String} title Optional
- title of the new filter group
<static>
{SpecialSubscription}
SpecialSubscription.createForFilter(filter)
Creates a new user-defined filter group and adds the given filter to it.
This group will act as the default group for this filter type.
- Parameters:
- {Filter} filter
{Boolean}
isDefaultFor(filter)
Tests whether a filter should be added to this group by default
- Parameters:
- {Filter} filter
- filter to be tested
- Returns:
- {Boolean}
serialize(buffer)
See Subscription.serialize()
- Parameters:
- buffer