Options
All
  • Public
  • Public/Protected
  • All
Menu

Module admin-api/src

Index

Namespaces

Classes

Interfaces

Type aliases

Type aliases

AccessToken

AccessToken: { access_token: string; expired_in: number; refresh_token: string }

Type declaration

  • access_token: string
  • expired_in: number
  • refresh_token: string

Author

Author: { avatar: string; name: string; website: string }

Type declaration

  • avatar: string
  • name: string
  • website: string

Backup

Backup: { downloadLink: string; fileSize: number; filename: string; updateTime: number }

Type declaration

  • downloadLink: string
  • fileSize: number
  • filename: string
  • updateTime: number

BaseCommentParam

BaseCommentParam: { allowNotification?: boolean; author: string; authorUrl?: string; content: string; email: string; id?: number; parentId?: number; postId?: number }

Type declaration

  • Optional allowNotification?: boolean
  • author: string
  • Optional authorUrl?: string
  • content: string
  • email: string
  • Optional id?: number
  • Optional parentId?: number
  • Optional postId?: number

BaseMeta

BaseMeta: { createTime: number; id: number; key: string; postId: number; value: string }

Type declaration

  • createTime: number
  • id: number
  • key: string
  • postId: number
  • value: string

BaseMetaParam

BaseMetaParam: { key: string; postId: number; value: string }

Type declaration

  • key: string
  • postId: number
  • value: string

BasicAuth

BasicAuth: { password: string; username: string }

Type declaration

  • password: string
  • username: string

CategoryParam

CategoryParam: { description?: string; name: string; parentId?: number; password?: string; slug?: string; thumbnail?: string }

Type declaration

  • Optional description?: string
  • name: string
  • Optional parentId?: number
  • Optional password?: string
  • Optional slug?: string
  • Optional thumbnail?: string

CommentStatus

CommentStatus: "PUBLISHED" | "AUDITING" | "RECYCLE"

CustomizeAuth

CustomizeAuth: { authHeader: string; type: "customizeAuth"; getToken: any }

Type declaration

  • authHeader: string
  • type: "customizeAuth"
  • getToken:function
    • getToken(): string

    • Returns string

DataType

DataType: "STRING" | "LONG" | "DOUBLE" | "BOOL"

DiscriminatedAuth

DiscriminatedAuth: <internal>.AdminTokenAuth | <internal>.ApiTokenAuth | <internal>.PasswordAuth | <internal>.SessionAuth | <internal>.OAuthTokenAuth | CustomizeAuth

Environment

Environment: { database: string; mode: ModeType; startTime: number; version: string }

Type declaration

  • database: string
  • mode: ModeType
  • startTime: number
  • version: string

Group

Group: { items: Item[]; label: string; name: string }

Type declaration

  • items: Item[]
  • label: string
  • name: string

IndependentSheet

IndependentSheet: { available: boolean; fullPath: string; id: number; routeName: string; title: string }

Type declaration

  • available: boolean
  • fullPath: string
  • id: number
  • routeName: string
  • title: string

InputType

InputType: "TEXT" | "NUMBER" | "RADIO" | "SELECT" | "TEXTAREA" | "COLOR" | "ATTACHMENT" | "SWITCH"

Item

Item: { dataType: DataType; defaultValue: any; description: string; label: string; name: string; options: <internal>.Option[]; placeholder: string; type: InputType }

Type declaration

Journal

Journal: { content: string; createTime: number; id?: number; likes: number; sourceContent: string; type: JournalType }

Type declaration

  • content: string
  • createTime: number
  • Optional id?: number
  • likes: number
  • sourceContent: string
  • type: JournalType

JournalType

JournalType: "PUBLIC" | "INTIMATE"

Link

Link: { description?: string; id?: number; logo?: string; name: string; priority?: number; team?: string; url?: string }

Type declaration

  • Optional description?: string
  • Optional id?: number
  • Optional logo?: string
  • name: string
  • Optional priority?: number
  • Optional team?: string
  • Optional url?: string

Log

Log: { content: string; createTime: number; id: number; ipAddress: string; logKey: string; type: LogType }

Type declaration

  • content: string
  • createTime: number
  • id: number
  • ipAddress: string
  • logKey: string
  • type: LogType

LogType

LogType: "BLOG_INITIALIZED" | "POST_PUBLISHED" | "POST_EDITED" | "POST_DELETED" | "LOGGED_IN" | "LOGGED_OUT" | "LOGIN_FAILED" | "PASSWORD_UPDATED" | "PROFILE_UPDATED" | "SHEET_PUBLISHED" | "SHEET_EDITED" | "SHEET_DELETED" | "MFA_UPDATED" | "LOGGED_PRE_CHECK"

LoginPreCheck

LoginPreCheck: { needMFACode: boolean }

Type declaration

  • needMFACode: boolean

Menu

Menu: { children?: Menu[]; icon?: string; id?: number; name: string; parentId?: number; priority?: number; target?: string; team?: string; url: string }

Type declaration

  • Optional children?: Menu[]
  • Optional icon?: string
  • Optional id?: number
  • name: string
  • Optional parentId?: number
  • Optional priority?: number
  • Optional target?: string
  • Optional team?: string
  • url: string

MultiFactorAuthParam

MultiFactorAuthParam: { authcode: string; mfaKey: string; mfaType: "NONE" | "TFA_TOTP" }

Type declaration

  • authcode: string
  • mfaKey: string
  • mfaType: "NONE" | "TFA_TOTP"

OptionType

OptionType: "INTERNAL" | "CUSTOM"

Photo

Photo: { description?: string; id?: number; location?: string; name: string; takeTime?: number; team?: string; thumbnail: string; url: string }

Type declaration

  • Optional description?: string
  • Optional id?: number
  • Optional location?: string
  • name: string
  • Optional takeTime?: number
  • Optional team?: string
  • thumbnail: string
  • url: string

Post

Post: { disallowComment: boolean; editTime: number; editorType: PostEditorType; formatContent: string; id: number; likes: number; metaDescription: string; metaKeywords: string; originalContent: string; password: string; slug: string; status: PostStatus; summary: string; template: string; thumbnail: string; title: string; topPriority: number; url: string; visits: number; wordCount: number }

Type declaration

  • disallowComment: boolean
  • editTime: number
  • editorType: PostEditorType
  • formatContent: string
  • id: number
  • likes: number
  • metaDescription: string
  • metaKeywords: string
  • originalContent: string
  • password: string
  • slug: string
  • status: PostStatus
  • summary: string
  • template: string
  • thumbnail: string
  • title: string
  • topPriority: number
  • url: string
  • visits: number
  • wordCount: number

PostEditorType

PostEditorType: "MARKDOWN" | "RICHTEXT"

PostMetaParam

PostMetaParam: BaseMetaParam

PostParam

PostParam: { categoryIds?: number[]; createTime?: number; disallowComment?: boolean; editorType?: PostEditorType; keepRaw?: boolean; metaDescription?: string; metaKeywords?: string; metas?: PostMetaParam[]; originalContent?: string; password?: string; slug?: string; status?: PostStatus; summary?: string; tagIds?: number[]; template?: string; thumbnail?: string; title: string; topPriority?: number }

Type declaration

  • Optional categoryIds?: number[]
  • Optional createTime?: number
  • Optional disallowComment?: boolean
  • Optional editorType?: PostEditorType
  • Optional keepRaw?: boolean
  • Optional metaDescription?: string
  • Optional metaKeywords?: string
  • Optional metas?: PostMetaParam[]
  • Optional originalContent?: string
  • Optional password?: string
  • Optional slug?: string
  • Optional status?: PostStatus
  • Optional summary?: string
  • Optional tagIds?: number[]
  • Optional template?: string
  • Optional thumbnail?: string
  • title: string
  • Optional topPriority?: number

PostStatus

PostStatus: "PUBLISHED" | "DRAFT" | "RECYCLE" | "INTIMATE"

Response

Response<T>: { data: T; devMessage?: any; message?: string; status: number | string }

Type parameters

  • T = any

Type declaration

  • data: T
  • Optional devMessage?: any
  • Optional message?: string
  • status: number | string

SheetParam

SheetParam: { createTime?: number; disallowComment?: boolean; editorType?: PostEditorType; metaDescription?: string; metaKeywords?: string; metas?: BaseMetaParam[]; originalContent?: string; password?: string; slug?: string; status?: PostStatus; summary?: string; template?: string; thumbnail?: string; title: string; topPriority?: number }

Type declaration

  • Optional createTime?: number
  • Optional disallowComment?: boolean
  • Optional editorType?: PostEditorType
  • Optional metaDescription?: string
  • Optional metaKeywords?: string
  • Optional metas?: BaseMetaParam[]
  • Optional originalContent?: string
  • Optional password?: string
  • Optional slug?: string
  • Optional status?: PostStatus
  • Optional summary?: string
  • Optional template?: string
  • Optional thumbnail?: string
  • title: string
  • Optional topPriority?: number

StaticContentParam

StaticContentParam: { content: string; path: string }

Type declaration

  • content: string
  • path: string

StaticFile

StaticFile: { children: StaticFile[]; createTime: number; id: number; isFile: boolean; mimeType: string; name: string; path: string; relativePath: string }

Type declaration

  • children: StaticFile[]
  • createTime: number
  • id: number
  • isFile: boolean
  • mimeType: string
  • name: string
  • path: string
  • relativePath: string

Statistic

Statistic: { attachmentCount: number; birthday: number; categoryCount: number; commentCount: number; establishDays: number; journalCount: number; likeCount: number; linkCount: number; postCount: number; tagCount: number; visitCount: number }

Type declaration

  • attachmentCount: number
  • birthday: number
  • categoryCount: number
  • commentCount: number
  • establishDays: number
  • journalCount: number
  • likeCount: number
  • linkCount: number
  • postCount: number
  • tagCount: number
  • visitCount: number

Tag

Tag: { color: string; createTime: string; fullPath: string; id: number; name: string; slug: string; thumbnail: string }

Type declaration

  • color: string
  • createTime: string
  • fullPath: string
  • id: number
  • name: string
  • slug: string
  • thumbnail: string

TagParam

TagParam: { color?: string; name: string; slug?: string; thumbnail?: string }

Type declaration

  • Optional color?: string
  • name: string
  • Optional slug?: string
  • Optional thumbnail?: string

ThemeFile

ThemeFile: { editable: boolean; isFile: boolean; name: string; node: ThemeFile[]; path: string }

Type declaration

  • editable: boolean
  • isFile: boolean
  • name: string
  • node: ThemeFile[]
  • path: string

ThemeProperty

ThemeProperty: { activated: boolean; author: Author; branch: string; description: string; folderName: string; hasOptions: boolean; id: string; logo: string; name: string; postMetaField: string[]; repo: string; require: string; screenshots: string; sheetMetaField: string[]; themePath: string; updateStrategy: UpdateStrategy; version: string; website: string }

Type declaration

  • activated: boolean
  • author: Author
  • branch: string
  • description: string
  • folderName: string
  • hasOptions: boolean
  • id: string
  • logo: string
  • name: string
  • postMetaField: string[]
  • repo: string
  • require: string
  • screenshots: string
  • sheetMetaField: string[]
  • themePath: string
  • updateStrategy: UpdateStrategy
  • version: string
  • website: string

TokenType

TokenType: "admin" | "api"

UpdateStrategy

UpdateStrategy: "BRANCH" | "RELEASE"

UploadOptions

UploadOptions: { cancelToken?: CancelToken; timeout?: number; onUploadProgress?: any; paramsSerializer?: any; validateStatus?: any }

Type declaration

  • Optional cancelToken?: CancelToken
  • Optional timeout?: number
  • onUploadProgress?:function
    • onUploadProgress(e: ProgressEvent<EventTarget>): void

    • Parameters

      • e: ProgressEvent<EventTarget>

      Returns void

  • paramsSerializer?:function
    • paramsSerializer(params: any): string

    • Parameters

      • params: any

      Returns string

  • validateStatus?:function
    • validateStatus(status: number): boolean

    • Parameters

      • status: number

      Returns boolean

Generated using TypeDoc