Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AdminApiClient

Hierarchy

  • AdminApiClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly _actuator

_actuator: ActuatorClient

Private Readonly _attachment

_attachment: AttachmentClient

Private Readonly _backup

_backup: BackupClient

Private Readonly _category

_category: CategoryClient

Private Readonly _comment

_comment: CommentClient

Private Readonly _installation

_installation: InstallationClient

Private Readonly _journal

_journal: JournalClient

Private Readonly _journalComment

_journalComment: JournalCommentClient

Private Readonly _link

_link: LinkClient

Private Readonly _log

_log: LogClient

Private Readonly _mail

_mail: MailClient

Private Readonly _menu

_menu: MenuClient

Private Readonly _migration

_migration: MigrationClient

Private Readonly _option

_option: OptionClient

Private Readonly _photo

_photo: PhotoClient

Private Readonly _post

_post: PostClient

Private Readonly _postComment

_postComment: PostCommentClient

Private Readonly _sheet

_sheet: SheetClient

Private Readonly _sheetComment

_sheetComment: SheetCommentClient

Private Readonly _staticStorage

_staticStorage: StaticStorageClient

Private Readonly _statistic

_statistic: StatisticClient

Private Readonly _tag

_tag: TagClient

Private Readonly _theme

_theme: ThemeClient

Private Readonly _user

_user: UserClient

Private Readonly client

client: HttpClient

Accessors

actuator

attachment

backup

  • Returns BackupClient

category

comment

  • Returns CommentClient

installation

journal

  • Returns JournalClient

journalComment

link

  • Returns LinkClient

log

  • Returns LogClient

mail

  • Returns MailClient

menu

  • Returns MenuClient

migration

option

  • Returns OptionClient

photo

  • Returns PhotoClient

post

  • Returns PostClient

postComment

sheet

  • Returns SheetClient

sheetComment

staticStorage

statistic

tag

  • Returns TagClient

theme

  • Returns ThemeClient

user

  • Returns UserClient

Methods

getEnvironment

getLogFile

  • getLogFile(lines: number): Promise<Response<string>>

  • Parameters

    • lines: number

    Returns Promise<Response<string>>

isInstalled

  • isInstalled(): Promise<Response<boolean>>

  • Returns Promise<Response<boolean>>

login

  • login(params: { authcode: boolean; password: string; username: string }): Promise<Response<AccessToken>>

  • Parameters

    • params: { authcode: boolean; password: string; username: string }
      • authcode: boolean
      • password: string
      • username: string

    Returns Promise<Response<AccessToken>>

logout

  • Returns Promise<Response<any>>

needMFACode

  • Parameters

    • params: { password: string; username: string }
      • password: string
      • username: string

    Returns Promise<Response<LoginPreCheck>>

refreshToken

  • Parameters

    • refreshToken: string

    Returns Promise<Response<AccessToken>>

resetPassword

  • resetPassword(params: { code?: string; email: string; password?: string; username: string }): Promise<object>

  • Parameters

    • params: { code?: string; email: string; password?: string; username: string }
      • Optional code?: string
      • email: string
      • Optional password?: string
      • username: string

    Returns Promise<object>

sendResetPasswordCode

  • sendResetPasswordCode(params: { code?: string; email: string; password?: string; username: string }): Promise<object>

  • Parameters

    • params: { code?: string; email: string; password?: string; username: string }
      • Optional code?: string
      • email: string
      • Optional password?: string
      • username: string

    Returns Promise<object>

Generated using TypeDoc