Class default

Handles User related API requests

Index

Constructors

Properties

Methods

acceptEula changeNickname create getAccount getBadgeCount getChatProfile getHearts getPosts getReplied getSearchBackground getUnreadActivityCount getUnreadChatCount getUser setChatProfile updateSetting

Constructors

constructor

new default(authService): default
Parameters
- authService: default
Returns default
- Defined in apiFunctions/User.ts:13

Properties

`Private` auth

The AuthService for this instance

Methods

acceptEula

acceptEula(): Promise<boolean>
Accept the EULA for the current User

Returns Promise<boolean>
- Defined in apiFunctions/User.ts:236

changeNickname

changeNickname(nickname): Promise<boolean>
Change the User#username for the current User
Parameters
- nickname: string
  The nickname to set
Returns Promise<boolean>
true if User#username was changed
- Defined in apiFunctions/User.ts:50

create

create(): Promise<boolean>
Creates a new User

NOTE: This User will need to accept the EULA before they can use the API.

Returns Promise<boolean>
- Defined in apiFunctions/User.ts:199

getAccount

getAccount(): Promise<null | AccountResponse>
Get the current User

Returns Promise<null | AccountResponse>
- Defined in apiFunctions/User.ts:20

getBadgeCount

getBadgeCount(): Promise<null | number>
Get the number of Badges for the current User

Returns Promise<null | number>
- Defined in apiFunctions/User.ts:306

getChatProfile

getChatProfile(): Promise<null | ChatProfileResponse>
Get the current User ChatProfile

Returns Promise<null | ChatProfileResponse>
- Defined in apiFunctions/User.ts:79

getHearts

getHearts(): Promise<null | PostResponse>
Get the Posts hearted by the current User

Returns Promise<null | PostResponse>
- Defined in apiFunctions/User.ts:383

getPosts

getPosts(): Promise<null | PostResponse>
Get the Posts created by the current User

Returns Promise<null | PostResponse>
- Defined in apiFunctions/User.ts:358

getReplied

getReplied(): Promise<null | PostResponse>
Get the Posts hearted by the current User

Returns Promise<null | PostResponse>
- Defined in apiFunctions/User.ts:408

getSearchBackground

getSearchBackground(text): Promise<null | PhotoResponse>
Run a search for Photos with the specified text.
Parameters
- text: string
  The text to search for
Returns Promise<null | PhotoResponse>
- Defined in apiFunctions/User.ts:333

getUnreadActivityCount

getUnreadActivityCount(): Promise<null | number>
Get the number of unread Activities for the current User

Returns Promise<null | number>
- Defined in apiFunctions/User.ts:284

getUnreadChatCount

getUnreadChatCount(): Promise<null | number>
Get the number of unread Chats for the current User

Returns Promise<null | number>
- Defined in apiFunctions/User.ts:262

getUser

getUser(): Promise<null | UserResponse>
Get the current User and their Settings

Returns Promise<null | UserResponse>
- Defined in apiFunctions/User.ts:142

setChatProfile

setChatProfile(gender, age, latitude, longitude): Promise<boolean>
Change the current User's ChatProfile
Parameters
- gender: string
  The gender to set
- age: string
  The age to set
- latitude: Number
  The latitude to set
- longitude: Number
  The longitude to set
Returns Promise<boolean>
- Defined in apiFunctions/User.ts:108

updateSetting

updateSetting(setting): Promise<boolean>
Update the User Setting
Parameters
- setting: Setting
  The setting to set for the user
Returns Promise<boolean>
- Defined in apiFunctions/User.ts:168

Generated using TypeDoc