Class HivemindAPI

Hierarchy

HivemindAPI

Index

Constructors

Properties

Methods

call getAccountNotifications getAccountPosts getCommunity getRankedPosts listAllSubscriptions listCommunities

Constructors

constructor

new HivemindAPI(client: Client): HivemindAPI
Parameters
- client: Client
Returns HivemindAPI
- Defined in helpers/hivemind.ts:76

Properties

`Readonly` client

client: Client

Methods

call

call<T>(method: string, params?: any): Promise<T>
Convenience of calling hivemind api
Type Parameters
Type Parameters
- T
Parameters
- method: string
- Optional params: any
Returns Promise<T>
- Defined in helpers/hivemind.ts:83

getAccountNotifications

getAccountNotifications(options?: AccountNotifsQuery): Promise<Notification[]>
Get particular account notifications feed
Parameters
- Optional options: AccountNotifsQuery
Returns Promise<Notification[]>
- Defined in helpers/hivemind.ts:125

getAccountPosts

getAccountPosts(options: AccountPostsQuery): Promise<Discussion[]>
Get posts by particular account from Hivemind
Parameters
- options: AccountPostsQuery
Returns Promise<Discussion[]>
- Defined in helpers/hivemind.ts:99

getCommunity

getCommunity(options: CommunityQuery): Promise<CommunityDetail>
Get community details such as who are the admin, moderators, how many subscribers, etc..
Parameters
- options: CommunityQuery
Returns Promise<CommunityDetail>
- Defined in helpers/hivemind.ts:108

getRankedPosts

getRankedPosts(options: PostsQuery): Promise<Discussion[]>
Get trending, hot, recent community posts from Hivemind
Parameters
- options: PostsQuery
Returns Promise<Discussion[]>
- Defined in helpers/hivemind.ts:91

listAllSubscriptions

listAllSubscriptions(account: string | object): Promise<Discussion[]>
List all subscriptions by particular account

Returns
return role, what community the account joined
Parameters
- account: string | object
  
  the account you want to query
Returns Promise<Discussion[]>
- Defined in helpers/hivemind.ts:117

listCommunities

listCommunities(options: ListCommunitiesQuery): Promise<CommunityDetail[]>
List all available communities on hivemind
Parameters
- options: ListCommunitiesQuery
Returns Promise<CommunityDetail[]>
- Defined in helpers/hivemind.ts:133

Generated using TypeDoc