### Hierarchy

- HivemindAPI

## Index

### Constructors

- constructor

### Properties

- client

### Methods

- call
- getAccountNotifications
- getAccountPosts
- getCommunity
- getRankedPosts
- listAllSubscriptions
- listCommunities

## Constructors

### constructor

- new HivemindAPI(client: Client): HivemindAPI

- - Defined in helpers/hivemind.ts:79

  #### Parameters

  - ##### client: Client

  #### Returns HivemindAPI

## Properties

### client

client: Client

- Defined in helpers/hivemind.ts:80

## Methods

### call

- call(method: string, params?: any): Promise<any>

- - Defined in helpers/hivemind.ts:87

  Convenience of calling hivemind api

  #### Parameters

  - ##### method: string

  - ##### Optional params: any

  #### Returns Promise<any>

### getAccountNotifications

- getAccountNotifications(options?: AccountNotifsQuery): Promise<Notifications[]>

- - Defined in helpers/hivemind.ts:129

  Get particular account notifications feed

  #### Parameters

  - ##### Optional options: AccountNotifsQuery

  #### Returns Promise<Notifications[]>

### getAccountPosts

- getAccountPosts(options: AccountPostsQuery): Promise<Discussion[]>

- - Defined in helpers/hivemind.ts:103

  Get posts by particular account from Hivemind

  #### Parameters

  - ##### options: AccountPostsQuery

  #### Returns Promise<Discussion[]>

### getCommunity

- getCommunity(options: CommunityQuery): Promise<CommunityDetail[]>

- - Defined in helpers/hivemind.ts:112

  Get community details such as who are the admin, moderators, how many subscribers, etc..

  #### Parameters

  - ##### options: CommunityQuery

  #### Returns Promise<CommunityDetail[]>

### getRankedPosts

- getRankedPosts(options: PostsQuery): Promise<Discussion[]>

- - Defined in helpers/hivemind.ts:95

  Get trending, hot, recent community posts from Hivemind

  #### Parameters

  - ##### options: PostsQuery

  #### Returns Promise<Discussion[]>

### listAllSubscriptions

- listAllSubscriptions(account: Account["name"] | object): Promise<Discussion[]>

- - Defined in helpers/hivemind.ts:121

  List all subscriptions by particular account

  #### Parameters

  - ##### account: Account["name"] | object

    the account you want to query

  #### Returns Promise<Discussion[]>

  return role, what community the account joined

### listCommunities

- listCommunities(options: ListCommunitiesQuery): Promise<CommunityDetail[]>

- - Defined in helpers/hivemind.ts:137

  List all available communities on hivemind

  #### Parameters

  - ##### options: ListCommunitiesQuery

  #### Returns Promise<CommunityDetail[]>

Generated using TypeDoc