Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "resources/User"

Index

Type aliases

DocBaseUser

DocBaseUser: object
typedef

{Object} DocBaseUser

prop

{number} id

prop

{string} name

prop

{string} username

prop

{string} profile_image_url

prop

{DocBaseUserRole} role

prop

{number} posts_count

prop

{string} last_access_time

prop

{string} two_step_authentication

prop

{DocBaseGroupShort[]} groups

Type declaration

  • groups: DocBaseGroupShort[]
  • id: number
  • last_access_time: string
  • name: string
  • posts_count: number
  • profile_image_url: string
  • role: DocBaseUserRole
  • two_step_authentication: boolean
  • username: string

DocBaseUserRole

DocBaseUserRole: "administrator" | "owner" | "user"
typedef

{string} DocBaseUserRole

DocBaseUserShort

DocBaseUserShort: object
typedef

{Object} DocBaseUserShort

prop

{number} id

prop

{string} name

prop

{string} profile_image_url

Type declaration

  • id: number
  • name: string
  • profile_image_url: string

ListParams

ListParams: object
typedef

{Object} ListParams

prop

{boolean} [include_user_groups]

prop

{number} [page]

prop

{number} [per_page]

prop

{string} [q]

Type declaration

  • Optional include_user_groups?: undefined | false | true
  • Optional page?: undefined | number
  • Optional per_page?: undefined | number
  • Optional q?: undefined | string

Generated using TypeDoc