We use essential cookies for the website to function, as well as analytics cookies for analyzing and creating statistics of the website performance. To agree to the use of analytics cookies, click "Accept All". You can manage your preferences at any time by clicking "Cookie Settings" on the footer. More Information.

Cookie Settings

Only Essential Cookies

Accept All

English

Products
Solutions
Events
Programs
Community
Training
Support

More

Search

Materials Console

API Reference Overview

Development Description

SystemCapability

Universal Error Codes

Application Framework

@ohos.app.ability.Ability (Ability Base Class)

@ohos.app.ability.AbilityConstant (Ability-related Constants)

@ohos.app.ability.abilityLifecycleCallback (UIAbility Lifecycle Callback Listener)

@ohos.app.ability.AbilityStage (AbilityStage Component Manager)

@ohos.app.ability.ActionExtensionAbility (ExtensionAbility for Custom Actions)

@ohos.app.ability.AgentUIExtensionAbility (UI-Enabled Agent Extension Component)

@ohos.app.ability.application (Application Utility Class)

@ohos.app.ability.ApplicationStateChangeCallback (Application Process State Change Listener)

@ohos.app.ability.appMemoryOptimizer (Application Memory Optimizer)

@ohos.app.ability.AppServiceExtensionAbility (ExtensionAbility for Application Background Services)

@ohos.app.ability.AtomicServiceOptions (Optional Parameters of openAtomicService)

@ohos.app.ability.autoFillManager (Auto-Fill Framework)

@ohos.app.ability.ChildProcess (Child Process Base Class)

@ohos.app.ability.childProcessManager (Child Process Management)

@ohos.app.ability.ChildProcessArgs (Child Process Arguments)

@ohos.app.ability.ChildProcessOptions (Child Process Startup Options)

@ohos.app.ability.common (Ability Common Module)

@ohos.app.ability.CompletionHandler (Application Launch Result Handler)

@ohos.app.ability.CompletionHandlerForAtomicService (Atomic Service Launch Result Handler)

@ohos.app.ability.CompletionHandlerForAbilityStartCallback (Application Launch Result Callback Handler)

@ohos.app.ability.contextConstant (Context-related Constants)

@ohos.app.ability.EmbeddableUIAbility (Embeddable UIAbility)

@ohos.app.ability.EmbeddedUIExtensionAbility (ExtensionAbility for Cross-Process UI Embedding)

@ohos.app.ability.EnvironmentCallback (System Environment Change Listener)

@ohos.app.ability.ExtensionAbility (ExtensionAbility Base Class)

@ohos.app.ability.insightIntent (Basic Definitions of InsightIntent Framework)

@ohos.app.ability.InsightIntentContext (Intent Execution Context)

@ohos.app.ability.InsightIntentDecorator (Intent Decorator)

@ohos.app.ability.InsightIntentEntryExecutor (Base Class for @InsightIntentEntry Intent Execution)

@ohos.app.ability.InsightIntentExecutor (Base Class for Intent Execution)

@ohos.app.ability.insightIntentProvider (Intent Provider Management)

@ohos.app.ability.PhotoEditorExtensionAbility (ExtensionAbility for Image Editing)

@ohos.app.ability.OpenLinkOptions (Optional Parameters of openLink)

@ohos.app.ability.ShareExtensionAbility (ExtensionAbility for Share Detail Page Integration)

@ohos.app.ability.StartOptions (Optional Parameters of startAbility)

@ohos.app.ability.systemConfiguration

@ohos.app.ability.UIAbility (Ability with UI)

@ohos.app.ability.UIExtensionAbility (ExtensionAbility with UI)

@ohos.app.ability.UIExtensionContentSession (UIExtensionAbility UI Operation Class)

@ohos.app.ability.sendableContextManager (Sendable Context Management)

@ohos.app.ability.scriptManager (Script Management)

@ohos.app.appstartup.StartupConfig (AppStartup Configuration)

@ohos.app.appstartup.StartupConfigEntry (AppStartup Configuration Entry)

@ohos.app.appstartup.StartupListener (AppStartup Task Listener)

@ohos.app.appstartup.startupManager (AppStartup Management)

@ohos.app.appstartup.StartupTask (AppStartup Task)

@ohos.app.ability.autoStartupManager (Auto-Startup Management)

@ohos.app.agent.agentConstant (Agent Constants)

@ohos.app.agent.AgentExtensionAbility

@ohos.continuation.continuationManager (Continuation/Collaboration Management)

ContinuationExtraParams

ContinuationResult

@ohos.ability.ability (Ability Module)

@ohos.ability.featureAbility (FeatureAbility Module)

@ohos.ability.particleAbility (ParticleAbility Module)

DataAbilityOperation

DataAbilityResult

StartAbilityParameter

Context (Context Base Class of the FA Model)

Both Models (Recommended)

@ohos.abilityAccessCtrl (Application Access Control)

@ohos.ability.screenLockFileManager (Sensitive Data Access Management Under Lock Screen)

@ohos.app.ability.abilityManager (Ability Information Management)

@ohos.app.ability.appManager (Application Management)

@ohos.app.ability.appRecovery (Application Recovery)

@ohos.app.ability.Configuration (Environment Variables)

@ohos.app.ability.ConfigurationConstant (Constants Related to Environment Variables)

@ohos.app.ability.continueManager (Cross-Device Migration)

@ohos.app.ability.dataUriUtils (DataUriUtils Module)

@ohos.app.ability.dialogRequest (dialogRequest Module)

@ohos.app.ability.errorManager (Error Management Module)

@ohos.app.ability.hyperSnapManager (Quick Launch Management)

@ohos.app.ability.kioskManager (Kiosk Mode Management)

@ohos.app.ability.Want (Want)

@ohos.app.ability.wantAgent (WantAgent Module)

@ohos.app.ability.wantConstant (Want Constants)

@ohos.bundle.bundleManager (Bundle Management Module)

@ohos.bundle.defaultAppManager (Default Application Management)

@ohos.bundle.launcherBundleManager (launcherBundleManager Module)

@ohos.bundle.overlay (overlay Module)

@ohos.bundle.pluginBundleManager (pluginBundleManager module)

@ohos.bundle.shortcutManager (shortcutManager Module)

@ohos.bundle.skillManager (skillManager Module)

Dependent Elements and Definitions

DataAbilityHelper

AbilityRunningInfo

AbilityStageContext

AbilityStageMonitor

AbilityStartCallback

AbilityStateData

AgentExtensionContext

ApplicationContext (Application Context)

ApplicationStateObserver

AppServiceExtensionContext (ExtensionAbility Context for Application Background Services)

AutoFillRequest

AutoFillTriggerType

Context (Context Base Class of the Stage Model)

EmbeddableUIAbilityContext

ExtensionContext

KioskStatus (Kiosk Status Information)

ProcessInformation

ProcessRunningInfo

UIAbilityContext

UIExtensionContext

UIServiceExtensionConnectCallback

PhotoEditorExtensionContext

SendableContext

applicationInfo

ExtensionAbilityInfo

LauncherAbilityInfo

OverlayModuleInfo

PluginBundleInfo

PermissionRequestResult

APIs No Longer Maintained

@ohos.ability.dataUriUtils (DataUriUtils Module)

@ohos.ability.errorCode (ErrorCode)

@ohos.ability.wantConstant (wantConstant)

@ohos.application.appManager (appManager)

@ohos.application.Configuration (Configuration)

@ohos.application.ConfigurationConstant (ConfigurationConstant)

@ohos.application.Want (Want)

@ohos.wantAgent (WantAgent Module)

@ohos.bundle (Bundle Module)

@system.package (Bundle Management)

ApplicationInfo

AbilityAccessControl

ability_access_control.h

ability_base_common.h

ability_runtime_common.h

application_context.h

context_constant.h

connect_options.h

native_ability_wrapper.h

native_child_process.h

native_interface_bundle.h

start_options.h

ability_resource_info.h

bundle_manager_common.h

extension_ability.h

modular_object_dispatcher.h

modular_object_extension_ability.h

modular_object_extension_context.h

modular_object_extension_manager.h

AbilityBase_Element

AbilityBase_Want

AbilityRuntime_StartOptions

NativeChildProcess_Fd

NativeChildProcess_FdList

NativeChildProcess_Options

NativeChildProcess_Args

Ability_ChildProcessConfigs

OH_NativeBundle_ApplicationInfo

OH_NativeBundle_ElementName

OH_NativeBundle_Metadata

OH_NativeBundle_ModuleMetadata

OH_NativeBundle_AbilityResourceInfo

AbilityRuntime_Context

AbilityRuntime_Context*

AbilityRuntime_NativeAbilityWrapper

AbilityRuntime_ExtensionInstance

AbilityRuntime_ExtensionInstance*

OH_AbilityRuntime_ModObjDispatcher_InputParams

OH_AbilityRuntime_ModObjDispatcher_TypeInfo

OH_AbilityRuntime_ModObjDispatcher_Variant

OH_AbilityRuntime_ModularObjectDispatcher*

OH_AbilityRuntime_ModularObjectDispatcher_Array*

OH_AbilityRuntime_ModularObjectDispatcher_Map*

OH_AbilityRuntime_ModularObjectDispatcher_Set*

OH_AbilityRuntime_ModularObjectDispatcher_Struct*

OH_AbilityRuntime_ModularObjectDispatcher_TypeDescriptor*

OH_AbilityRuntime_ModularObjectDispatcher_Vector*

OH_AbilityRuntime_ModularObjectExtensionInfo*

OH_AbilityRuntime_AllModularObjectExtensionInfos*

OH_AbilityRuntime_ConnectOptions

OH_AbilityRuntime_ModularObjectExtensionContext*

OH_AbilityRuntime_ModularObjectExtensionInstance

OH_AbilityRuntime_ModObjExtensionInstance*

Ability Error Codes

Distributed Scheduler Error Codes

Bundle Error Codes

Access Control Error Codes

ohos.screenLockFileManager Error Codes

Accessibility Kit

@ohos.accessibility (Accessibility)

@ohos.accessibility.GesturePath (Gesture Path)

@ohos.accessibility.GesturePoint (Gesture Point)

@ohos.application.AccessibilityExtensionAbility (AccessibilityExtensionAbility)

AccessibilityExtensionContext (Accessibility Extension Context)

Accessibility Error Codes

@ohos.data.commonType (Common Data Types)

@ohos.data.dataAbility (DataAbility Predicates)

@ohos.data.dataShare (DataShare)

@ohos.data.dataSharePredicates (DataShare Predicates)

@ohos.data.distributedDataObject (Distributed Data Object)

@ohos.data.distributedKVStore (Distributed KV Store)

@ohos.data.preferences (User Preferences)

@ohos.data.sendablePreferences (Shared User Preferences)

@ohos.data.relationalStore (RDB Store)

Module Description

Interface (RdbStore)

Interface (ResultSet)

Class (LiteResultSet)

Interface (Transaction)

Interfaces (Others)

Class (RdbPredicates)

@ohos.data.sendableRelationalStore (Shared RDB Store)

@ohos.data.unifiedDataChannel (Unified Data Channel)

@ohos.data.uniformDataStruct (Uniform Data Structs)

@ohos.data.uniformTypeDescriptor (Uniform Data Definition and Description)

@ohos.data.ValuesBucket (Value Bucket)

@ohos.data.intelligence (ArkData Intelligence Platform)

@ohos.data.cloudData (Device-Cloud Service)

APIs No Longer Maintained

@ohos.data.distributedData (Distributed Data Management)

@ohos.data.rdb (RDB)

@ohos.data.storage (Lightweight Data Storage)

@system.storage (Data Storage)

ArkTS Components

@ohos.data.UdmfComponents (Content Card)

oh_preferences.h

oh_preferences_err_code.h

oh_preferences_option.h

oh_preferences_value.h

oh_data_value.h

oh_data_values.h

oh_data_values_buckets.h

oh_predicates.h

oh_rdb_crypto_param.h

oh_rdb_transaction.h

oh_value_object.h

oh_values_bucket.h

relational_store.h

relational_store_error_code.h

udmf_err_code.h

OH_RDB_ReturningContext

Rdb_DistributedConfig

Rdb_SubscribeCallback

Rdb_DataObserver

Rdb_TableDetails

Rdb_ProgressDetails

Rdb_ProgressObserver

OH_PreferencesOption

OH_PreferencesPair

OH_PreferencesValue

OH_Data_VBuckets

OH_Rdb_CryptoParam

OH_RDB_TransOptions

OH_Rdb_Transaction

OH_Rdb_ConfigV2

OH_UdmfRecordProvider

OH_UdmfProperty

OH_Udmf_ProgressInfo

OH_UdmfGetDataParams

OH_UdmfDataLoadParams

OH_UdmfDataLoadInfo

OH_UdsPlainText

OH_UdsHyperlink

OH_UdsArrayBuffer

OH_UdsContentForm

RDB Error Codes

DataShare Error Codes

Distributed Data Object Error Codes

Distributed KV Store Error Codes

User Preferences Error Codes

UDMF Error Codes

AIP Error Codes

@arkts.collections (ArkTS Collections)

Module Description

Class (ArrayBuffer)

Class (Int8Array)

Class (Uint8Array)

Class (Int16Array)

Class (Uint16Array)

Class (Int32Array)

Class (Uint32Array)

Class (Uint8ClampedArray)

Class (Float32Array)

Class (BitVector)

Interface (ConcatArray)

@arkts.lang (ArkTS Base Capability)

@arkts.math.Decimal (High-Precision Math Library Decimal)

@arkts.utils (ArkTS Utils)

Module Description

ArkTSUtils.locks

ArkTSUtils.ASON

SendableLruCache<K, V>

@ohos.buffer (Buffer)

@ohos.convertxml (XML-to-JavaScript Conversion)

@ohos.fastbuffer (FastBuffer)

@ohos.process (Obtaining Process Information)

@ohos.taskpool (Starting the Task Pool)

@ohos.uri (URI String Parsing)

@ohos.url (URL String Parsing)

@ohos.util (util)

@ohos.util.ArrayList (Linear Container ArrayList)

@ohos.util.Deque (Linear Container Deque)

@ohos.util.HashMap (Nonlinear Container HashMap)

@ohos.util.HashSet (Nonlinear Container HashSet)

@ohos.util.json (JSON Parsing and Generation)

@ohos.util.LightWeightMap (Nonlinear Container LightWeightMap)

@ohos.util.LightWeightSet (Nonlinear Container LightWeightSet)

@ohos.util.LinkedList (Linear Container LinkedList)

@ohos.util.List (Linear Container List)

@ohos.util.PlainArray (Nonlinear Container PlainArray)

@ohos.util.Queue (Linear Container Queue)

@ohos.util.Stack (Linear Container Stack)

@ohos.util.stream (Stream Base Class)

@ohos.util.TreeMap (Nonlinear Container TreeMap)

@ohos.util.TreeSet (Nonlinear Container TreeSet)

@ohos.worker (Starting the Worker)

@ohos.xml (XML Parsing and Generation)

APIs No Longer Maintained

@ohos.util.Vector (Linear Container Vector)

Utils Error Codes

TypeScript Compiler Error Codes

Compilation Toolchain Error Codes

es2abc Compiler Error Codes

Source Code Obfuscation Error Codes

@ohos.animator (Animator)

@ohos.arkui.componentSnapshot (Component Snapshot)

@ohos.arkui.componentUtils (componentUtils)

@ohos.arkui.dragController (DragController)

@ohos.arkui.drawableDescriptor (DrawableDescriptor)

@ohos.arkui.inspector (Layout Callback)

@ohos.arkui.node (Custom Node)

@ohos.arkui.observer (Observer)

@ohos.arkui.Prefetcher (Prefetching)

@ohos.arkui.shape (Shape)

@ohos.arkui.theme (Theme)

@ohos.arkui.UIContext (UIContext)

Module Description

Class (ComponentSnapshot)

Class (ComponentUtils)

Class (ContextMenuController)

Class (CursorController)

Class (DragController)

Class (DynamicSyncScene)

Class (FocusController)

Class (FrameCallback)

Class (Magnifier)

Class (MarqueeDynamicSyncScene)

Class (MeasureUtils)

Class (MediaQuery)

Class (OverlayManager)

Class (PromptAction)

Class (SmartGestureController)

Class (BaseGestureHandlingProposal)

Class (TargetedGestureProposal)

Class (ClickActionProposal)

Class (SelectActionProposal)

Class (NoneActionProposal)

Class (BackPressActionProposal)

Class (PageSwitchActionProposal)

Class (ScrollActionProposal)

Class (GestureHandlingResolution)

Class (SwiperDynamicSyncScene)

Class (TextMenuController)

Class (UIContext)

Class (ResolvedUIContext)

Class (UIInspector)

Class (UIObserver)

Interface (AtomicServiceBar)

Interfaces (Others)

@ohos.arkui.uiExtension (uiExtension)

@ohos.arkui.uiMaterial (System Material)

@ohos.arkui.StateManagement (State Management)

@ohos.curves (Interpolation Calculation)

@ohos.font (Custom Font Registration)

@ohos.matrix4 (Matrix Transformation)

@ohos.measure (Text Measurement)

@ohos.mediaquery (Media Query)

@ohos.pluginComponent (PluginComponentManager)

@ohos.promptAction (Prompt)

@ohos.router (Page Routing) (Not Recommended)

@ohos.uiAppearance (UI Appearance)

ComponentContent

LayoutAlgorithm

LazyLayoutAlgorithm

AttributeUpdater

Window Management

@ohos.window.floatView (Float View)

@ohos.PiPWindow (PiP Window)

@ohos.window.floatingBall (Floating Ball Window)

@ohos.window (Window)

Module Description

Interface (Window)

Interface (WindowStage)

Interfaces (Others)

Screen Management

@ohos.display (Display)

@ohos.screenshot (Screenshot)

Deprecated APIs

@ohos.prompt (Prompt)

@system.app (Application Context)

@system.configuration (Application Configuration)

@system.mediaquery (Media Query)

@system.prompt (Prompt)

@system.router (Page Routing)

ArkTS Components

Universal Events

Basic Input Events

Focus Axis Event

Interaction Response Events

Component Keyboard Shortcut Event

Keyboard Determination Event

Interactive Event Distribution Control

Custom Event Interception

Custom Event Dispatch

Global Basic Input Event Listening

Accessibility Control Actions

Accessibility Hover Event

Component Change Events

Show/Hide Event

Component Area Change Event

Component Size Change Event

Visible Area Change Event

Universal Attributes

Basic Attributes

Distributed Migration Identifier

Visibility Control

Overlay Control

Z-order Control

Color Inversion

Layout and Border

Layout Constraints

Component-Level Pixel Rounding

Page-Level Pixel Rounding

Visual Effects and Blur

Opacity Control

Foreground Color

Foreground Effect

Outline Styling

Foreground Blur

Click Feedback Effect

Special Effect Drawing Combination

Interaction Attributes

Enable/Disable Control

Drag and Drop Control

Drag-and-Drop Sorting

Click Sound Effect

Smart Gesture Response

Touch Interaction Control

Hit Test Control

Event Monopolization

Polymorphic Style

Dialog Box Control

Tooltip Control

Modal Transition Settings

Modal Transition

Sheet Transition

Dynamic Attributes and Customization

Attribute Modifier

Gesture Modifier

Drawing Modifier

Content Modifier

Custom Property

Symbol Glyph Modifier

Attribute Modifier Utility

Toolbar Configuration

Node Inspector Label

Gesture Handling

Binding Gestures

Gesture Binding

Bound Gesture Configuration

Gesture Handler

LongPressGesture

RotationGesture

Combined Gestures

Gesture Control

Custom Gesture Judgment

Gesture Blocking Enhancement

Gesture Common APIs

Row, Column, and Stack

RelativeContainer

ContainerReader

SideBarContainer

Scrolling and Swiping

LazyVGridLayout

LazyVWaterFlowLayout

LazyColumnLayout

LazyDynamicLayout

Scrollable Component Common APIs

Navigation and Switching

MultiNavigation

Buttons and Selection

UIPickerComponent

Picker Common APIs

SelectionContainer

Text Box Component Common APIs

Text Component Common APIs

Images and Videos

Image Analysis Types

Enhanced SVG Tag Parsing

Information Display

AlphabetIndexer

ArcAlphabetIndexer

LoadingProgress

Information Display APIs

Blank and Divider

CanvasRenderingContext2D

DrawingRenderingContext

OffscreenCanvas

OffscreenCanvasRenderingContext2D

Common Canvas Drawing Properties

Common Canvas Rendering Methods

Graphics Drawing

Common Attributes for Graphics Drawing

Rendering and Drawing

EmbeddedComponent

Property Animation (animation)

Explicit Animation (animateTo)

Keyframe Animation (keyframeAnimateTo)

Page Transition (pageTransition)

Component Transition (transition)

Shared Element Transition (sharedTransition)

Implicit Shared Element Transition (geometryTransition)

Motion Path Animation (motionPath)

Particle Animation (Particle)

Immediate Delivery of Explicit Animation (animateToImmediately)

Alert Dialog Box (AlertDialog)

Action Sheet (ActionSheet)

Custom Dialog Box (CustomDialog)

Calendar Picker Dialog Box (CalendarPickerDialog)

Date Picker Dialog Box (DatePickerDialog)

Time Picker Dialog Box (TimePickerDialog)

Text Picker Dialog Box (TextPickerDialog)

Dialog Box (Dialog)

Security Component Universal Attributes

AtomicServiceNavigation

AtomicServiceSearch

AtomicServiceTabs

AtomicServiceWeb

InterstitialDialogAction

HalfScreenLaunchComponent

NavPushPathHelper

Custom placeholder component

Custom Component

Custom Component Lifecycle

Lifecycle of a Custom Component (Recommended)

Custom Component Layout

Custom Component Built-in APIs

Custom Component Parameters

Custom Component Decorators

@Component: Custom Component

@ComponentV2: Custom Component V2

@Entry: Page Entry Declaration

Component Extension Decorators

@AnimatableExtend: Animatable Property Definition

@Builder Decorator: Custom Builder Function

@BuilderParam Decorator: Referencing the @Builder Function

@Extend: Extended Component Styles

@LocalBuilder Decorator: Maintaining Component Relationships

@Require Decorator: Validating Constructor Input Parameters

@Reusable: Reusing Components

@ReusableV2: Component Reuse V2

@Styles: Component Reuse Styles

Component Preview

Component Preview

System Preset UI Component Library

ComposeListItem

ComposeListItemV2

ComposeTitleBar

ComposeTitleBarV2

DownloadFileButton

EditableTitleBar

EditableTitleBarV2

ExceptionPrompt

ExceptionPromptV2

FoldSplitContainer

FullScreenLaunchComponent

GridObjectSortComponent

ProgressButtonV2

SegmentButtonV2

SwipeRefresherV2

advanced.Counter

DatePickerComponent

State Management and Rendering Control

State Management with Application-Level Variables

Built-in Environment Variables

State Management V1 Decorators

@Consume: Implementing Two-Way Synchronization with Descendant Components

@Link: Two-Way Synchronization Between Parent and Child Components

@LocalStorageLink: Bidirectional Data Synchronization with LocalStorage

@LocalStorageProp: Unidirectional Data Synchronization with LocalStorage

@ObjectLink: Observing Property Changes in Nested Class Objects

@Observed: Observing Property Changes in Nested Class Objects

@Prop: Implementing One-Way Synchronization from Parent to Child Components

@Provide: Implementing Two-Way Synchronization with Descendant Components

@State: State Owned by Component

@StorageLink: Bidirectional Data Synchronization with AppStorage

@StorageProp: Unidirectional Data Synchronization with AppStorage

@Track: Implementing Class Object Property-Level Updates

@Watch: Getting Notified of State Variable Changes

State Management V2 Decorators

@Computed: Declaring Computed Properties

@Consumer: Synchronizing Across Component Levels in a Two-Way Manner

@Event: Standardizing Component Output

@Local: Representing the Internal State of Components

@Monitor: Listening for Value Changes of the State Variables

@ObservedV2: Observing Class Property Changes

@Once: Implementing Initialization Once

@Param: Inputting External Parameters to Components

@Provider: Synchronizing Across Component Levels in a Two-Way Manner

@SyncMonitor: Synchronous Listening for Value Changes of the State Variables

@Trace: Observing Class Property Changes

@Type: Marking Types of Class Properties

Reactive Environment Variables

@Env: Environment Variable

WithEnv: Environment Variable Container

@CustomEnv: Custom Environment Variable

Common Definitions

Common Event Callbacks

Deprecated Components and APIs

JavaScript Components

JavaScript-compatible Web-like Development Paradigm (ArkUI.Full)

Universal Components

Universal Attributes

Universal Styles

Universal Events

Universal Methods

Animation Styles

Gradient Styles

Transition Styles

Custom Font Styles

Container Components

list-item-group

Basic Components

Media Components

Canvas Components

CanvasRenderingContext2D

OffscreenCanvas

OffscreenCanvasRenderingContext2D

Grid Components

Universal Attributes

animateTransform

Custom Components

Basic Usage of Custom Components

Data Transfer and Processing

Style Inheritance

Lifecycle Definition

Crown Rotation Event Monitoring

Dynamic Component Creation

Data Type Attributes

JavaScript-compatible Web-like Development Paradigm (ArkUI.Lite)

Framework Overview

File Organization

Multi-Language Capability

Universal Components

Universal Events

Universal Attributes

Universal Styles

Animation Styles

Container Components

Basic Components

Canvas Components

CanvasRenderingContext2D

Monitoring Rotating Crown Events

JavaScript Service Widget UI Components

Framework Overview

File Organization

Multi-Language Capability

Version Compatibility Adaptation

Theme Configuration

Universal Components

Universal Attributes

Universal Styles

Universal Events

Gradient Styles

Custom Font Styles

Container Components

Basic Components

Custom Component Basic Usage

ArkUI_NativeModule

ArkUI_Accessibility

OH_NativeXComponent Native XComponent

ArkUI_EventModule

OH_DisplayManager

ArkUI_RenderNodeUtils

common_attributes.h

drag_and_drop.h

drawable_descriptor.h

image_animator.h

embedded_component.h

native_animate.h

native_dialog.h

native_gesture.h

native_interface.h

native_interface_accessibility.h

native_interface_focus.h

native_interface_xcomponent.h

native_key_event.h

native_material.h

ArkUI_NodeAttributeType (Basic Attribute)

ArkUI_NodeAttributeType (General Attribute)

ArkUI_NodeAttributeType (Layout Attribute)

ArkUI_NodeAttributeType (Layout Component Attribute)

ArkUI_NodeAttributeType (Animation and Visual Effect Attributes)

ArkUI_NodeAttributeType (Interaction Attribute)

ArkUI_NodeAttributeType (Form Component Attribute)

ArkUI_NodeAttributeType (Scrollable Container Component Attribute)

ArkUI_NodeAttributeType (Navigation Component Attribute)

ArkUI_NodeAttributeType (Information Display Component Attribute)

ArkUI_NodeAttributeType (Information Selection Component Attribute)

ArkUI_NodeAttributeType (Accessibility Attribute)

ArkUI_NodeAttributeType (Text Display Component Attribute)

ArkUI_NodeAttributeType (Text Input Component Attribute)

ArkUI_NodeAttributeType (Rich Text Component Attribute)

ArkUI_NodeAttributeType (Image Component Attribute)

ArkUI_NodeAttributeType (XComponent Attribute)

ArkUI_NodeAttributeType (EmbeddedComponent Attribute)

ArkUI_NodeAttributeType (Others)

custom_attributes.h

native_node_napi.h

native_render.h

native_type_visual.h

native_xcomponent_key_event.h

navigation_router.h

styled_string.h

ui_input_event.h

oh_window_comm.h

oh_window_event_filter.h

oh_window_pip.h

oh_display_capture.h

oh_display_info.h

oh_display_manager.h

ArkUI_NodeEvent

ArkUI_DragEvent

ArkUI_DragPreviewOption

ArkUI_DragAction

ArkUI_DragAndDropInfo

ArkUI_DrawableDescriptor

ArkUI_DrawableDescriptor_AnimationController

OH_ArkUI_FontConfigs

OH_ArkUI_FontWeightConfigs

OH_PixelmapNative*

ArkUI_ExpectedFrameRateRange

ArkUI_AnimateCompleteCallback

ArkUI_NativeAnimateAPI_1

ArkUI_AnimateOption

ArkUI_KeyframeAnimateOption

ArkUI_AnimatorOption

ArkUI_Animator*

ArkUI_AnimatorEvent

ArkUI_AnimatorOnFrameEvent

ArkUI_TransitionEffect

ArkUI_NativeDialogAPI_1

ArkUI_NativeDialogAPI_2

ArkUI_NativeDialogAPI_3

ArkUI_DialogDismissEvent

ArkUI_CustomDialogOptions

ArkUI_NativeGestureAPI_1

ArkUI_NativeGestureAPI_2

ArkUI_GestureRecognizer

ArkUI_GestureInterruptInfo

ArkUI_GestureEvent

ArkUI_GestureEventTargetInfo

ArkUI_GestureCollectInterceptInfo

ArkUI_ParallelInnerGestureEvent

ArkUI_TouchRecognizer

ArkUI_TouchRecognizerHandle

ArkUI_TouchRecognizerHandleArray

ArkUI_GestureRecognizerHandle

ArkUI_GestureRecognizerHandleArray

ArkUI_AccessibleAction

ArkUI_AccessibleRect

ArkUI_AccessibleRangeInfo

ArkUI_AccessibleGridInfo

ArkUI_AccessibleGridItemInfo

ArkUI_AccessibilityProviderCallbacks

ArkUI_AccessibilityProviderCallbacksWithInstance

ArkUI_AccessibilityElementInfo

ArkUI_AccessibilityEventInfo

ArkUI_AccessibilityProvider

ArkUI_AccessibilityActionArguments

ArkUI_AccessibilityElementInfoList

OH_NativeXComponent_HistoricalPoint

OH_NativeXComponent_TouchPoint

OH_NativeXComponent_TouchEvent

OH_NativeXComponent_MouseEvent

OH_NativeXComponent_Callback

OH_NativeXComponent_MouseEvent_Callback

OH_NativeXComponent_ExpectedRateRange

OH_NativeXComponent

OH_NativeXComponent_KeyEvent

OH_NativeXComponent_ExtraMouseEventInfo

OH_ArkUI_SurfaceHolder

OH_ArkUI_SurfaceCallback

ArkUI_XComponentSurfaceConfig

ArkUI_AttributeItem

ArkUI_NodeComponentEvent

ArkUI_StringAsyncEvent

ArkUI_TextChangeEvent

ArkUI_NativeNodeAPI_1

OH_ArkUI_TextEditorChangeEvent

ArkUI_NodeCustomEvent

ArkUI_NodeAdapter*

ArkUI_NodeAdapterEvent

ArkUI_NodeContentEvent

ArkUI_ContextCallback

ArkUI_NumberValue

ARKUI_TextPickerRangeContent

ARKUI_TextPickerCascadeRangeContent

ArkUI_ColorStop

ArkUI_IntOffset

ArkUI_Matrix4RotationOptions

ArkUI_Matrix4ScaleOptions

ArkUI_Matrix4TranslationOptions

ArkUI_TranslationOptions

ArkUI_ScaleOptions

ArkUI_RotationOptions

ArkUI_NativeDialog

ArkUI_LayoutConstraint

ArkUI_DrawContext

ArkUI_NativeDialog*

ArkUI_WaterFlowSectionOption

ArkUI_ListItemSwipeActionItem

ArkUI_ListItemSwipeActionOption

ArkUI_NodeContent*

ArkUI_AlignmentRuleOption

ArkUI_GuidelineOption

ArkUI_BarrierOption

ArkUI_ImageAnimatorFrameInfo

ArkUI_ListChildrenMainSize

ArkUI_ProgressLinearStyleOption

ArkUI_CustomProperty

ArkUI_HostWindowInfo

ArkUI_ActiveChildrenInfo

ArkUI_CrossLanguageOption

AbilityBase_Want

ArkUI_EmbeddedComponentOption

ArkUI_AccessibilityState

ArkUI_AccessibilityValue

ArkUI_SystemFontStyleEvent

ArkUI_CustomSpanMeasureInfo

ArkUI_CustomSpanMetrics

ArkUI_CustomSpanDrawInfo

ArkUI_SwiperIndicator

ArkUI_SwiperDigitIndicator

ArkUI_SwiperArrowStyle

ArkUI_StyledString_Descriptor

ArkUI_SnapshotOptions

ArkUI_TextPickerRangeContentArray

ArkUI_TextCascadePickerRangeContentArray

ArkUI_SelectionOptions

ArkUI_VisibleAreaEventOptions

ArkUI_PositionEdges

ArkUI_PixelRoundPolicy

ArkUI_MotionPathOptions

ArkUI_StyledString

OH_ArkUI_SpanStyle

OH_ArkUI_ImageAttachment

OH_ArkUI_CustomSpan

OH_ArkUI_TextStyle

OH_ArkUI_ParagraphStyle

OH_ArkUI_GestureStyle

OH_ArkUI_TextShadowStyle

OH_ArkUI_DecorationStyle

OH_ArkUI_BaselineOffsetStyle

OH_ArkUI_LetterSpacingStyle

OH_ArkUI_LineHeightStyle

OH_ArkUI_LineSpacingStyle

OH_ArkUI_UrlStyle

OH_ArkUI_BackgroundColorStyle

OH_ArkUI_UserDataSpan

OH_ArkUI_LeadingMarginSpanDrawInfo

ArkUI_TextLayoutManager

ArkUI_TextMarqueeOptions

ArkUI_UIInputEvent

ArkUI_ShowCounterConfig

ArkUI_TextContentBaseController

PictureInPicture_PipConfig

WindowManager_Rect

OH_PixelmapNative

WindowManager_WindowProperties

WindowManager_AvoidArea

WindowManager_MainWindowInfo

WindowManager_WindowSnapshotConfig

OH_WindowManager_FrameMetrics

OH_WindowManager_DensityInfo

NativeDisplayManager_Rect

NativeDisplayManager_WaterfallDisplayAreaRects

NativeDisplayManager_CutoutInfo

NativeDisplayManager_DisplayHdrFormat

NativeDisplayManager_DisplayColorSpace

NativeDisplayManager_DisplayInfo

NativeDisplayManager_DisplaysInfo

ArkUI_CircleShape

ArkUI_ColorAnimatableProperty*

ArkUI_ColorProperty*

ArkUI_CommandPath

ArkUI_FloatAnimatableProperty*

ArkUI_FloatProperty*

ArkUI_ImmersiveMaterial

ArkUI_ImmersiveMaterial*

ArkUI_LightEffectOptions

ArkUI_LightEffectOptions*

ArkUI_NodeBorderColor

ArkUI_NodeBorderRadius

ArkUI_NodeBorderStyle

ArkUI_NodeBorderWidth

ArkUI_RectShape

ArkUI_RenderContentModifier*

ArkUI_RenderNodeClipOption

ArkUI_RenderNode*

ArkUI_RenderNodeMaskOption

ArkUI_RenderBlurStyleOption

ArkUI_RoundRectShape

ArkUI_Vector2AnimatableProperty*

ArkUI_Vector2Property*

ArkUI_ContentTransitionEffect

ArkUI_CoastingAxisEvent

ArkUI_GridItemRect

ArkUI_GridItemSize

ArkUI_GridLayoutOptions

ArkUI_TouchTestInfo

ArkUI_TouchTestInfoItem

ArkUI_TouchTestInfoItem*

ArkUI_TouchTestInfoItemHandle*

ArkUI_TextMenuItem

ArkUI_TextMenuItemArray

ArkUI_TextEditMenuOptions

ArkUI_TextSelectionMenuOptions

ArkUI_SelectedDragPreviewStyle

ArkUI_PickerIndicatorBackground

ArkUI_PickerIndicatorDivider

ArkUI_PickerIndicatorStyle

OH_ArkUI_DecorationStyleOptions

OH_ArkUI_TextDataDetectorConfig

OH_ArkUI_TextEditorSelectionMenuOptions

OH_ArkUI_TextEditorPlaceholderOptions

OH_ArkUI_TextEditorStyledStringController

OH_ArkUI_TextEditorParagraphStyle

OH_ArkUI_ShadowOptions

OH_ArkUI_TextEditorTextStyle

OH_ArkUI_TextController

ArkUI_NativeGestureAPI_3

ArkUI_ParallelGestureEvent

OH_ArkUI_LinearGradientOptions

OH_ArkUI_RadialGradientOptions

API Call Error Codes

Popup Window Error Codes

Router Error Codes

Drag Event Error Codes

AI Image Analyzer Error Codes

Focus Error Codes

System Resource Error Codes

Auxiliary Node Error Codes

Sheet Error Codes

Scrollable Component Error Codes

Snapshot Error Codes

Styled String Error Codes

UI Context Error Codes

Render State Listening Error Codes

Interaction Event Error Codes

Canvas Component Error Codes

Custom Node Error Codes

Error Codes for Dynamic Attribute Configuration

Error Codes of Logic Components

UIExtension Error Codes

UI Appearance Error Codes

NodeAdapter Error Codes

XComponent Error Codes

Video Component Error Codes

State Management Error Codes

Render Node Error Codes

DrawableDescriptor Error Codes

Environment Variable Error Codes

Color Inversion Error Codes

Display Error Codes

Window Error Codes

Compilation Error Codes

@ohos.web.webview (Webview)

Module Description

Class (AdsBlockManager)

Class (BackForwardCacheOptions)

Class (BackForwardCacheSupportedFeatures)

Class (GeolocationPermissions)

Class (JsMessageExt)

Class (MediaSourceInfo)

Class (NativeMediaPlayerSurfaceInfo)

Class (PdfData)

Class (ProxyConfig)

Class (PrefetchOptions)

Class (ProxyController)

Class (ProxyRule)

Class (SecurityParams)

Class (WebviewController)

AIPageInteraction

Class (WebCookieManager)

Class (WebDataBase)

Class (WebDownloadDelegate)

Class (WebDownloadItem)

Class (WebDownloadManager)

Class (WebHttpBodyStream)

Class (WebMessageExt)

Class (WebResourceHandler)

Class (WebSchemeHandler)

Class (WebSchemeHandlerRequest)

Class (WebSchemeHandlerResponse)

Class (WebStorage)

Class (UserAgentBrandVersion)

Class (UserAgentMetadata)

Interface (BackForwardList)

Interface (NativeMediaPlayerBridge)

Interface (NativeMediaPlayerHandler)

Interface (WebMessagePort)

Interfaces (Others)

@ohos.web.netErrorList(The List of ArkWeb Network Protocol Stack Errors)

@ohos.web.WebNativeMessagingExtensionAbility (Web Native Messaging Extension Ability)

@ohos.web.WebNativeMessagingExtensionContext (Web Native Messaging Extension Context)

@ohos.web.webNativeMessagingExtensionManager (Web Native Messaging Extension Manager)

ArkTS Components

Class (ClientAuthenticationHandler)

Class (ConsoleMessage)

Class (ControllerHandler)

Class (DataResubmissionHandler)

Class (EventResult)

Class (FileSelectorParam)

Class (FileSelectorResult)

Class (FullScreenExitHandler)

Class (HttpAuthHandler)

Class (JsGeolocation)

Class (JsResult)

Class (PermissionRequest)

Class (ScreenCaptureHandler)

Class (SslErrorHandler)

Class (VerifyPinHandler)

Class (WebContextMenuParam)

Class (WebContextMenuResult)

Class (WebCookie)

Class (WebKeyboardController)

Class (WebResourceError)

Class (WebResourceRequest)

Class (WebResourceResponse)

Interfaces (Others)

Class (WebController)

arkweb_error_code.h

arkweb_interface.h

arkweb_net_error_list.h

arkweb_scheme_handler.h

native_interface_arkweb.h

ArkWeb_AnyNativeAPI

ArkWeb_BlanklessInfo

ArkWeb_SchemeHandler_

ArkWeb_ResourceHandler_

ArkWeb_Response_

ArkWeb_ResourceRequest_

ArkWeb_RequestHeaderList_

ArkWeb_HttpBodyStream_

ArkWeb_JavaScriptBridgeData

ArkWeb_WebMessage*

ArkWeb_JavaScriptValue*

ArkWeb_WebMessagePort*

ArkWeb_JavaScriptObject

ArkWeb_ProxyMethod

ArkWeb_ProxyMethodWithResult

ArkWeb_ProxyObject

ArkWeb_ProxyObjectWithResult

ArkWeb_ControllerAPI

ArkWeb_ComponentAPI

ArkWeb_WebMessagePortAPI

ArkWeb_WebMessageAPI

ArkWeb_CookieManagerAPI

ArkWeb_JavaScriptValueAPI

Webview Error Codes

Background Tasks Kit

@ohos.reminderAgentManager (Agent-powered Reminder)

@ohos.resourceschedule.backgroundTaskManager (Background Task Management)

@ohos.resourceschedule.workScheduler (Deferred Task Scheduling)

@ohos.WorkSchedulerExtensionAbility (Deferred Task Scheduling Callbacks)

@ohos.resourceschedule.backgroundProcessManager (Background Child Process Management)

WorkSchedulerExtensionContext

APIs No Longer Maintained

@ohos.backgroundTaskManager (Background Task Management)

@ohos.bundleState (Device Usage Statistics)

@ohos.reminderAgent (Agent-powered Reminder)

BackgroundProcessManager

background_process_manager.h

transient_task_api.h

transient_task_type.h

TransientTask_DelaySuspendInfo

TransientTask_TransientTaskInfo

backgroundTaskManager Error Codes

backgroundProcessManager Error Codes

reminderAgentManager Error Codes

workScheduler Error Codes

Content Embed Kit

content_embed_common.h

content_embed_document.h

content_embed_extension.h

content_embed_proxy.h

ContentEmbed_Document

ContentEmbed_Storage

ContentEmbed_StorageElement

ContentEmbed_StorageElements

ContentEmbed_Stream

ContentEmbed_ExtensionContext

ContentEmbed_ExtensionContext*

ContentEmbed_ExtensionInstance

ContentEmbed_ExtensionInstance*

ContentEmbed_Object

ContentEmbed_Object*

ContentEmbed_Info

ContentEmbed_Format

ContentEmbed_ExtensionProxy

ContentEmbed_Capability

@ohos.application.BackupExtensionAbility (Backup and Restore Extension Capability)

@ohos.file.cloudSync (Device-Cloud Sync)

@ohos.file.cloudSyncManager (Device-Cloud Sync Management)

@ohos.file.environment (Directory Environment Capability)

@ohos.file.fileuri (File URI)

@ohos.file.fs (File Management)

@ohos.file.hash (File Hash Processing)

@ohos.file.picker (Picker)

@ohos.file.securityLabel (Data Label)

@ohos.file.statvfs (File System Space Statistics)

@ohos.file.storageStatistics (Application Storage Statistics)

@ohos.fileshare (File Sharing)

@ohos.file.BackupExtensionContext (Backup and Restore Extension Capability)

APIs No Longer Maintained

@ohos.document (File Operation)

@ohos.fileio (File Management)

@ohos.statfs (statfs)

@system.file (File Storage)

oh_environment.h

oh_file_share.h

oh_cloud_disk_manager.h

cloud_disk_error_code.h

oh_archive_errcode.h

FileShare_PolicyErrorResult

FileShare_PolicyInfo

CloudDisk_ChangeData

CloudDisk_ChangesResult

CloudDisk_DisplayNameInfo

CloudDisk_FailedList

CloudDisk_FileSyncState

CloudDisk_PathInfo

CloudDisk_ResultList

CloudDisk_SyncFolder

OH_Archive_StreamInfo

OH_Archive_Stream_Config

ArchiveWriteCtx

ArchiveStreamWriteCtx

ArchiveStreamReadCtx

File Management Error Codes

Data Augmentation Kit

rag (Retrieval Augmentation Generation)

retrieval (Intelligence Data Platform)

knowledgeProcessor (Knowledge Processing)

localChatModel (On-Device Q&A Model)

ArkTS API Error Codes

aip_error_code.h

aip_retrieval.h

aip_retrieval_condition.h

aip_retrieval_condition_vector.h

aip_retrieval_query.h

aip_retrieval_record.h

@ohos.app.form.formBindingData (formBindingData)

@ohos.app.form.FormExtensionAbility (FormExtensionAbility)

@ohos.app.form.formInfo (formInfo)

@ohos.app.form.formProvider (formProvider)

@ohos.app.form.FormEditExtensionAbility (FormEditExtensionAbility)

@ohos.app.form.LiveFormExtensionAbility (LiveFormExtensionAbility)

FormExtensionContext

FormEditExtensionContext

LiveFormExtensionContext

APIs No Longer Maintained

@ohos.application.formBindingData (formBindingData)

@ohos.application.formError (formError)

@ohos.application.formInfo (formInfo)

@ohos.application.formProvider (formProvider)

Widget Error Codes

@ohos.InputMethodExtensionAbility (InputMethodExtensionAbility)

@ohos.InputMethodExtensionContext (InputMethodExtensionContext)

@ohos.inputMethod.Panel (Input Method Panel)

@ohos.InputMethodSubtype (Input Method Subtype)

@ohos.inputMethod (Input Method Framework)

@ohos.inputMethodEngine (Input Method Service)

@ohos.inputMethodList (Input Method List)

@ohos.inputMethod.ExtraConfig (Input Method Extension Information)

inputmethod_attach_options_capi.h

inputmethod_controller_capi.h

inputmethod_cursor_info_capi.h

inputmethod_inputmethod_proxy_capi.h

inputmethod_private_command_capi.h

inputmethod_text_avoid_info_capi.h

inputmethod_text_config_capi.h

inputmethod_text_editor_proxy_capi.h

inputmethod_types_capi.h

InputMethod_AttachOptions

InputMethod_CursorInfo

InputMethod_InputMethodProxy

InputMethod_PrivateCommand

InputMethod_TextAvoidInfo

InputMethod_TextConfig

InputMethod_TextEditorProxy

Input Method Framework Error Codes

@ohos.rpc (RPC)

OHIPCRemoteObject

ipc_cremote_object.h

ipc_cskeleton.h

ipc_error_code.h

OH_IPC_MessageOption

OHIPCRemoteProxy

OHIPCRemoteStub

OHIPCDeathRecipient

RPC Error Codes

Localization Kit

@ohos.i18n (Internationalization)

@ohos.intl (Internationalization)

@ohos.resourceManager (Resource Management)

@ohos.sendableResourceManager (Resource Manager)

RawFileDescriptor

SendableResource

resourcemanager

raw_file_manager.h

resmgr_common.h

RawFileDescriptor

RawFileDescriptor64

NativeResourceManager

ResourceManager_Configuration

InitialTimeZoneRule

TimeArrayTimeZoneRule

AnnualTimeZoneRule

TimeZoneRuleQuery

I18N Error Codes

Resource Manager Error Codes

ArkTS API Error Codes

ArkTS Components

HdsNavigation (Navigation Root View Container)

HdsNavDestination (Navigation Child Page Container)

HdsListItemCard

HdsVisualComponent

MultiWindowEntryInAPP

HdsColorPicker (Color Picker Component)

System

Asset Store Kit

@ohos.security.asset (Asset Store Service)

Asset_ResultSet

Asset_SyncResult

Asset Store Service Error Code

Confidential Space Kit

@hms.security.confidentialSpace (Confidential Space Service)

ArkTS API Error Codes

Crypto Architecture Kit

@ohos.security.cryptoFramework (Crypto Framework)

APIs No Longer Maintained

@system.cipher (Cipher Algorithm)

CryptoArchitectureKit

CryptoAsymCipherApi

CryptoAsymKeyApi

CryptoCommonApi

CryptoDigestApi

CryptoKeyAgreementApi

CryptoSignatureApi

CryptoSymCipherApi

CryptoSymKeyApi

crypto_architecture_kit.h

crypto_asym_cipher.h

crypto_asym_key.h

crypto_common.h

crypto_digest.h

crypto_key_agreement.h

crypto_signature.h

crypto_sym_cipher.h

crypto_sym_key.h

Crypto_DataBlob

OH_CryptoAsymCipher

OH_CryptoSm2CiphertextSpec

OH_CryptoKeyPair

OH_CryptoPubKey

OH_CryptoPrivKey

OH_CryptoAsymKeyGenerator

OH_CryptoPrivKeyEncodingParams

OH_CryptoAsymKeySpec

OH_CryptoAsymKeyGeneratorWithSpec

OH_CryptoEcPoint

OH_CryptoDigest

OH_CryptoKdfParams

OH_CryptoKeyAgreement

OH_CryptoVerify

OH_CryptoEccSignatureSpec

OH_CryptoSymCipher

OH_CryptoSymCipherParams

OH_CryptoSymKey

OH_CryptoSymKeyGenerator

Crypto Framework Error Codes

Data Protection Kit

@ohos.dlpPermission (DLP)

@ohos.security.identifySensitiveContent (Identifying Sensitive Content)

DlpPermissionApi

dlp_permission_api.h

DLP Service Error Codes

Device Security Kit

RiskControlEngine

TrustedAppService

BusinessRiskIntelligentDetection

AntifraudPicker

TrustedAuthentication (Digital Shield)

SuperPrivacyMode

ArkTS API Error Codes

RiskControlEngine

TrustedAppService

BusinessRiskIntelligentDetection

AntifraudPicker

TrustedAuthentication (Digital Shield)

SuperPrivacyMode

DeviceSecurityMode

SecurityAntivirus

device_security_mode.h

security_audit.h

security_antivirus.h

SecurityAudit_Event

SecurityAudit_Filter

SecurityAntivirus_Antivirus

SecurityAudit_AuthClientConfiguration

Verifying a Device Token

Querying the Device Marking Status

Updating the Device Marking Status

Deleting the Device Marking Status

REST API Error Codes

Enterprise Data Guard Kit

fileGuard (Hierarchical File Management)

recoveryKey (Enterprise Recovery Key)

Enterprise Data Guard Kit Error Codes

Enterprise Threat Protection Kit

virusRemediation (Virus Detection and Handling)

ArkTS API Error Codes

Online Authentication Kit

ArkTS API Error Codes

FIDO2 (Passkey Service)

AuthenticationExtensionsClientOutputs

FIDO2_AttestationFormatsArray

FIDO2_AuthenticatorAttestationResponse

FIDO2_AuthenticatorMetadata

FIDO2_AuthenticatorMetadataArray

FIDO2_AuthenticatorResponse

FIDO2_AuthenticatorSelectionCriteria

FIDO2_AuthenticatorTransportArray

FIDO2_Capability

FIDO2_CapabilityArray

FIDO2_CredentialCreationOptionArray

FIDO2_CredentialCreationOptions

FIDO2_CredentialRequestOptions

FIDO2_PublicKeyAssertionCredential

FIDO2_PublicKeyAttestationCredential

FIDO2_PublicKeyCredentialCreationOptions

FIDO2_PublicKeyCredentialDescriptor

FIDO2_PublicKeyCredentialDescriptorArray

FIDO2_PublicKeyCredentialHintArray

FIDO2_PublicKeyCredentialParameters

FIDO2_PublicKeyCredentialRequestOptions

FIDO2_PublicKeyCredentialRpEntity

FIDO2_PublicKeyCredentialUserEntity

FIDO2_TokenBinding

Device Certificate Kit

@ohos.security.cert (Certificate)

@ohos.security.certManager (Certificate Management)

@ohos.security.certManagerDialog (Certificate Management Dialog Box)

CertManagerType

cm_native_api.h

cm_native_type.h

OH_CM_Credential

OH_CM_CredentialDetailList

Certificate Error Codes

Certificate Management Error Codes

Certificate Management Dialog Box Error Codes

Universal Keystore Kit

@ohos.security.huks (Universal Keystore)

@ohos.security.huksExternalCrypto (External Key Management)

@ohos.security.CryptoExtensionAbility (Key Extension Ability)

HuksExternalCryptoApi

HuksExternalCryptoTypeApi

HuksParamSetApi

native_huks_external_crypto_api.h

native_huks_external_crypto_type.h

native_huks_api.h

native_huks_param.h

native_huks_type.h

OH_Huks_ExternalCryptoParam

OH_Huks_ExternalCryptoParamSet

OH_Huks_ParamSet

OH_Huks_CertChain

OH_Huks_KeyInfo

OH_Huks_PubKeyInfo

OH_Huks_KeyMaterialRsa

OH_Huks_KeyMaterialEcc

OH_Huks_KeyMaterialDsa

OH_Huks_KeyMaterialDh

OH_Huks_KeyMaterial25519

OH_Huks_KeyAliasSet

HUKS Error Codes

User Authentication Kit

@ohos.userIAM.userAuth (User Authentication)

ArkTS Components

@ohos.userIAM.userAuthIcon (Embedded User Authentication Icons)

User Authentication Error Codes

accessoryAccessManager (Accessory Integration Management)

Connectivity Kit

@ohos.bluetooth.a2dp (Bluetooth A2DP Module)

@ohos.bluetooth.access (Bluetooth Access Module)

@ohos.bluetooth.baseProfile (Bluetooth baseProfile Module)

@ohos.bluetooth.ble (Bluetooth BLE Module)

@ohos.bluetooth.connection (Bluetooth Connection Module)

@ohos.bluetooth.constant (Bluetooth constant Module)

@ohos.bluetooth.common (Bluetooth Common Module)

@ohos.bluetooth.hfp (Bluetooth HFP Module)

@ohos.bluetooth.hid (Bluetooth HID Module)

@ohos.bluetooth.pan (Bluetooth PAN Module)

@ohos.bluetooth.socket (Bluetooth Socket Module)

@ohos.bluetooth.pbap (Bluetooth PBAP Module)

@ohos.bluetooth.map (Bluetooth MAP Module)

@ohos.connectedTag (Active Tags)

@ohos.nfc.cardEmulation (Standard NFC Card Emulation)

@ohos.nfc.controller (Standard NFC)

@ohos.nfc.tag (Standard NFC Tags)

@ohos.secureElement (SE Management)

@ohos.wifiManager (WLAN)

@ohos.wifiManagerExt (WLAN Extension)

@ohos.FusionConnectivity.partnerAgent (Device Status Notification Module)

@ohos.FusionConnectivity.PartnerAgentExtensionContext (Context for Device Status Notifications)

@ohos.FusionConnectivity.PartnerAgentExtensionAbility (ExtensionAbility Component Supporting Device Status Notifications)

@ohos.FusionConnectivity.ranging (Fusion Connectivity Ranging Module)

@ohos.nearlink.manager (Basic NearLink Management Capability)

@ohos.nearlink.remoteDevice (NearLink Remote Device Connection Capability)

@ohos.nearlink.advertising (NearLink Advertising Capability)

@ohos.nearlink.scan (NearLink Scanning Capability)

@ohos.nearlink.ssap (NearLink SSAP Connection Capability)

@ohos.nearlink.dataTransfer (NearLink Data Transfer Capability)

@ohos.nearlink.cdsm (CDSM Capability)

@ohos.nearlink.constant (NearLink Common Constants)

nfctech (Standard NFC Technologies)

tagSession (Standard NFC Tag Session)

Bluetooth Error Codes

Wi-Fi Error Codes

NFC Error Codes

SecureElement Error Codes

Error Codes of the Converged Short-Range Service Subsystem

NearLink Error Codes

APIs No Longer Maintained

@ohos.bluetooth (Bluetooth)

@ohos.bluetoothManager (Bluetooth)

@ohos.wifi (WLAN)

@ohos.wifiext (WLAN Extension)

@system.bluetooth (Bluetooth)

Distributed Service Kit

@ohos.distributedDeviceManager (Device Management)

@ohos.distributedsched.abilityConnectionManager (Cross-Device Connection Management)

@ohos.application.DistributedExtensionAbility (Distributed Extension)

@ohos.application.DistributedExtensionContext (Distributed Extension Context)

@ohos.distributedsched.linkEnhance (Enhanced Connection)

@ohos.distributedsched.proxyChannelManager (Proxy Channel Management)

oh_device_manager.h

oh_device_manager_err_code.h

Device Management Error Codes

Link Enhancement Error Codes

Proxy Channel Management Error Codes

manager (NearLink Enabling Capability)

remoteDevice (Capability to Connect to a Remote Device)

advertising (NearLink Advertising Capability)

scan (NearLink Scanning Capability)

ssap (NearLink SSAP Connection Capability)

dataTransfer (NearLink Data Transfer Capability)

cdsm (NearLink Collaborative Device Set Management Capability)

constant (NearLink Common Constants)

ArkTS API Error Codes

@ohos.net.connection (Network Connection Management)

@ohos.net.ethernet (Ethernet Connection Management)

@ohos.net.http (Data Request)

@ohos.net.mdns (MDNS Management)

@ohos.net.policy (Network Policy Management)

@ohos.net.socket (Socket Connection)

@ohos.net.statistics (Traffic Management)

@ohos.net.sharing (Network Sharing)

@ohos.net.vpnExtension (Enhanced VPN Management)

@ohos.net.vpn (VPN Management)

@ohos.net.webSocket (WebSocket Connection)

@ohos.net.netFirewall (Network Firewall)

@ohos.net.networkSecurity (Network Security)

@ohos.net.eap (Extensible Authentication)

@ohos.app.ability.VpnExtensionAbility (Enhanced VPN Management)

VpnExtensionContext

net_connection.h

net_connection_type.h

net_ssl_c_type.h

net_trafficfilter.h

net_trafficfilter_type.h

net_websocket.h

net_websocket_type.h

net_http_type.h

http_interceptor.h

http_interceptor_type.h

net_ethernet_type.h

NetConn_NetHandle

NetConn_NetCapabilities

NetConn_NetAddr

NetConn_HttpProxy

NetConn_ConnectionProperties

NetConn_NetHandleList

NetConn_NetSpecifier

NetConn_NetConnCallback

NetConn_ProbeResultInfo

NetConn_TraceRouteInfo

NetConn_TraceRouteOption

NetStack_CertBlob

NetStack_CertificatePinning

NetStack_Certificates

WebSocket_CloseResult

WebSocket_CloseOption

WebSocket_ErrorResult

WebSocket_OpenResult

WebSocket_Header

WebSocket_RequestOptions

Http_HeaderValue

Http_HeaderEntry

Http_ClientCert

Http_CustomProxy

Http_PerformanceTiming

Http_RequestOptions

Http_EventsHandler

OH_TrafficFilter_IPAddress

OH_TrafficFilter_IPCidr

OH_TrafficFilter_IPRange

OH_TrafficFilter_IPMulti

OH_TrafficFilter_IPMatch

OH_TrafficFilter_InterfaceMatch

OH_TrafficFilter_PortRange

OH_TrafficFilter_PortMulti

OH_TrafficFilter_PortMatch

OH_TrafficFilter_ConnectionInfo

OH_TrafficFilter_ProcessInfo

OH_TrafficFilter_RedirectRule

OH_TrafficFilter_Redirector

OH_Http_Interceptor_Headers

OH_Http_Interceptor_Request

OH_Http_Interceptor_Response

OH_Http_Interceptor

Ethernet_MacAddressInfo

Ethernet_MacAddrInfoList

Ethernet_NetAddr

Ethernet_NetAddrInfo

Ethernet_NetAddrList

APIs No Longer Maintained

@system.network (Network State)

@system.fetch (Data Request)

HTTP Error Codes

Socket Error Codes

WebSocket Error Codes

Network Connection Management Error Codes

Ethernet Connection Error Codes

Extended Authentication Error Codes

Network Sharing Error Codes

Policy Management Error Codes

MDNS Error Codes

Traffic Management Error Codes

VPN Error Codes

Network Security Error Codes

Kernel Error Codes

Firewall Error Codes

Network Boost Kit

netQuality (Network Quality)

netHandover (Network Handover)

netBoost (Network Acceleration)

ArkTS API Error Codes

network_boost_handover.h

network_boost_quality.h

network_boost.h

HMS_NetworkBoost_HandoverCallback

NetworkBoost_DataSpeedAction

NetworkBoost_HandoverComplete

NetworkBoost_HandoverStart

NetworkBoost_NetHandle

NetworkBoost_NetworkQos

NetworkBoost_NetworkQosArray

NetworkBoost_NetworkScene

NetworkBoost_WeakSignalPrediction

NetworkBoost_MultiPathQuota

NetworkBoost_MultiPathQuotaInfo

NetworkBoost_MultiPathRecommendation

NetworkBoost_MultiPathRequestResult

NetworkBoost_MultiPathStateChange

NetworkBoost_SceneDesc

Remote Communication Kit

rcp (Data Requests)

Unified Remote Procedure Call (URPC): High-Performance RPC Communication Library

RemoteCommunication

Rcp_CertificateAuthority

Rcp_ClientCertificate

Rcp_Configuration

Rcp_ConnectionConfiguration

Rcp_ContentOrPathOrCallback

Rcp_CookieAttributeEntry

Rcp_DnsConfiguration

Rcp_DnsOverHttps

Rcp_EventsHandler

Rcp_FormFieldFileValue

Rcp_FormFieldValue

Rcp_HeaderEntry

Rcp_HeaderValue

Rcp_InfoToCollect

Rcp_Interceptor

Rcp_InterceptorArray

Rcp_MultipartFormFieldValue

Rcp_OnDataReceiveCallback

Rcp_OnHeaderReceiveCallback

Rcp_OnProgressCallback

Rcp_OnVoidCallback

Rcp_ProxyConfiguration

Rcp_RequestContent

Rcp_RequestCookieEntry

Rcp_ResponseCallbackObject

Rcp_ResponseCookies

Rcp_SecurityConfiguration

Rcp_ServerAuthentication

Rcp_SessionConfiguration

Rcp_SessionListener

Rcp_StaticDnsRule

Rcp_StaticDnsRuleItem

Rcp_SyncInterceptor

Rcp_SyncInterceptorArray

Rcp_TracingConfiguration

Rcp_TransferConfiguration

Rcp_TransferRange

Rcp_OnBinaryReceiveCallback

Rcp_OnStatusCodeReceiveCallback

Rcp_OnGetDataCallback

Rcp_QuicIpAddress

Rcp_QuicStreamData

API Error Codes

Key Fields in Fault Logs

Service Collaboration Kit

@hms.collaboration.serviceInteraction (OneHop)

ArkTS Components

CollaborationCamera (Device Interconnectivity Component)

CollaborationService (Device Interconnectivity Component)

CollaborationDevicePicker (Hopping Control)

devicePicker (Device Selection Controller)

ServiceCollaboration

Header Files and Structs

service_collaboration_api.h

ServiceCollaboration_CollaborationDeviceInfo

ServiceCollaboration_CollaborationDeviceInfoSets

ServiceCollaboration_SelectInfo

ServiceCollaborationCallback

ServiceCollaboration_SelectInfoV2

@ohos.telephony.call (Call)

@ohos.telephony.data (Cellular Data)

@ohos.telephony.esim (eSIM Management)

@ohos.telephony.observer (Telephony Status Observer)

@ohos.telephony.radio (Network Search)

@ohos.telephony.sim (SIM Management)

@ohos.telephony.sms (SMS)

@ohos.telephony.vcard (VCard)

telephony_data.h

telephony_radio.h

telephony_radio_type.h

Telephony_NetworkState

Telephony Error Codes

Basic Functions

Basic Services Kit

Account Management

@ohos.account.appAccount (Application Account Management)

@ohos.account.distributedAccount (Distributed Account Management)

@ohos.account.osAccount (OS Account Management)

Device Management

@ohos.batteryInfo (Battery Information)

@ohos.busManager.serial (Serial Port Management)

@ohos.deviceInfo (Device Information)

@ohos.power (Power Management)

@ohos.runningLock (RunningLock)

@ohos.thermal (Thermal Management)

@ohos.usbManager (USB Manager)

@ohos.usbManager.serial (Serial Port Management)

Data File Processing

@ohos.app.ability.PrintExtensionAbility (PrintExtensionAbility)

PrintExtensionContext

@ohos.pasteboard (Pasteboard)

@ohos.print (Print)

@ohos.scan (Scan)

@ohos.request (Upload and Download)

@ohos.request.cacheDownload (Download and Cache)

@ohos.zlib (Zip)

@ohos.selectionInput.SelectionExtensionAbility (SelectionExtensionAbility)

@ohos.selectionInput.SelectionExtensionContext (Word Selection Extension Context)

@ohos.selectionInput.selectionManager (Word Selection Management)

@ohos.selectionInput.SelectionPanel (Word Selection Panel)

Process and Thread Communication

System Common Events

@ohos.commonEventManager (Common Event)

@ohos.events.emitter (Emitter)

CommonEventData

CommonEventPublishData

commonEventSubscriber

CommonEventSubscribeInfo

@ohos.base (Public Callback Information)

@ohos.annotation (Annotation)

@ohos.customization.customConfig (Custom Configurations)

@ohos.settings (Data Item Settings)

@ohos.settingsLite (Setting Information)

@ohos.wallpaper (Wallpaper)

@ohos.resourceschedule.systemload (System Load Level Management)

@ohos.systemDateTime (System Time and Time Zone)

@ohos.intelligentScene (Intelligent Scene)

APIs No Longer Maintained

System Common Events (Deprecated)

@ohos.commonEvent (Common Event) (Deprecated)

@ohos.usb (USB Manager) (No Longer Maintained)

@system.brightness (Screen Brightness)

@system.battery (Battery Information)

@system.device (Device Information)

@system.request (Upload and Download)

@ohos.screenLock (Screen Lock)

@ohos.systemTime (System Time and Time Zone)

ohbattery_info.h

oh_commonevent.h

oh_commonevent_support.h

oh_pasteboard.h

oh_pasteboard_err_code.h

os_account_common.h

CommonEvent_SubscribeInfo

CommonEvent_PublishInfo

CommonEvent_RcvData

Pasteboard_ProgressInfo

Pasteboard_GetDataParams

OH_PasteboardObserver

Print_DefaultValue

Print_PrinterCapability

Print_PrinterInfo

Print_PropertyList

Print_Resolution

Print_StringList

Print_PrintAttributes

Print_PrintDocCallback

Scan_ScannerDevice

Scan_PictureScanProgress

Scan_ScannerOptions

USB Error Codes

Serial Port Management Error Codes

Running Lock Error Codes

zlib Error Codes

Pasteboard Error Codes

Thermal Manager Error Codes

Upload and Download Error Codes

Time and Time Zone Service Error Codes

Event Error Codes

Power Manager Error Codes

Account Management Error Codes

Print Service Error Codes

Settings Error Codes

Word Selection Error Codes

Intelligent Scene Error Codes

deviceInfo Error Codes

@hms.fast.mathPrediction (Mathematical Prediction)

@hms.fast.schedulingOptimization (System Performance Optimization)

ArkTS API Error Codes

Header Files and Structs

fast_ads_concurrent_hashmap.h

fast_ads_segment_map.h

fast_common_def.h

fast_dsp_common.h

fast_dsp_transform.h

fast_solver_polynomial.h

fast_solver_rect_partition.h

fast_collections_hashmap.h

fast_utils_algorithm.h

scheduling_optimization.h

FAST_BiquadCoefficients

FAST_BiquadCoefficientsD

FAST_BiquadState

FAST_BiquadStateD

FAST_SplitComplex

FAST_SplitComplexD

HMS_FAST_SortData

Function Flow Runtime Kit

condition_variable.h

ffrt_function_header_t

ffrt_dependence_t

ffrt_task_attr_t

ffrt_queue_attr_t

ffrt_condattr_t

ffrt_mutexattr_t

ffrt_rwlockattr_t

ffrt_task_handle_t

@ohos.multimodalInput.inputDevice (Input Device)

@ohos.multimodalInput.inputEvent (Input Event)

@ohos.multimodalInput.intentionCode (Intention Code)

@ohos.multimodalInput.keyCode (Key Code)

@ohos.multimodalInput.keyEvent (Key Event)

@ohos.multimodalInput.mouseEvent (Mouse Event)

@ohos.multimodalInput.gestureEvent (Gesture Event)

@ohos.multimodalInput.pointer (Mouse Pointer)

@ohos.multimodalInput.touchEvent (Touch Event)

@ohos.multimodalInput.infraredEmitter (IR Management)

@ohos.multimodalInput.inputConsumer (Global Shortcut Keys)

@ohos.multimodalInput.inputEventClient (Input Event Injection)

oh_input_manager.h

oh_pointer_style.h

Input_InterceptorEventCallback

Input_DeviceListener

OH_PixelmapNative

Input_MouseEvent

Input_TouchEvent

Input_AxisEvent

Input_DeviceInfo

Input_InterceptorOptions

Input_CursorConfig

Input_CustomCursor

Input_CursorInfo

Global Shortcut Key Error Codes

Input Device Error Codes

Mouse Pointer Error Codes

IR Management Error Codes

Input Event Injection Error Codes

@ohos.enterprise.accountManager (Account Management)

@ohos.enterprise.adminManager (Administrator Permission Management)

@ohos.enterprise.applicationManager (Application Management)

@ohos.enterprise.bluetoothManager (Bluetooth Management)

@ohos.enterprise.browser (Browser Management)

@ohos.enterprise.bundleManager (Bundle Management)

@ohos.enterprise.common (Common Module)

@ohos.enterprise.deviceControl (Device Control Management)

@ohos.enterprise.deviceInfo (Device Information Management)

@ohos.enterprise.deviceSettings (Device Settings Management)

@ohos.enterprise.locationManager (Location Service Management)

@ohos.enterprise.networkManager (Network Management)

@ohos.enterprise.restrictions (Restrictions)

@ohos.enterprise.securityManager (Security Management)

@ohos.enterprise.systemManager (System Management)

@ohos.enterprise.usbManager (USB Management)

@ohos.enterprise.wifiManager (Wi-Fi Management)

@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)

@ohos.enterprise.telephonyManager (Telephony Management)

EnterpriseAdminExtensionContext

Enterprise Device Management Error Codes

Kernel Enhance Kit

OH_QoS_GewuCreateSessionResult

OH_QoS_GewuSubmitRequestResult

hotspot-accelerate

Hotspot Accelerate Error Codes

Service Support Kit

deviceDetection (Device Hardware Consistency Check)

ArkTS API Error Codes

navigationInfoMgr (Navigation Information Management)

smartMobilityCommon (Smart Mobility)

ArkTS API Error Codes

Driver Development Kit

@ohos.app.ability.DriverExtensionAbility (Driver Extension Ability)

@ohos.driver.deviceManager (Peripheral Management)

DriverExtensionContext

ScsiPeripheralDDK

hid_ddk_types.h

scsi_peripheral_api.h

scsi_peripheral_types.h

usb_ddk_types.h

usb_serial_api.h

usb_serial_types.h

Hid_EventTypeArray

Hid_KeyCodeArray

Hid_AbsAxesArray

Hid_RelAxesArray

Hid_MscEventArray

Hid_EventProperties

Hid_DeviceHandle

ScsiPeripheral_DeviceMemMap

ScsiPeripheral_IORequest

ScsiPeripheral_Request

ScsiPeripheral_Response

ScsiPeripheral_TestUnitReadyRequest

ScsiPeripheral_InquiryRequest

ScsiPeripheral_InquiryInfo

ScsiPeripheral_ReadCapacityRequest

ScsiPeripheral_CapacityInfo

ScsiPeripheral_RequestSenseRequest

ScsiPeripheral_BasicSenseInfo

ScsiPeripheral_VerifyRequest

ScsiPeripheral_Device

UsbControlRequestSetup

UsbDeviceDescriptor

UsbConfigDescriptor

UsbInterfaceDescriptor

UsbEndpointDescriptor

UsbDdkEndpointDescriptor

UsbDdkInterfaceDescriptor

UsbDdkInterface

UsbDdkConfigDescriptor

UsbDeviceMemMap

Usb_DeviceArray

Usb_NonRootHubArray

UsbSerial_Params

UsbSerial_Device

Driver Error Codes

Multimodal Awareness Kit

@ohos.stationary (Device Status Awareness Framework)

@ohos.multimodalAwareness.motion (Motion Awareness)

@ohos.multimodalAwareness.metadataBinding (Metadata Binding)

@ohos.multimodalAwareness.deviceStatus (Device Status Awareness)

@ohos.multimodalAwareness.userStatus (User Status Awareness)

Motion Awareness Error Codes

Metadata Binding Error Codes

Device Status Awareness Error Codes

User Status Awareness Error Codes

HandwriteController (Handwriting Suite Function)

PointPredictor (Point Prediction Function)

InstantShapeGenerator (Instant Shape Function)

imageFeaturePicker (Global Color Picker Function)

stylusInteraction (Stylus Interaction Function)

StylusFrameBoost (Stylus Frame Boost)

ArkTS Components

HandwriteComponent (Handwriting Suite Components)

GlobalColorPicker

Header Files and Structs

native_gcp_api.h

native_handwrite_api.h

HMS_GCP_PickedColorInfo

HandWrite_HistoricalPoint

ArkTS API Error Codes

Sensor Service Kit

@ohos.sensor (Sensor)

@ohos.vibrator (Vibrator)

@system.sensor (Sensor)

@system.vibrator (Vibrator)

oh_sensor_type.h

vibrator_type.h

Sensor_SubscriptionId

Sensor_SubscriptionAttribute

Sensor_Subscriber

Vibrator_Attribute

Vibrator_FileDescription

Sensor Error Codes

Vibrator Error Codes

@ohos.distributedHardware.mechanicManager (Mechanic Manager)

Mechanic Manager Error Codes

Wear Engine Kit

wearEngine (Wearable Capabilities)

wearEngineLite (Wearable Capabilities) (Lite)

ArkTS API Error Codes

AOD Navigation Kit

aodNaviManager (AOD Navigation Service)

ArkTS API Error Codes

Debugging Tools

Performance Analysis Kit

@ohos.hichecker (HiChecker)

@ohos.hidebug (HiDebug)

@ohos.hilog (HiLog)

@ohos.hiTraceChain (HiTraceChain)

@ohos.hiTraceMeter (HiTraceMeter)

@ohos.hiviewdfx.FaultLogExtensionAbility (Delayed Fault Notification)

@ohos.hiviewdfx.FaultLogExtensionContext (Delayed Fault Notification Context)

@ohos.hiviewdfx.hiAppEvent (Application Event Logging)

@ohos.hiviewdfx.hiRetrieval (Application Grayscale)

@ohos.hiviewdfx.jsLeakWatcher (ArkTS Leak Watcher)

APIs No Longer Maintained

@ohos.bytrace (ByTrace)

@ohos.hiAppEvent (HiAppEvent)

@ohos.faultLogger (FaultLogger)

hiappevent_cfg.h

hiappevent_event.h

hiappevent_param.h

HiAppEvent_AppEventInfo

HiAppEvent_AppEventGroup

HiAppEvent_Watcher

HiAppEvent_Processor

HiAppEvent_Config

HiCollie_DetectionParam

HiCollie_SetTimerParam

HiDebug_ThreadCpuUsage

HiDebug_SystemMemInfo

HiDebug_NativeMemInfo

HiDebug_MemoryLimit

OH_HiDebug_RequestTraceConfig

HiDebug_JsStackFrame

HiDebug_NativeStackFrame

HiDebug_StackFrame

HiDebug_MallocDispatch

HiDebug_Backtrace_Object__*

HiDebug_GraphicsMemorySummary

HiDebug_ProcessSamplerConfig

OH_HiDebug_ResProfilerConfig

OH_HiDebug_ProfilingResult

FaultLogger Error Codes

HiAppEvent Error Codes

HiDebug Error Codes

HiDebug CpuUsage Error Codes

HiDebug Trace Error Codes

HiCollie Error Codes

JsLeakWatcher Error Codes

Application Grayscale Error Codes

@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)

@ohos.application.testRunner (TestRunner)

@ohos.test.PerfTest

Dependent Elements and Definitions

AbilityDelegator

AbilityDelegatorArgs

APIs No Longer Maintained

@ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)

UiTest Error Codes

PerfTest Error Codes

Media

@ohos.multimedia.audio (Audio Management)

Module Description

Interface (AudioCapturer)

Interface (AudioDebuggingManager)

Interface (AudioDeviceEnhanceManager)

Interface (AudioManager)

Interface (AudioRecordingManager)

Interface (AudioRenderer)

Interface (AudioRoutingManager)

Interface (AudioSessionManager)

Interface (AudioSpatializationManager)

Interface (AudioStreamManager)

Interface (AudioVolumeGroupManager)

Interface (AudioVolumeManager)

Interface (AudioLoopback)

Interfaces (Others)

@ohos.multimedia.audioHaptic (Audio-Haptic)

@ohos.multimedia.systemSoundManager (System Sound Management)

SystemSoundPlayer (Sound Effect Player)

ArkTS Components

@ohos.multimedia.avVolumePanel (Volume Panel)

native_audiocapturer.h

native_audio_manager.h

native_audio_routing_manager.h

native_audio_session_manager.h

native_audio_stream_manager.h

native_audio_volume_manager.h

native_audiorenderer.h

native_audio_common.h

native_audio_accessory_common.h

native_audio_accessory_manager.h

native_audio_accessory_input_stream_manager.h

native_audio_converter.h

native_audio_device_base.h

native_audio_debugging_manager.h

native_audio_device_enhance_manager.h

native_audio_resource_manager.h

native_audiostream_base.h

native_audiostreambuilder.h

native_audio_suite_base.h

native_audio_suite_engine.h

native_audio_session_base.h

native_midi_base.h

OH_AudioManager

OH_AudioRoutingManager

OH_AudioSession_Strategy

OH_AudioSession_DeactivatedEvent

OH_AudioSession_StateChangedEvent

OH_AudioSessionManager

OH_AudioStreamManager

OH_AudioVolumeManager

OH_AudioDeviceDescriptorArray

OH_AudioDeviceDescriptor

OH_AudioDebuggingManager

OH_AudioDeviceEnhanceManager

OH_AudioResourceManager

OH_AudioWorkgroup

OH_AudioAccessoryManager

OH_AudioAccessory

OH_AudioAccessoryInputStream

OH_AudioAccessoryInfo

OH_AudioAccessoryNoiseReductionCapability

OH_AudioAccessoryCapabilities

OH_AudioStreamInfo

OH_AudioRenderer_Callbacks_Struct

OH_AudioCapturer_Callbacks_Struct

OH_AudioStreamBuilderStruct

OH_AudioRendererStruct

OH_AudioCapturerStruct

OH_AudioDataArray

OH_EqualizerFrequencyBandGains

OH_AudioSuiteEngineStruct

OH_AudioSuitePipelineStruct

OH_AudioNodeStruct

OH_AudioNodeBuilderStruct

OH_AudioSuite_SpaceRenderPositionParams

OH_AudioSuite_PureVoiceChangeOption

OH_AudioSuite_SpaceRenderExtensionParams

OH_AudioSuite_SpaceRenderRotationParams

OH_AudioConverter_Format

OH_AudioConverterStruct

OH_MIDIDeviceInformation

OH_MIDIPortInformation

OH_MIDIPortDescriptor

OH_MIDICallbacks

OH_MIDIClientStruct

OH_MIDIDeviceStruct

Audio Error Codes

native_avcapability.h

native_avcodec_audiocodec.h

native_avcodec_base.h

native_audio_channel_layout.h

native_audio_vivid.h

native_avbuffer.h

native_avbuffer_info.h

native_averrors.h

native_avformat.h

native_avmemory.h

native_avcodec_videobase.h

native_avcodec_videodecoder.h

native_avcodec_videoencoder.h

native_avdemuxer.h

native_avmuxer.h

native_avsource.h

native_cencinfo.h

OH_AVCapability

OH_AVCodecAsyncCallback

OH_AVCodecCallback

OH_AVDataSource

OH_AVDataSourceExt

OH_AVCodecBufferAttr

DRM_MediaKeySystemInfo

OH_CartesianPosition

OH_PolarPosition

OH_AudioObjectPosition

OH_AudioVividMetaBuilderStruct

APIs No Longer Maintained

avcodec_audio_channel_layout.h

native_avcodec_audiodecoder.h

native_avcodec_audioencoder.h

@ohos.multimedia.avsession (AVSession Management)

Module Description

Class (AVCastPickerHelper)

Interface (AVCastController)

Interface (AVSession)

Interface (AVSessionController)

Interfaces (Others)

@ohos.multimedia.avCastPickerParam (AVCastPicker Parameters)

@ohos.multimedia.avMusicTemplate (Audio Template)

Module Description

Class (AVMusicTemplate)

Class (AVMusicTemplateController)

Interfaces (Others)

ArkTS Components

@ohos.multimedia.avCastPicker (AVCastPicker)

@ohos.multimedia.avInputCastPicker (AVInputCastPicker)

native_avmetadata.h

native_avsession.h

native_avsession_errors.h

native_avcastcontroller.h

native_avplaybackstate.h

native_avqueueitem.h

native_avsession_base.h

native_deviceinfo.h

OH_AVMetadataBuilderStruct

OH_AVMetadataStruct

AVSession_PlaybackPosition

OH_AVCastController

OH_AVSession_AVPlaybackState

OH_AVSession_AVQueueItem

OH_AVSession_AVMediaDescription

OH_AVSession_AVMediaDescriptionBuilder

AVSession_OutputDeviceInfo

AVSession_DeviceInfo

AVSession Management Error Codes

Audio Template Error Codes

@ohos.multimedia.camera (Camera Management)

Module Description

Interface (Aperture)

Interface (ApertureQuery)

Interface (AutoDeviceSwitch)

Interface (AutoDeviceSwitchQuery)

Interface (AutoExposure)

Interface (AutoExposureQuery)

Interface (CameraInput)

Interface (CameraManager)

Interface (CameraOutput)

Interface (CapturePhoto)

Interface (ColorManagement)

Interface (ColorManagementQuery)

Interface (ControlCenter)

Interface (ControlCenterQuery)

Interface (Flash)

Interface (FlashQuery)

Interface (Focus)

Interface (FocusQuery)

Interface (Macro)

Interface (MacroQuery)

Interface (ManualExposure)

APIs (ManualExposureQuery)

APIs (ManualFocus)

Interface (ManualFocusQuery)

APIs (ManualIso)

Interface (ManualIsoQuery)

Interface (MetadataOutput)

Interface (OIS)

Interface (OISQuery)

Interface (Photo)

Interface (PhotoOutput)

Interface (PhotoSession)

Interface (PreviewOutput)

Interface (SecureSession)

Interface (Session)

Interface (Stabilization)

Interface (StabilizationQuery)

Interface (VideoOutput)

Interface (VideoSession)

Interface (WhiteBalance)

Interface (WhiteBalanceQuery)

Interface (Zoom)

Interface (ZoomQuery)

Interfaces (Others)

Deprecated Interface (CaptureSession, deprecated)

@ohos.multimedia.cameraPicker (Camera Picker)

camera_device.h

camera_manager.h

capture_session.h

metadata_output.h

metadata_object_ext.h

preview_output.h

Camera_FrameRateRange

Camera_VideoProfile

Camera_OutputCapability

Camera_DeviceQueryInfo

Camera_StatusInfo

Camera_Location

Camera_PhotoCaptureSetting

OH_Camera_PhotoCaptureSettingExt

Camera_FrameShutterInfo

Camera_CaptureEndInfo

OH_Camera_Rect_Ext

Camera_MetadataObject

OH_Camera_MetadataObjectExt

Camera_TorchStatusInfo

Camera_SmoothZoomInfo

Camera_CaptureStartInfo

Camera_FrameShutterEndInfo

Camera_FoldStatusInfo

Camera_AutoDeviceSwitchStatusInfo

Camera_ConcurrentInfo

Camera_ControlCenterStatusInfo

CameraInput_Callbacks

CameraManager_Callbacks

CaptureSession_Callbacks

Camera_CaptureSession

MetadataOutput_Callbacks

Camera_MetadataOutput

PhotoOutput_Callbacks

Camera_PhotoOutput

PreviewOutput_Callbacks

Camera_PreviewOutput

VideoOutput_Callbacks

Camera_VideoOutput

Camera_OcclusionDetectionResult

OH_Camera_ZoomRange

OH_Camera_PhysicalAperture

OH_Camera_ZoomPointInfo

Camera Error Codes

@ohos.multimedia.drm (Digital Rights Management)

Module Description

Interface (MediaKeySession)

Interface (MediaKeySystem)

Interfaces (Others)

native_drm_common.h

native_drm_err.h

native_mediakeysession.h

native_mediakeysystem.h

DRM_MediaKeyRequestInfo

DRM_MediaKeyRequest

DRM_OfflineMediakeyIdArray

DRM_MediaKeyStatus

DRM_MediaKeySystemInfo

DRM_MediaKeySystemDescription

MediaKeySession

MediaKeySession_Callback

OH_MediaKeySession_Callback

DRM Error Codes

@ohos.multimedia.image (Image Processing)

Module Description

Interface (AuxiliaryPicture)

Interface (Image)

Interface (ImageCreator)

Interface (ImagePacker)

Interface (ImageReceiver)

Interface (ImageSource)

Interface (Metadata)

Class (ExifMetadata)

Class (MakerNoteHuaweiMetadata)

Class (HeifsMetadata)

Class (WebPMetadata)

Class (GifMetadata)

Class (JfifMetadata)

Class (TiffMetadata)

Class (PngMetadata)

Class (XMPMetadata)

Class (AvisMetadata)

Interface (Picture)

Interface (PixelMap)

Interfaces (Others)

@ohos.multimedia.sendableImage (Image Processing Based on Sendable Objects)

@ohos.multimedia.videoProcessingEngine (Video Processing Engine)

Image_NativeModule

ImageProcessing

image_packer_native.h

image_receiver_native.h

image_source_native.h

picture_native.h

pixelmap_native.h

image_mdk_common.h

image_packer_mdk.h

image_pixel_map_mdk.h

image_pixel_map_napi.h

image_receiver_mdk.h

image_source_mdk.h

image_effect_errors.h

image_effect_filter.h

image_processing.h

image_processing_types.h

OH_ImageSourceNative

OH_ImageSource_Info

OH_DecodingOptionsForPicture

OH_DecodingOptions

OH_PixelmapNative

OH_NativeBuffer

OH_Pixelmap_HdrStaticMetadata

OH_NativeColorSpaceManager

OH_Pixelmap_HdrDynamicMetadata

OH_Pixelmap_HdrGainmapMetadata

OH_Pixelmap_HdrMetadataValue

OH_Pixelmap_InitializationOptions

OH_Pixelmap_ImageInfo

OH_PictureMetadata

OH_ImagePackerNative

OH_ImageBufferData

OH_PackingOptions

OH_PackingOptionsForSequence

OH_ImageReceiverNative

OH_ImageReceiverOptions

OH_PictureNative

OH_AuxiliaryPictureNative

OH_AuxiliaryPictureInfo

OhosImageComponent

ImagePacker_Opts_

ImagePacker_Native_

OhosPixelMapInfos

NativePixelMap_

OhosPixelMapCreateOps

OhosPixelMapInfo

OhosImageReceiverInfo

ImageReceiverNative_

OhosImageRegion

ImageSourceNative_

OhosImageSourceOps

OhosImageDecodingOps

OhosImageSourceInfo

OhosImageSource

OhosImageSourceDelayTimeList

OhosImageSourceSupportedFormat

OhosImageSourceSupportedFormatList

OhosImageSourceProperty

OhosImageSourceUpdateData

ImageEffect_DataValue

OH_EffectFilter

OH_EffectFilterInfo

OH_EffectBufferInfo

ImageEffect_Any

ImageEffect_FilterNames

ImageEffect_FilterDelegate

ImageEffect_Region

ImageEffect_Size

ImageProcessing_ColorSpaceInfo

OH_ImageProcessing

Image_PositionArea

OH_ComposeOptions

OH_ImageRawData

OH_PictureNative_AuxiliaryPictureCopyItem

OH_PictureNative_MetadataCopyItem

Image Error Codes

Video Processing Engine Error Codes

@ohos.multimedia.media (Media)

Module Description

Interface (AVAdsController)

Interface (AVDownloaderManager)

Interface (AVImageGenerator)

Interface (AVMetadataExtractor)

Interface (AVPlayer)

Interface (AVRecorder)

Interface (AVScreenCaptureRecorder)

Interface (AVTranscoder)

Interface (MediaSource)

Interface (MediaSourceLoadingRequest)

Interfaces (Others)

Deprecated Interface (AudioPlayer, deprecated)

Deprecated Interface (AudioRecorder, deprecated)

Deprecated Interface (VideoPlayer, deprecated)

@ohos.multimedia.videoProcessing (Video Processing)

SoundPool (Sound Pool)

AVImageGenerator

AVMetadataExtractor

AVScreenCapture

LowPowerAudioSink

LowPowerVideoSink

VideoProcessing

avimage_generator.h

avimage_generator_base.h

avmetadata_extractor.h

avmetadata_extractor_base.h

avplayer_base.h

avrecorder_base.h

avtranscoder_base.h

native_avscreen_capture.h

native_avscreen_capture_base.h

native_avscreen_capture_errors.h

lowpower_audio_sink.h

lowpower_audio_sink_base.h

lowpower_avsink_base.h

lowpower_video_sink.h

lowpower_video_sink_base.h

video_processing.h

video_processing_types.h

avmedia_source.h

OH_AVImageGenerator

OH_AVMetadataExtractor

MediaKeySession

DRM_MediaKeySystemInfo

AVPlayerCallback

OH_AVRecorder_Profile

OH_AVRecorder_Location

OH_AVRecorder_MetadataTemplate

OH_AVRecorder_Metadata

OH_AVRecorder_Config

OH_AVRecorder_Range

OH_AVRecorder_EncoderInfo

OH_AVTranscoder

OH_AVTranscoder_Config

OH_AudioCaptureInfo

OH_AudioEncInfo

OH_VideoCaptureInfo

OH_VideoEncInfo

OH_RecorderInfo

OH_AVScreenCaptureConfig

OH_PrivacyProtectInfo

OH_AVScreenCaptureCallback

OH_NativeBuffer

OH_AVScreenCapture

OH_AVScreenCapture_ContentFilter

OH_AVScreenCapture_CaptureStrategy

OH_AVScreenCapture_UserSelectionInfo

OH_AVScreenCaptureHighlightConfig

OH_LowPowerAudioSink

OH_LowPowerAudioSinkCallback

OH_AVSamplesBuffer

OH_LowPowerVideoSink

OH_LowPowerVideoSinkCallback

VideoProcessing_ColorSpaceInfo

OH_VideoProcessing

VideoProcessing_Callback

OH_AVPlaybackStrategy

OH_AVMediaSource

OH_AVHttpHeader

OH_AVMediaSourceLoadingRequest

OH_AVMediaSourceLoader

OH_AVSeiMessageArray

OH_AVMetadataExtractor_OutputParam

OH_AVMetadataExtractor_FrameInfo

OH_MultiDisplayCapability

OH_AVPlayerVideoOutput

Media Error Codes

Media Library Kit

@ohos.file.photoAccessHelper (Album Management)

Module Description

Class (MediaAlbumChangeRequest)

Class (MediaAssetChangeRequest)

Class (MediaAssetsChangeRequest)

Class (MediaAssetManager)

Class (PhotoViewPicker)

Classes (Others)

Interface (AbsAlbum)

Interface (Album)

Interface (FetchResult)

Interface (MediaAssetDataHandler)

Interface (MediaAssetProgressHandler)

Interface (MovingPhoto)

Interface (PhotoAccessHelper)

Interface (PhotoAsset)

Interface (QuickImageDataHandler)

Interfaces (Others)

@ohos.file.sendablePhotoAccessHelper (Album Management Based on a Sendable Object)

ArkTS Components

@ohos.file.AlbumPickerComponent (AlbumPickerComponent)

@ohos.file.PhotoPickerComponent (PhotoPickerComponent)

@ohos.file.RecentPhotoComponent (RecentPhotoComponent)

@ohos.multimedia.movingphotoview (MovingPhotoView)

MediaAssetManager

media_access_helper_capi.h

media_asset_base_capi.h

media_asset_capi.h

media_asset_change_request_capi.h

media_asset_manager_capi.h

moving_photo_capi.h

MediaLibrary_RequestId

OH_MediaAssetManager

OH_MediaAssetChangeRequest

MediaLibrary_RequestOptions

Media Library Error Codes

ringtone (Ringtone Service)

ArkTS API Error Codes

customScan (Barcode Scanning by Custom UI)

detectBarcode (Recognizing Barcodes in an Image)

generateBarcode (Barcode Image Generation)

scanBarcode (Barcode Scanning by Default UI)

scanCore (Common Barcode Scanning Information)

ArkTS API Error Codes

Graphics

arEngine (AR Capabilities)

arViewController (AR Scene Management Capabilities)

ArkTS Components

ARView (AR Scene Visualization)

Header Files and Structs

ar_engine_core.h

AREngine_ARAugmentedImageSource

AREngine_ClipPlaneDistance

AREngine_ARSemanticDensePointData

AREngine_ARSemanticDenseCubeData

AR Engine Error Codes

@ohos.effectKit (Image Effects)

@ohos.graphics.colorSpaceManager (Color Space Management)

@ohos.graphics.sendableColorSpaceManager (Sendable Color Space Management)

@ohos.graphics.common2D (Common Data Types of 2D Graphics)

@ohos.graphics.displaySync (Variable Frame Rate)

@ohos.graphics.drawing (Drawing Module)

Module Description

Class (ColorFilter)

Class (ImageFilter)

Class (Lattice)

Class (MaskFilter)

Class (PathEffect)

Class (PathIterator)

Class (PointUtils)

Class (RectUtils)

Class (RoundRect)

Class (SamplingOptions)

Class (ShaderEffect)

Class (ShadowLayer)

Class (TextBlob)

Class (Typeface)

Class (TypefaceArguments)

Interfaces (Others)

@ohos.graphics.hdrCapability (HDR Capability)

@ohos.graphics.text (Text)

@ohos.graphics.uiEffect (Cascading Effect)

OH_NativeBuffer

NativeColorSpaceManager

NativeDisplaySoloist

buffer_common.h

native_buffer.h

native_color_space_manager.h

native_display_soloist.h

drawing_bitmap.h

drawing_brush.h

drawing_canvas.h

drawing_color.h

drawing_color_filter.h

drawing_color_space.h

drawing_error_code.h

drawing_filter.h

drawing_font_collection.h

drawing_font_mgr.h

drawing_gpu_context.h

drawing_image.h

drawing_image_filter.h

drawing_lattice.h

drawing_mask_filter.h

drawing_matrix.h

drawing_memory_stream.h

drawing_path_effect.h

drawing_path_iterator.h

drawing_pixel_map.h

drawing_point.h

drawing_record_cmd.h

drawing_region.h

drawing_register_font.h

drawing_round_rect.h

drawing_sampling_options.h

drawing_shader_effect.h

drawing_shadow_layer.h

drawing_surface.h

drawing_text_blob.h

drawing_text_declaration.h

drawing_text_font_descriptor.h

drawing_text_global.h

drawing_text_line.h

drawing_text_lineTypography.h

drawing_text_run.h

drawing_text_typography.h

drawing_typeface.h

drawing_types.h

effect_filter.h

buffer_handle.h

external_window.h

graphic_error_code.h

OH_NativeBuffer_ColorXY

OH_NativeBuffer_Smpte2086

OH_NativeBuffer_Cta861

OH_NativeBuffer_StaticMetadata

OH_NativeBuffer_Config

OH_NativeBuffer_Plane

OH_NativeBuffer_Planes

OH_NativeBuffer

ColorSpacePrimaries

WhitePointArray

DisplaySoloist_ExpectedRateRange

OH_Drawing_BitmapFormat

OH_Drawing_Font_Metrics

OH_Drawing_GpuContextOptions

OH_Drawing_RunBuffer

OH_Drawing_PlaceholderSpan

OH_Drawing_FontDescriptor

OH_Drawing_LineMetrics

OH_Drawing_FontFallbackInfo

OH_Drawing_FontFallbackGroup

OH_Drawing_FontAdjustInfo

OH_Drawing_FontAliasInfo

OH_Drawing_FontGenericInfo

OH_Drawing_FontConfigInfo

OH_Drawing_FontStyleStruct

OH_Drawing_FontFeature

OH_Drawing_StrutStyle

OH_Drawing_RectSize

OH_Drawing_Point2D

OH_Drawing_Point3D

OH_Drawing_Image_Info

OH_Drawing_RectStyle_Info

OH_Drawing_String

OH_Filter_ColorMatrix

OH_OnFrameAvailableListener

OH_NativeVSync_ExpectedRateRange

OHExtDataHandle

OH_NativeColorSpaceManager

OH_DisplaySoloist

NativePixelMap_

OH_PixelmapNative

OH_Drawing_FontCollection

OH_Drawing_Typography

OH_Drawing_TextStyle

OH_Drawing_TypographyStyle

OH_Drawing_LineTypography

OH_Drawing_TypographyCreate

OH_Drawing_TextBox

OH_Drawing_PositionAndAffinity

OH_Drawing_Range

OH_Drawing_TextShadow

OH_Drawing_FontParser

OH_Drawing_TextTab

OH_Drawing_TextLine

OH_Drawing_FontFullDescriptor

OH_Drawing_FontVariationAxis

OH_Drawing_FontVariationInstance

OH_Drawing_FontVariationInstanceCoordinate

OH_Drawing_Canvas

OH_Drawing_Region

OH_Drawing_Brush

OH_Drawing_Path

OH_Drawing_PathIterator

OH_Drawing_Lattice

OH_Drawing_Bitmap

OH_Drawing_Point

OH_Drawing_PixelMap

OH_Drawing_ColorSpace

OH_Drawing_PathEffect

OH_Drawing_Rect

OH_Drawing_RoundRect

OH_Drawing_Matrix

OH_Drawing_ShaderEffect

OH_Drawing_ShadowLayer

OH_Drawing_Filter

OH_Drawing_MaskFilter

OH_Drawing_ColorFilter

OH_Drawing_Font

OH_Drawing_FontFeatures

OH_Drawing_MemoryStream

OH_Drawing_FontArguments

OH_Drawing_Typeface

OH_Drawing_TextBlob

OH_Drawing_Image

OH_Drawing_ImageFilter

OH_Drawing_SamplingOptions

OH_Drawing_TextBlobBuilder

OH_Drawing_GpuContext

OH_Drawing_Surface

OH_Drawing_FontMgr

OH_Drawing_FontStyleSet

OH_Drawing_RecordCmdUtils

OH_Drawing_RecordCmd

OH_Drawing_Array

NativeWindowBuffer

colorSpaceManager Error Codes

Drawing and Display Error Codes

@ohos.graphics.scene (ArkGraphics 3D)

ScenePostProcessSettings

Graphics Accelerate Kit

assetDownloadManager (Resource Package Download Management)

AssetAccelerationExtensionAbility (ExtensionAbility for Resource Acceleration)

AssetAccelerationExtensionContext (ExtensionContext for Resource Acceleration)

launchAcceleration (Game Launch Acceleration)

gameBuddyService (Game Buddy Service)

ArkTS API Error Codes

GraphicsAccelerate

Header Files and Structs

frame_generation_base.h

frame_generation_gles.h

frame_generation_vk.h

FG_AlgorithmModeInfo

FG_ContextDescription_VK

FG_DispatchDescription_GLES

FG_DispatchDescription_VK

FG_ImageFormat_VK

FG_ImageInfo_VK

FG_ImageSync_VK

FG_ResolutionInfo

FG_PerFrameExtendedCameraInfo

FG_IntegrationInfo

OpenGTX_ConfigDescription

OpenGTX_FrameRenderInfo

OpenGTX_GameSceneInfo

OpenGTX_NetworkInfo

OpenGTX_NetworkLatency

OpenGTX_ResolutionValue

OpenGTX_Vector3

Spatial Recon Kit

spatial_recon_interface.h

HMS_SpatialRecon_ModelWriteInfo

HMS_SpatialRecon_DataFrame

HMS_SpatialRecon_Session

AREngine_ARSession

AREngine_ARFrame

Header Files and Structs

xeg_extension_defs.h

xeg_gles_adaptive_vrs.h

xeg_gles_extension.h

xeg_gles_neural_upscale.h

xeg_gles_spatial_upscale.h

xeg_gles_temporal_upscale.h

xeg_vulkan_adaptive_vrs.h

xeg_vulkan_common.h

xeg_vulkan_extension.h

xeg_vulkan_hps.h

xeg_vulkan_rt_reflection.h

xeg_vulkan_rt_visible_mask.h

xeg_vulkan_rtgi.h

xeg_vulkan_spatial_upscale.h

xeg_vulkan_temporal_upscale.h

xeg_vulkan_neural_upscale.h

xeg_control_display_separation.h

XEG_AdaptiveVRSCreateInfo

XEG_AdaptiveVRSDescription

XEG_DDGICreateInfo

XEG_DDGIDescription

XEG_DDGIVolumeEntryParameters

XEG_ExtensionProperties

XEG_HPSCreateInfo

XEG_HPSRadixSort

XEG_HPSRadixSortDescription

XEG_NNGICreateInfo

XEG_NNGIDescription

XEG_RTAOParameters

XEG_RTReflectionCreateInfo

XEG_RTReflectionDescription

XEG_RTShadowAOCreateInfo

XEG_RTShadowAODenoiserParameters

XEG_RTShadowAODescription

XEG_RTShadowParameters

XEG_SpatialUpscaleCreateInfo

XEG_SpatialUpscaleDescription

XEG_TemporalUpscaleCreateInfo

XEG_TemporalUpscaleDescription

XEG_NeuralUpscaleCreateInfo

XEG_NeuralUpscaleDescription

Application Services

@hms.core.authentication (Unified Authentication Service)

@hms.core.account.extendService (Enhanced Service)

@hms.core.account.shippingAddress (Shipping Address Management Service)

@hms.core.account.minorsProtection (Youth Mode)

@hms.core.account.invoiceAssistant (Invoice Assistant Service)

@hms.core.account.realName (Identity Verification Service)

@hms.core.account.intimate (My Circle)

ArkTS Components

LoginPanel (HUAWEI ID Sign-in Panel Component)

LoginWithHuaweiIDButton (HUAWEI ID Sign-in Button Component)

loginComponentManager (HUAWEI ID Sign-in Component Management)

ArkTS Error Codes

General Information

Open API Call Credentials

Obtaining a User-Level Credential

Refreshing a User-Level Credential

Parsing a Credential

Revoking Authorization for a User-Level Credential

Obtaining an App-Level Credential

Signing In After Authorization by QR Code Scanning

Obtaining QR Code Information

Obtaining a User-Level Credential

Obtaining User Information

Obtaining the UnionID/OpenID and Mobile Number Bound to a HUAWEI ID with One-Tap Sign-In

Obtaining HUAWEI ID User Information: Avatar and Nickname

Obtaining HUAWEI ID User Information: Mobile Number

Obtaining the Risk Level

Identity Verification

Obtaining Real-Name Information

Obtaining the Age Group of a User

Verifying Real-Name Information

Extended Capabilities

Obtaining the UnionID Through the OpenID

Obtaining the JWT Public Key for ID Token Verification

Verifying an ID Token

Obtaining OpenID Connect Public Configurations

Obtaining the UnionID/OpenID and Mobile Number Bound to a HUAWEI ID with One-Tap Sign-In (Not Recommended)

REST API Error Codes

@ohos.advertising (Ads Service Framework)

@ohos.identifier.oaid (OAID Service)

@ohos.advertising.AdsServiceExtensionAbility (Advertising Service Extension Ability)

Advertisement (Content of the Requested Ad)

ArkTS Components

@ohos.advertising.AdComponent (Ad Display Component)

@ohos.advertising.AutoAdComponent (Carousel Ad Display Component)

Ads Service Framework Error Codes

OAID Error Codes

moduleInstallManager (On-Demand Feature Distribution)

productViewManager (Recommendation on AppGallery)

sceneManager (Ecosystem Query Service)

updateManager (Update)

attributionManager (App Attribution Service)

attributionTestManager (Debugging During Access to the App Attribution Service)

privacyManager (Privacy Agreement Management Service)

appInfoManager (App Metadata Management Service)

commentManager (App Review Service)

ArkTS API Error Codes

module_install.h

Posting Back the Attribution Result

App Linking Kit

deferredLink (Deferred Link Capability)

@ohos.calendarManager (Calendar Manager)

Calendar Error Codes

Call Service Kit

voipCall (In-App Call Management)

CallerInfoQueryExtensionAbility (Extended Ability for Querying Incoming and Outgoing Call Information)

CallerInfoQueryExtensionContext (Extended Context for Querying Incoming and Outgoing Call Information)

numberIdentify (Number Identification Capability Query)

ArkTS API Error Codes

Cloud Foundation Kit

cloudCommon (Common Module)

cloudFunction (Cloud Functions Module)

cloudStorage (Cloud Storage Module)

cloudDatabase (Cloud DB Module)

ArkTS API Error Codes

@ohos.contact (Contacts)

Contact Error Codes

Enterprise Space Kit

@hms.enterpriseSpaceService.fileTransfer (Inter-workspace Data Transfer)

@hms.enterpriseSpaceService.spaceManager (Workspace Management)

ArkTS API Error Codes

File Manager Service Kit

fileManagerService

ArkTS API Error Codes

Icon Format Description

Game Controller Kit

game_controller_type.h

game_device_event.h

game_pad_event.h

GameDevice_AllDeviceInfos

GameDevice_DeviceInfo

GameDevice_DeviceEvent

GamePad_ButtonEvent

GamePad_AxisEvent

GamePad_PressedButton

Game Service Kit

gamePlayer (Basic Game Service)

gamePerformance (Game Scene Perception)

gameNearbyTransfer (Nearby Transfer)

ArkTS API Error Codes

GamePerformance

Header Files and Structs

game_performance.h

C API Error Codes

Obtaining the Player ID

Obtaining playerId/openId/unionId Through gamePlayerId

Converting teamPlayerId in Batches

Disassociating an Account

Account Disassociation Notification

Health Service Kit

healthStore (Health and Fitness Data Services)

healthService (Health and Fitness Linking Services)

healthStore (Health and Fitness Data Services) (Lite)

healthService (Health and Fitness Linking Services) (Lite)

Health and Fitness Data Type Constants and Model Definitions

healthDataTypes (Health and Fitness Data Type Constants)

healthFields (Health and Fitness Data Fields)

healthModels (Health and Fitness Data Models)

samplePointHelper (Sampling Data Type Constants)

healthSequenceHelper (Health Record Type Constants)

exerciseSequenceHelper (Workout Record Type Constants)

healthDataTypes (Health and Fitness Data Type Constants) (Lite)

healthFields (Health and Fitness Data Fields) (Lite)

exerciseSequenceHelper (Workout Record Type Constants) (Lite)

exerciseRealtimeHelper (Real-Time Fitness Data Type Constants) (Lite)

ArkTS API Error Codes

ArkTS API Error Codes

ArkTS Components

CashierComponent (Embedded IAP Cashier Component)

cashierComponentManager (Embedded IAP Cashier Component Management)

Generating a Token for a Server-Side API Call

Verifying the Signature in the Returned Result

Querying the Order Status for a Consumable, Non-consumable, or Non-renewable Subscription

Acknowledging the Delivery for a Consumable, Non-consumable, or Non-renewable Subscription

Querying Orders Related to Specific Purchase Records

Querying the Subscription Status

Acknowledging the Delivery for a Subscription

Postponing a Subscription Renewal Date

Querying the Order Status by Order Number

Querying the Purchase History of a User

Querying Server-Side Notification Records

Testing Server-Side Notifications

Generating a Signed Purchase Parameter for a Promotion

Key Event Notifications

Refund Request Notifications and Handling

Receiving a Refund Request Notification

Returning the Refund Review Result

REST API Error Codes

liveViewManager

LiveViewLockScreenExtensionAbility

LiveViewLockScreenExtensionContext

LiveViewCardExtensionAbility

LiveViewCardExtensionContext

ArkTS API Error Codes

API Parameter Mapping Between Live View Kit and Push Kit

@ohos.geoLocationManager (Geolocation Manager)

@ohos.app.ability.FenceExtensionAbility (FenceExtensionAbility)

@ohos.app.ability.FenceExtensionContext (FenceExtensionContext)

APIs No Longer Maintained

@ohos.geolocation (Geolocation)

@system.geolocation (Geolocation)

oh_location_type.h

Location_BasicInfo

Location_RequestConfig

Location Kit Error Codes

map (Map Display)

Module Description

Class (MapComponentController)

Interface (BaseOverlay)

Interface (Marker)

Interface (MapPolyline)

Interface (MapPolygon)

Interface (MapCircle)

Interface (BasePriorityOverlay)

Interface (PointAnnotation)

Interface (Bubble)

Interface (CameraUpdate)

Interface (Projection)

Class (LatLngBoundsUtils)

Class (Animation)

Class (AlphaAnimation)

Class (RotateAnimation)

Class (ScaleAnimation)

Class (TranslateAnimation)

Class (FontSizeAnimation)

Class (PlayImageAnimation)

Class (AnimationSet)

Interface (ClusterOverlay)

Interface (ImageOverlay)

Interface (BuildingOverlay)

Interface (TraceOverlay)

Interface (MapArc)

class (SpatialRelationUtil)

Interface (AnimateResult)

Interface (MarkerDelegate)

Interface (MapEventManager)

Interface (MarkerClusterInfo)

Interface (TileOverlay)

Interface (IndoorMapInfo)

Interface (Heatmap)

Interface (MvtOverlay)

Interface (FlowFieldOverlay)

Interface (MassPointOverlay)

Interface (MapSignalLine)

mapCommon (Map Attribute Model)

navi (Route Planning)

petalMaps (Starting the Map App)

sceneMap (Scenario-specific Control)

site (Place Search)

staticMap (Static Map)

offlineMapData (Offline Map)

ArkTS API Error Codes

City Codes and Administrative Division Codes

Supported Countries/Regions for Route Planning

ArkTS Components

MapComponent (Map Component)

Notification Kit

@ohos.notificationManager (NotificationManager)

@ohos.notificationExtensionSubscription (notificationExtensionSubscription)

@ohos.application.NotificationSubscriberExtensionAbility (ExtensionAbility for Notification Subscription)

@ohos.application.NotificationSubscriberExtensionContext (ExtensionAbility Context for Notification Subscription)

NotificationActionButton

NotificationCommonDef

NotificationContent

NotificationExtensionContent

NotificationFlags

NotificationInfo

NotificationRequest

NotificationSlot

NotificationTemplate

NotificationUserInput

NotificationExtensionSubscriptionInfo

APIs No Longer Maintained

@ohos.notification (Notification)

@system.notification (Notification)

Notification Error Codes

paymentService (HarmonyOS Payment Service)

realNameService (Real-Name Service)

ecnyPaymentService (e-CNY Payment Service)

thirdPaymentService (Third-Party Payment Service)

promotionService (Promotion Service)

ArkTS API Error Codes

Direct Merchant

Closing an Order

Payment Result Callback Notification

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Applying for Refunds

Refund Result Callback Notification

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Payment and Signing

Payment Result Callback Notification

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Applying for Refunds

Refund Result Callback Notification

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Contract Signing Result Callback Notification

Contract Signing Query

Querying Contract Signing Order Information by mercContractCode

Querying Contract Signing Order Information by contractId

Applying for Contract Termination

Contract Termination Result Callback Notification

Signing for Withholding Payment

Contract Signing Result Callback Notification

Applying for PIN-Free Withholding

Withholding Result Callback Notification

Contract Signing Query

Querying Contract Signing Order Information by mercContractCode

Querying Contract Signing Order Information by contractId

Payment Withholding Query

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Applying for Contract Termination

Contract Termination Result Callback Notification

Applying for Refunds

Refund Result Callback Notification

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Querying Reconciliation Statements

Querying Settlement Bills

Platform Merchant/Service Provider

Closing an Order

Payment Result Callback Notification

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Requesting Refunds

Refund Result Callback Notification

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Payment and Signing

Payment Result Callback Notification

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Applying for Refunds

Refund Result Callback Notification

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Contract Signing Result Callback Notification

Contract Signing Query

Querying Contract Signing Information by mercContractCode

Querying Signing Information by contractId

Applying for Contract Termination

Contract Termination Result Callback Notification

Signing for Withholding Payment

Contract Signing Result Callback Notification

Applying for PIN-Free Withholding

Withholding Result Callback Notification

Contract Signing Query

Querying Contract Signing Information by mercContractCode

Querying Contract Signing Information by contractId

Payment Withholding Query

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Applying for Contract Termination

Contract Termination Result Callback Notification

Applying for Refunds

Refund Result Callback Notification

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Combined Payment (Only for Platform Merchants)

Closing a Combined Payment Order

Combined Payment Result Callback Notification

Combined Payment Query

Querying Order Information by combinedSysTransOrderNo

Querying Order Information by combinedMercOrderNo

Requesting a Refund

Refund Result Callback Notification

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Querying Reconciliation Bills

Querying Settlement Bills

Obtaining an App-Level Credential

Real-Name Verification and Authorization

Real-Name Pre-verification

Real-Name Verification Result Query

Real-Name Authorization Result Query

Facial Verification

Facial Pre-verification

Facial Verification Result Query

Operations Tools

Merchant Coupons

Creating a Coupon Batch

Modifying Coupon Batch Information

Querying Coupon Batch Details

Uploading Saved Coupon Codes

Modifying the Budget for Coupons in a Batch

Setting the Callback Notification URL

Querying the Callback Notification URL

Coupon Distribution

Coupon Distribution Event Callback Notification

Coupon Write-Off

Applying for Coupon Return

Deactivating a Coupon

Querying Coupons of a User

Querying Details About a Coupon of a User

Querying Platform Coupons Available to a User

REST API Result Codes

Data Model Description

pdfService (PDF Services)

pdfViewManager (PDF Preview)

ArkTS Components

PdfView (PDF Preview Component)

ArkTS API Error Codes

filePreview (File Preview)

openFileBoost (File Open Boost) (Deprecated)

ArkTS API Error Codes

Header Files and Structs

open_file_boost.h

file_cache_boost.h

Anonymous Application Identifier (AAID)

RemoteNotificationExtensionAbility

RemoteNotificationExtensionContext

serviceNotification

VoIPExtensionAbility (Deprecated)

VoIPExtensionContext (Deprecated)

PushExtensionAbility

PushExtensionContext

RemoteLocationExtensionAbility

RemoteLocationExtensionContext

ArkTS API Error Codes

Secure Access Requirements

Image Risk Control

Scenario-Specific Message Push

Function Description

Request Body Structure

Request Body Parameters

Response Parameters

Request Example

Message Frequency Control

Message Revocation

Message Receipt

Service Notification

Service Updates

Service Updates Sending API

Service Updates Parameters

bookParser (Book Parsing Capability)

readerCore (Reader Kit Core Capabilities)

ArkTS Components

ReadPageComponent (Reading Page Component)

ArkTS API Error Codes

Scenario Fusion Kit

atomicService (Convergent Scenario-specific APIs)

fileUriService (File Path Conversion APIs)

ArkTS API Error Codes

ArkTS Components

FunctionalButton (Button Component)

functionalButtonComponentManager (Scenario-specific Convergent Button Component Management)

FunctionalInput (Input Component)

functionalInputComponentManager (Scenario-specific Convergent Input Component Management)

ArkTS Component Error Codes

Screen Time Guard Kit

@hms.utilityApplication.screenTimeGuard.guardService (Screen Time Guard Kit)

@hms.utilityApplication.screenTimeGuard.appPicker (App Selection)

@hms.utilityApplication.screenTimeGuard.TimeGuardExtensionAbility (Screen Time Guard Extension Ability)

@hms.utilityApplication.screenTimeGuard.TimeGuardExtensionContext (Screen Time Guard Extension Context)

ArkTS API Error Codes

systemShare (System Share)

harmonyShare (Huawei Share)

ArkTS API Error Codes

walletPass (Pass Capability)

walletTransitCard (Transportation Card Capability)

ArkTS API Error Codes

General Information

Digital Car Key APIs

REST API Result Codes

Weather Service Kit

weatherService (Weather Data Service)

ArkTS API Error Codes

AI

Agent Framework Kit

A2A (A2A Protocol)

ArkTS Components

FunctionComponent

ArkTS API Error Codes

Header Files and Structs

hiai_aipp_param.h

hiai_single_op.h

HiAISingleOpDescriptor_ConvolutionParam

HiAI_SingleOpExecutorConvolutionParam

HiAI_SingleOpExecutorFusedConvolutionActivationParam

Core Speech Kit

textToSpeech (Text to Speech)

speechRecognizer (Speech Recognition)

ArkTS API Error Codes

Core Vision Kit

textRecognition (OCR)

faceDetector (Face Detection)

faceComparator (Face Verification)

subjectSegmentation (Subject Segmentation)

visionBase (Core Vision Kit Base Class)

objectDetection (Multi-object Detection)

skeletonDetection (Skeleton Detection)

imageSuperResolution (Image Super-Resolution)

textSearchImage (Searching for Images by Text)

ArkTS API Error Codes

InsightIntentUIExtensionAbility

ArkTS API Error Codes

Sharing an Intent

Revoking an Event

Natural Language Kit

jsonObject (Description of Parameters in Entity Return Value)

ArkTS API Error Codes

MindSpore Lite Kit

@ohos.ai.mindSporeLite (On-device AI Framework)

OH_AI_TensorHandleArray

OH_AI_ShapeInfo

OH_AI_CallBackParam

OH_AI_ContextHandle

OH_AI_DeviceInfoHandle

OH_AI_TensorHandle

OH_AI_AllocatorHandle

OH_AI_ModelHandle

OH_AI_TrainCfgHandle

Neural Network Runtime Kit

NeuralNetworkRuntime

neural_network_core.h

neural_network_runtime.h

neural_network_runtime_type.h

OH_NN_UInt32Array

OH_NN_QuantParam

OH_NNCompilation

TextReader (Reading Control)

ReadStateCode (Reading Status)

WindowManager (Window Management)

ArkTS Components

TextReaderIcon (Speaker Icon)

TextReaderIconV2 (Speaker Icon)

AICaptionComponent (AICaption Component)

ArkTS API Error Codes

interactiveLiveness (Face Liveness Detection)

visionImageAnalyzer (AI Image Recognition)

ArkTS Components

CardRecognition (Card Recognition Control)

DocumentScanner (Document Scanning Control)

ArkTS API Error Codes

Common Capabilities

Class (Console)

loadNativeModule (Synchronously and Dynamically Loading a System Library)

purgeable_memory.h

JSVM_CallbackStruct

JSVM_HeapStatistics

JSVM_InitOptions

JSVM_CreateVMOptions

JSVM_PropertyDescriptor

JSVM_ExtendedErrorInfo

JSVM_PropertyHandlerConfigurationStruct

JSVM_ScriptOrigin

JSVM_CompileOptions

JSVM_PropertyHandler

JSVM_DefineClassOptions

JSVM_VMScope__*

JSVM_EnvScope__*

JSVM_CpuProfiler__*

JSVM_HandleScope__*

JSVM_EscapableHandleScope__*

JSVM_CallbackInfo__*

JSVM_Deferred__*

JSVM_CallbackStruct*

JSVM_PropertyHandlerConfigurationStruct*

JSVM_CompileProfile

JSVM_DeserializeResult

Standard Libraries

C++ Standard Library

Vulkan Development

Vulkan Development Overview

Vulkan Surface Development

Vulkan External Memory Development

Vulkan Capabilities

Vulkan Extensions

VkSurfaceCreateInfoOHOS

VkNativeBufferOHOS

VkSwapchainImageCreateInfoOHOS

VkPhysicalDevicePresentationPropertiesOHOS

VkNativeBufferUsageOHOS

VkNativeBufferPropertiesOHOS

VkNativeBufferFormatPropertiesOHOS

VkImportNativeBufferInfoOHOS

VkMemoryGetNativeBufferInfoOHOS

VkExternalFormatOHOS

OH_NativeBuffer

Native API Symbols Not Exported

NDK-Related musl libc Interface Usage Restrictions

EGL Symbols Exported from Native APIs

ICU4C Symbols Exported from Native APIs

OpenGL ES 3.2 Symbols Exported from Native APIs

Seccomp-Provided System Call List

FIDO2_AuthenticatorResponse

Last updated: 2026-09-04 06:52

Content overview

Member Variables

Struct Member Variable Description

authenticatorData

Expand

Overview

Defines the authenticator assertion response.

Since: 6.0.0(20)

Related module: FIDO2 (Passkey Service)

Header file: fido2_api.h

Summary

Member Variables

Expand

Name	Description
Uint8Buff authenticatorData	Authenticator data.
Uint8Buff signature	Signature.
Uint8Buff userHandle	User handle (user ID). By default, this parameter is left empty. The length ranges from 0 to 4096 characters. This parameter is optional.
Uint8Buff clientDataJson	Client data, which represents the contextual bindings of the WebAuthn relying party and the client. The data includes the type, challenge, and origin.

Struct Member Variable Description

authenticatorData

Collapse
Word wrap
Dark theme
Copy code
Uint8Buff FIDO2_AuthenticatorResponse::authenticatorData

Description

Authenticator data.

clientDataJson

Collapse
Word wrap
Dark theme
Copy code
Uint8Buff FIDO2_AuthenticatorResponse::clientDataJson

Description

Client data, which represents the contextual bindings of the WebAuthn relying party and the client. The data includes the type, challenge, and origin.

signature

Collapse
Word wrap
Dark theme
Copy code
Uint8Buff FIDO2_AuthenticatorResponse::signature

Description

Signature information for FIDO2 authentication.

userHandle

Collapse
Word wrap
Dark theme
Copy code
Uint8Buff FIDO2_AuthenticatorResponse::userHandle

Description

User handle. (Optional)

FIDO2_AuthenticatorMetadataArray

FIDO2_AuthenticatorSelectionCriteria

Send feedback

Was this page helpful?

Send feedback

Reach out to us through the community for any other questions.

Community Q&A Intelligent Assistant