Class CallbackApi

Hierarchy

BaseApi
- CallbackApi

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new CallbackApi(api: DCoreApi): CallbackApi

Overrides BaseApi.constructor
- Defined in api/rx/CallbackApi.ts:10
Parameters
- api: DCoreApi
Returns CallbackApi

Properties

Protected api

Methods

cancelAll

cancelAll(): Observable<void>

- Defined in api/rx/CallbackApi.ts:18
Stop receiving any notifications. This unsubscribes from all subscribed objects (onGlobal and AccountApi.getFullAccounts).

Returns Observable<void>

onBlockApplied

onBlockApplied(): Observable<object>

- Defined in api/rx/CallbackApi.ts:25
Receive new block notifications. Cannot be cancelled.

Returns Observable<object>

onContentUpdate

onContentUpdate(uri: string): Observable<object>

- Defined in api/rx/CallbackApi.ts:34
Receive notifications on content update. Cannot be cancelled.

Parameters
- uri: string
  
  content URI to monitor
Returns Observable<object>

onGlobal

onGlobal(clearFilter: boolean): Observable<object>

- Defined in api/rx/CallbackApi.ts:50
Subscribe to callbacks. Can be cancelled. with [cancelAll].

Parameters
- clearFilter: boolean
  
  clear current subscriptions created with AccountApi.getFullAccounts
Returns Observable<object>

onPendingTransaction

onPendingTransaction(): Observable<object>

- Defined in api/rx/CallbackApi.ts:41
Receive notifications on pending transactions. Cannot be cancelled.

Returns Observable<object>

Protected request

request<T>(request: BaseRequest<T> | BaseRequest<T> & WithCallback): Observable<T>

Inherited from BaseApi.request
- Defined in api/rx/BaseApi.ts:12
Type parameters
- T
Parameters
- request: BaseRequest<T> | BaseRequest<T> & WithCallback
Returns Observable<T>

Generated using TypeDoc