@shadmanZero/tenantos-api
    Preparing search index...

    Class SystemResource

    System management resource

    Hierarchy

    • BaseResource
      • SystemResource
    Index

    Constructors

    constructor

    Properties

    backups client logs settings ui

    Methods

    getListTimeDateFormats getSettingsAfterLogin request validateId validateRequiredString

    Constructors

    Properties

    backups: {
        create: (data: any) => Promise<void>;
        getHistory: () => Promise<SystemBackup[]>;
        getHistoryItem: (backupTaskId: string) => Promise<SystemBackup>;
        storages: {
            create: (data: any) => Promise<any>;
            delete: (id: number) => Promise<void>;
            get: (id: number) => Promise<any>;
            list: () => Promise<any[]>;
            update: (id: number, data: any) => Promise<any>;
        };
    } = ...
    client: TenantosClient
    logs: {
        getAgentLogs: (agentId: number) => Promise<SystemLog[]>;
        getSystemLogs: () => Promise<SystemLog[]>;
        getUserLogs: () => Promise<SystemLog[]>;
    } = ...
    settings: {
        getGlobalSettings: () => Promise<SystemSetting[]>;
        getSetting: (settingName: string) => Promise<SystemSetting>;
        updateGlobalSettings: (settings: Record<string, any>) => Promise<void>;
    } = ...
    ui: {
        getLanguage: () => Promise<any>;
        getSettings: () => Promise<any>;
        getVersion: () => Promise<any>;
    } = ...

    Methods

    • Returns Promise<string[]>

    • Returns Promise<any>

    • Validate that an ID is a positive integer

      Parameters

      • id: number
      • resourceName: string = 'Resource'

      Returns void

    • Validate required string field

      Parameters

      • value: string
      • fieldName: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods