Class SubscriptionGambit

Hierarchy (View Summary)

BooleanGambit
- SubscriptionGambit

Index

Constructors

Methods

enabled filterKey fromFilter key toFilter

Constructors

constructor

new SubscriptionGambit(): SubscriptionGambit
Returns SubscriptionGambit
Inherited from BooleanGambit.constructor

Methods

enabled

enabled(): boolean
Whether this gambit can be used by the actor.

Returns boolean
Overrides BooleanGambit.enabled
- Defined in extensions/subscriptions/js/src/common/query/discussions/SubscriptionGambit.ts:28

filterKey

filterKey(): string
This is the server standardised filter key for this gambit. The filter key must not be localized.

Returns string
Overrides BooleanGambit.filterKey
- Defined in extensions/subscriptions/js/src/common/query/discussions/SubscriptionGambit.ts:20

fromFilter

fromFilter(value: string, negate: boolean): string
This is the method to transform a filter into a gambit format. The gambit format can be localized.
Parameters
- value: string
- negate: boolean
Returns string
Overrides BooleanGambit.fromFilter
- Defined in extensions/subscriptions/js/src/common/query/discussions/SubscriptionGambit.ts:24

key

key(): string[]
Returns string[]
Overrides BooleanGambit.key
- Defined in extensions/subscriptions/js/src/common/query/discussions/SubscriptionGambit.ts:5

toFilter

toFilter(matches: string[], negate: boolean): Record<string, any>
This is the method to transform a gambit into a filter format.
Parameters
- matches: string[]
- negate: boolean
Returns Record<string, any>
Overrides BooleanGambit.toFilter
- Defined in extensions/subscriptions/js/src/common/query/discussions/SubscriptionGambit.ts:12