Class SocialAPI`Internal`

The class that encapsulates the social API

Index

Constructors

Properties

Methods

getUser openModal

Constructors

constructor

new SocialAPI(api): SocialAPI
Parameters
- api: API
Returns SocialAPI
- Defined in src/api/social.ts:11

Properties

`Private` api

api: API

contacts

contacts: {
list: (() => Promise<Contact[]>);
subscribe: ((listener) => Promise<(() => Promise<BazaarMessage>)>);
} = ...

Contacts

Type declaration

list: (() => Promise<Contact[]>)
Lists contacts

Returns
a list of contacts
- - (): Promise<Contact[]>
  - Returns Promise<Contact[]>
subscribe: ((listener) => Promise<(() => Promise<BazaarMessage>)>)
Subscribes to contacts

Returns
an unsubscribe function
- - (listener): Promise<(() => Promise<BazaarMessage>)>
  - Parameters
    - listener: SubscribeListener<Contact>
    Returns Promise<(() => Promise<BazaarMessage>)>

Methods

getUser

getUser(query?): Promise<User>
Gets the user info for a given ID or handle.
Parameters
- query: {
  handle?: string;
  userId?: string;
  } = {}
  The ID or handle of the user, defaults to logged in user's ID.
  - Optional handle?: string
  - Optional userId?: string
Returns Promise<User>
- Defined in src/api/social.ts:31

openModal

openModal(withId?, onClose?): void
Opens the social modal
Parameters
- withId: ((userId) => void) = null
  - - (userId): void
    - Parameters
      userId: string
      Returns void
- onClose: (() => void) = null
  - - (): void
    - Returns void
Returns void
- Defined in src/api/social.ts:18