Class ScopedSubscriptionListEditor

Scoped subscription list editor.

Hierarchy

ScopedSubscriptionListEditor

Index

Constructors

Properties

onApply operations

Methods

apply subscribe unsubscribe

Constructors

constructor

new ScopedSubscriptionListEditor(onApply: ((operations: ScopedSubscriptionListOperation[]) => Promise<void>)): ScopedSubscriptionListEditor
Parameters
- onApply: ((operations: ScopedSubscriptionListOperation[]) => Promise<void>)
  - - (operations: ScopedSubscriptionListOperation[]): Promise<void>
    - Parameters
      
      operations: ScopedSubscriptionListOperation[]
      
      Returns Promise<void>
Returns ScopedSubscriptionListEditor
- Defined in ScopedSubscriptionListEditor.ts:46

Properties

onApply

onApply: ((operations: ScopedSubscriptionListOperation[]) => Promise<void>)

Type declaration

- (operations: ScopedSubscriptionListOperation[]): Promise<void>
- Parameters
  - operations: ScopedSubscriptionListOperation[]
  Returns Promise<void>

operations

operations: ScopedSubscriptionListOperation[]

Methods

apply

apply(): Promise<void>
Applies subscription list changes.

Returns Promise<void>
- Defined in ScopedSubscriptionListEditor.ts:93

subscribe

subscribe(subscriptionListId: string, scope: SubscriptionScope): ScopedSubscriptionListEditor
Subscribes to a list in the given scope.

Returns
The editor.
Parameters
- subscriptionListId: string
  
  The subscription list identifier.
- scope: SubscriptionScope
  
  The subscription scope to subscribe.
Returns ScopedSubscriptionListEditor
- Defined in ScopedSubscriptionListEditor.ts:62

unsubscribe

unsubscribe(subscriptionListId: string, scope: SubscriptionScope): ScopedSubscriptionListEditor
Unsubscribe from a list.

Returns
The editor.
Parameters
- subscriptionListId: string
  
  The subscription list identifier.
- scope: SubscriptionScope
  
  The subscription scope to unsubscribe.
Returns ScopedSubscriptionListEditor
- Defined in ScopedSubscriptionListEditor.ts:79

Generated using TypeDoc