@system.app (Application Context)

NOTE

• The APIs of this module are no longer maintained since API version 7. You are advised to use the new APIs.

• The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import app from '@system.app';

app.getInfo

getInfo(): AppResponse

Obtains the declared information in the config.json file of an application.

NOTE

You are advised to use @ohos.bundle since API version 7.

System capability: SystemCapability.ArkUI.ArkUI.Lite

Return value

Example

export default {    
  getInfo(){        
    var info = app.getInfo();        
      console.log(JSON.stringify(info));    
  } 
}

app.terminate

terminate(): void

Terminates the current ability.

NOTE

You are advised to use @ohos.ability.featureAbility since API version 7.

System capability: SystemCapability.ArkUI.ArkUI.Lite

Example

export default {    
  terminate(){        
    app.terminate();    
  }}

app.requestFullWindow

requestFullWindow(options?: RequestFullWindowOptions): void

Requests the application to run in full window. You can call this API when the FA runs in a non-full window, for example, semi-modal FA. This API is invalid for an application already in full-window mode.

NOTE

You are advised to use @ohos.window since API version 7.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Example

export default {    
  requestFullWindow(){        
    app.requestFullWindow({            
      duration: 200});    
  }
}

app.setImageCacheCount⁷⁺

setImageCacheCount(value: number): void

Sets the maximum number of decoded images that can be cached in the memory to speed up the loading of images from the same sources. If the input parameter is not set, the default value 0 is used, indicating that images are not cached. The built-in Least Recently Used (LRU) policy is used for caching. If the maximum number is exceeded, the images that have not been updated for the longest time will be removed. You are advised to set the parameter based on the application memory requirements. If the number of images is too large, the memory usage may be too high.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Example

// app.ets
import app from '@system.app';

export default {
    onCreate() { 
        app.setImageCacheCount(100)    // Set the maximum number of decoded images that can be cached in the memory to 100.
        console.info('Application onCreate')
    },
    onDestroy() {
        console.info('Application onDestroy')
    },
}

app.setImageRawDataCacheSize⁷⁺

setImageRawDataCacheSize(value: number): void

Sets the maximum size (in bytes) of the image data cached in the memory before decoding to speed up the loading of images from the same sources. If the input parameter is not set, the default value 0 is used, indicating that images are not cached. The LRU policy is used for caching. If the maximum size is exceeded, the images that have not been updated for the longest time will be removed. You are advised to set the parameter based on the application memory requirements. If the image cache is too large, the memory usage may be too high.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Example

// app.ets
import app from '@system.app';

export default {
    onCreate() {
        app.setImageRawDataCacheSize(104857600) 
        // Set the upper limit of the memory for caching image data before decoding to 100 MB. (100 x 1024 x 1024 B =104857600 B = 100 MB).
        console.info('Application onCreate')
    },
    onDestroy() {
        console.info('Application onDestroy')
    },
}

app.setImageFileCacheSize⁷⁺

setImageFileCacheSize(value: number): void

Sets the maximum size of the image file cache (in bytes) to speed up the loading of images from the same sources, especially online image sources and thumbnails. If the input parameter is not set, the default value 100 MB is used. The LRU policy is used for caching. If the maximum size is exceeded, the images that have not been updated for the longest time will be removed. You are advised to set the parameter based on the application memory requirements. If the image cache is too large, the disk usage may be too high.

System capability: SystemCapability.ArkUI.ArkUI.Full

Parameters

Example

// app.ets
import app from '@system.app';

export default {  
    onCreate() {    
        app.setImageFileCacheSize(209715200) 
        // Set the upper limit of the image file cache to 200 MB. (200 x 1024 x 1024 B= 209715200 B = 200 MB).
        console.info('Application onCreate')
    },  
    onDestroy() {
        console.info('Application onDestroy')
    },
}

AppResponse

Defines the application response information.

System capability: The items in the table below require different system capabilities. For details, see the table.

ScreenOnVisible^(deprecated)

screenOnVisible(options?: ScreenOnVisibleOptions): void

Defines whether to keep the application visible when the screen is woken up.

NOTE

This API is deprecated since API Version 8.

System capability: SystemCapability.ArkUI.ArkUI.Full

ScreenOnVisibleOptions

Defines the options of the visible interface on the screen.

System capability: SystemCapability.ArkUI.ArkUI.Full

RequestFullWindowOptions

Defines the options of the RequestFullWindow API.

System capability: SystemCapability.ArkUI.ArkUI.Full