Class SubscriptionApi

Hierarchy

SubscriptionApi

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new SubscriptionApi(api: DCoreApi): SubscriptionApi

- Defined in api/promise/SubscriptionApi.ts:5
Parameters
- api: DCoreApi
Returns SubscriptionApi

Properties

Private api

Methods

get

get(id: ChainObject): Promise<Subscription>

- Defined in api/promise/SubscriptionApi.ts:16
Get a subscription object by ID.

Parameters
- id: ChainObject
  
  subscription object id, 2.15.*
Returns Promise<Subscription>

the subscription object corresponding to the provided ID, ObjectNotFoundError otherwise

getAllActiveByAuthor

getAllActiveByAuthor(author: ChainObject, count?: number): Promise<Subscription[]>

- Defined in api/promise/SubscriptionApi.ts:40
Get a list of active (not expired) subscriptions by account (author).

Parameters
- author: ChainObject
  
  author account object id, 1.2.*
- Default value count: number = 100
  
  maximum number of subscription objects to fetch (must not exceed 100)
Returns Promise<Subscription[]>

a list of active subscription objects

getAllActiveByConsumer

getAllActiveByConsumer(consumer: ChainObject, count?: number): Promise<Subscription[]>

- Defined in api/promise/SubscriptionApi.ts:28
Get a list of active (not expired) subscriptions by account (consumer).

Parameters
- consumer: ChainObject
  
  consumer account object id, 1.2.*
- Default value count: number = 100
  
  maximum number of subscription objects to fetch (must not exceed 100)
Returns Promise<Subscription[]>

a list of active subscription objects

getAllByAuthor

getAllByAuthor(author: ChainObject, count?: number): Promise<Subscription[]>

- Defined in api/promise/SubscriptionApi.ts:64
Get a list of subscriptions by account (author).

Parameters
- author: ChainObject
  
  author account object id, 1.2.*
- Default value count: number = 100
  
  maximum number of subscription objects to fetch (must not exceed 100)
Returns Promise<Subscription[]>

a list of subscription objects

getAllByConsumer

getAllByConsumer(consumer: ChainObject, count?: number): Promise<Subscription[]>

- Defined in api/promise/SubscriptionApi.ts:52
Get a list of subscriptions by account (consumer).

Parameters
- consumer: ChainObject
  
  consumer account object id, 1.2.*
- Default value count: number = 100
  
  maximum number of subscription objects to fetch (must not exceed 100)
Returns Promise<Subscription[]>

a list of subscription objects

Generated using TypeDoc