View on GitHub
Install in Dash
SubscriptionApi Protocol Reference
SubscriptionApi
public protocol SubscriptionApi : BaseApiUndocumented
-
get(byId:)Default implementationGet a subscription object by id.
Throws
DCoreException.Network.notFoundif subscription does not exist.Default Implementation
Declaration
Swift
func get(byId id: ObjectIdConvertible) -> Single<Subscription>Parameters
idSubscription object id, eg. 2.15.*, as
SubscriptionObjectIdorStringformat.Return Value
Subscriptionobject. -
getAllActive(byConsumerId:limit:)Default implementationCheck if the account exist.
Default Implementation
Declaration
Swift
func getAllActive(byConsumerId id: AccountObjectIdConvertible, limit: Int) -> Single<[Subscription]>Parameters
idConsumer account object id, eg. 1.2.*, as
AccountObjectIdorStringformat.limitMaximum number of subscription objects to fetch, must not exceed 100.
Return Value
trueif account exist. -
getAllActive(byAuthorId:limit:)Default implementationCheck if the account exist.
Default Implementation
Declaration
Swift
func getAllActive(byAuthorId id: AccountObjectIdConvertible, limit: Int) -> Single<[Subscription]>Parameters
idAuthor account object id, eg. 1.2.*, as
AccountObjectIdorStringformat.limitMaximum number of subscription objects to fetch, must not exceed 100.
Return Value
trueif account exist. -
getAll(byConsumerId:limit:)Default implementationCheck if the account exist.
Default Implementation
Declaration
Swift
func getAll(byConsumerId id: AccountObjectIdConvertible, limit: Int) -> Single<[Subscription]>Parameters
idConsumer account object id, eg. 1.2.*, as
AccountObjectIdorStringformat.limitMaximum number of subscription objects to fetch, must not exceed 100.
Return Value
trueif account exist. -
getAll(byAuthorId:limit:)Default implementationCheck if the account exist.
Default Implementation
Declaration
Swift
func getAll(byAuthorId id: AccountObjectIdConvertible, limit: Int) -> Single<[Subscription]>Parameters
idAuthor account object id, eg. 1.2.*, as
AccountObjectIdorStringformat.limitMaximum number of subscription objects to fetch, must not exceed 100.
Return Value
trueif account exist.