Class HivemindAPI

constructor

• new HivemindAPI(client: Client): HivemindAPI

  Parameters

  • client: Client

  Returns HivemindAPI

Readonlyclient

call

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

  Convenience of calling hivemind api

  Parameters

  • method: string
  • Optionalparams: any

  Returns Promise<any>

getAccountNotifications

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

  Get particular account notifications feed

  Parameters

  • Optionaloptions: AccountNotifsQuery

  Returns Promise<Notifications[]>

getAccountPosts

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

  Get posts by particular account from Hivemind

  Parameters

  • options: AccountPostsQuery

  Returns Promise<Discussion[]>

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[]>

getRankedPosts

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

  Get trending, hot, recent community posts from Hivemind

  Parameters

  • options: PostsQuery

  Returns Promise<Discussion[]>

listAllSubscriptions

• listAllSubscriptions(account: string | object): Promise<Discussion[]>

  List all subscriptions by particular account

  Parameters

  • account: string | object

    the account you want to query

  Returns Promise<Discussion[]>

  return role, what community the account joined

listCommunities

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

  List all available communities on hivemind

  Parameters

  • options: ListCommunitiesQuery

  Returns Promise<CommunityDetail[]>