Class Client

api: public

Hierarchy

Client

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(opts?: OkunaOpts): Client

- Defined in Okuna.ts:34
Parameters
- Default value opts: OkunaOpts = {}
Returns Client

Properties

apiUrl

apiUrl: string

JavaScript API bindings for the Okuna social network

param

authToken

authToken: string | null

magicHeaderName

magicHeaderName: string | null | undefined

magicHeaderValue

magicHeaderValue: string | null | undefined

requestStrategy

requestStrategy: string | RequestStrategy

Methods

_buildMagicHeader

_buildMagicHeader(name: string | null | undefined, value: string | null | undefined): object

- Defined in Okuna.ts:53
_buildMagicHeader() - Builds a magic header to add to the request headers

Parameters
- name: string | null | undefined
  
  the name of the magic header
- value: string | null | undefined
  
  the value of the magic header
Returns object

an object containing the provided data
- name: undefined | null | string
- value: undefined | null | string

auth

auth(): AuthAPI

- Defined in Okuna.ts:79
auth()

Returns AuthAPI
- AuthAPI instance

categories

categories(): CategoriesAPI

- Defined in Okuna.ts:87
categories()

Returns CategoriesAPI
- CategoriesAPI instance

circles

circles(): CirclesAPI

- Defined in Okuna.ts:95
circles()

Returns CirclesAPI
- CirclesAPI instance

communities

communities(): CommunitiesAPI

- Defined in Okuna.ts:103
communities()

Returns CommunitiesAPI
- CommunitiesAPI instance

connections

connections(): ConnectionsAPI

- Defined in Okuna.ts:111
connections()

Returns ConnectionsAPI
- ConnectionsAPI instance

devices

devices(): DevicesAPI

- Defined in Okuna.ts:119
devices()

Returns DevicesAPI
- DevicesAPI instance

emojis

emojis(): EmojisAPI

- Defined in Okuna.ts:127
emojis()

Returns EmojisAPI
- EmojisAPI instance

follows

follows(): FollowsAPI

- Defined in Okuna.ts:135
follows()

Returns FollowsAPI
- FollowsAPI instance

hashtags

hashtags(): HashtagsAPI

- Defined in Okuna.ts:143
hashtags()

Returns HashtagsAPI
- HashtagsAPI instance

health

health(): HealthAPI

- Defined in Okuna.ts:151
health()

Returns HealthAPI
- HealthAPI instance

lists

lists(): ListsAPI

- Defined in Okuna.ts:159
lists()

Returns ListsAPI
- ListsAPI instance

moderation

moderation(): ModerationAPI

- Defined in Okuna.ts:167
moderation()

Returns ModerationAPI
- ModerationAPI instance

notifications

notifications(): NotificationsAPI

- Defined in Okuna.ts:175
notifications()

Returns NotificationsAPI
- NotificationsAPI instance

posts

posts(): PostsAPI

- Defined in Okuna.ts:183
posts()

Returns PostsAPI
- PostsAPI instance

updateAuthToken

updateAuthToken(token: string): void

- Defined in Okuna.ts:71
updateAuthToken() - Updates the authorization token of the current Client instance

Parameters
- token: string
  
  the new authorization token
Returns void

userInvites

userInvites(): UserInvitesAPI

- Defined in Okuna.ts:191
userInvites()

Returns UserInvitesAPI
- UserInvitesAPI instance

Generated using TypeDoc