Class Users

Methods for dealing with Users.

Index

Methods

getByUserName getCurrentUser getLocalizedUserProfileLink getUserProfile getUserProfileLink

Methods

getByUserName

getByUserName(options: { userName: string }): null | User
Parameters
- options: { userName: string }
  - userName: string
    editor username to look for
Returns null | User
user with userName, or null if not found

getCurrentUser

getCurrentUser(): null | User
Returns null | User
the currently logged in user or null if not logged in

getLocalizedUserProfileLink

getLocalizedUserProfileLink(options: { userName: string }): string
Parameters
- options: { userName: string }
  - userName: string
    editor username for the profile link
Returns string
a formatted link which includes the current locale for a users editor profile page

getUserProfile

getUserProfile(options: { userName: string }): Promise<UserProfile>
Parameters
- options: { userName: string }
  - userName: string
    editor username to fetch a profile for
Returns Promise<UserProfile>
a fetched user profile

getUserProfileLink

getUserProfileLink(options: { userName: string }): string
Parameters
- options: { userName: string }
  - userName: string
    editor username for the profile link
Returns string
a formatted link for a users editor profile page