API Reference Overview

Application Framework

Ability Kit

ArkTS APIs

Stage Model

@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)

continuation

ContinuationExtraParams

ContinuationResult

FA Model

@ohos.ability.ability (Ability Module)

@ohos.ability.featureAbility (FeatureAbility Module)

@ohos.ability.particleAbility (ParticleAbility Module)

ability

DataAbilityOperation

DataAbilityResult

StartAbilityParameter

app

AppVersionInfo

Context (Context Base Class of the FA Model)

ProcessInfo

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

AgentExtensionContext

AgentHostProxy

ApplicationContext (Application Context)

ApplicationStateObserver

AppServiceExtensionContext (ExtensionAbility Context for Application Background Services)

Context (Context Base Class of the Stage Model)

EmbeddableUIAbilityContext

ErrorObserver

EventHub

ExtensionContext

KioskStatus (Kiosk Status Information)

UIServiceExtensionConnectCallback

UIServiceProxy

ProcessData

PhotoEditorExtensionContext

PermissionRequestResult

wantAgent

TriggerInfo

WantAgentInfo

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)

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

want.h

ability_resource_info.h

bundle_manager_common.h

context.h

extension_ability.h

modular_object_dispatcher.h

modular_object_extension_ability.h

modular_object_extension_context.h

modular_object_extension_manager.h

Structs

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*

Error Codes

Ability Error Codes

Distributed Scheduler Error Codes

Bundle Error Codes

Access Control Error Codes

ohos.screenLockFileManager Error Codes

Accessibility Kit

ArkTS APIs

@ohos.accessibility (Accessibility)

@ohos.accessibility.GesturePath (Gesture Path)

@ohos.accessibility.GesturePoint (Gesture Point)

@ohos.application.AccessibilityExtensionAbility (AccessibilityExtensionAbility)

AccessibilityExtensionContext (Accessibility Extension Context)

Error Codes

Accessibility Error Codes

ArkData

ArkTS APIs

@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

Functions

Interface (RdbStore)

Interface (ResultSet)

Class (LiteResultSet)

Interface (Transaction)

Interfaces (Others)

Class (RdbPredicates)

Enums

Types

@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)

data/rdb

resultSet

ArkTS Components

@ohos.data.UdmfComponents (Content Card)

oh_preferences_err_code.h

oh_preferences_option.h

oh_preferences_value.h

oh_data_values_buckets.h

oh_predicates.h

oh_rdb_crypto_param.h

relational_store_error_code.h

OH_RDB_ReturningContext

Rdb_DistributedConfig

Rdb_KeyInfo

Rdb_KeyData

Rdb_ChangeInfo

Rdb_SubscribeCallback

OH_UdmfRecordProvider

OH_UdmfDataLoadParams

DataShare Error Codes

Distributed Data Object Error Codes

Distributed KV Store Error Codes

User Preferences Error Codes

@arkts.collections (ArkTS Collections)

Class (Uint8ClampedArray)

Class (Float32Array)

Class (BitVector)

Interface (ConcatArray)

Types

@arkts.lang (ArkTS Base Capability)

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

@arkts.utils (ArkTS Utils)

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)

Error Codes

Utils Error Codes

TypeScript Compiler Error Codes

Compilation Toolchain Error Codes

es2abc Compiler Error Codes

Source Code Obfuscation Error Codes

ArkUI

ArkTS API

@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 (Font)

Class (FrameCallback)

Class (Magnifier)

Class (MarqueeDynamicSyncScene)

Class (MeasureUtils)

Class (MediaQuery)

Class (OverlayManager)

Class (PromptAction)

Class (Router)

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)

Enums

Types

@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)

@ohos.window.floatView (Float View)

@ohos.PiPWindow (PiP Window)

@ohos.window.floatingBall (Floating Ball Window)

@ohos.window (Window)

Module Description

Functions

Interface (Window)

Interface (WindowStage)

@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)

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

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

Component ID

Distributed Migration Identifier

Component-Level Pixel Rounding

Page-Level Pixel Rounding

Border Styling

Border Image

Visual Effects and Blur

Click Feedback Effect

Special Effect Drawing Combination

Render Fit

Interaction Attributes

Enable/Disable Control

Focus Control

Drag and Drop Control

Drag-and-Drop Sorting

Hover Effect

Click Sound Effect

Smart Gesture Response

Touch Interaction Control

Modal Transition Settings

Modal Transition

Sheet Transition

Dynamic Attributes and Customization

Symbol Glyph Modifier

Attribute Modifier Utility

Others

Reuse ID

Reuse Options

Toolbar Configuration

Bound Gesture Configuration

Custom Gesture Judgment

Gesture Blocking Enhancement

Gesture Common APIs

Row, Column, and Stack

Scrolling and Swiping

Scrollable Component Common APIs

Navigation and Switching

Buttons and Selection

Text Box Component Common APIs

Text Component Common APIs

Enhanced SVG Tag Parsing

Information Display APIs

CanvasRenderingContext2D

DrawingRenderingContext

OffscreenCanvasRenderingContext2D

Path2D

Common Canvas Drawing Properties

Common Canvas Rendering Methods

Common Attributes for Graphics Drawing

Rendering and Drawing

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)

Dialog Boxes

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)

Security Component Universal Attributes

AtomicServiceNavigation

AtomicServiceSearch

AtomicServiceTabs

AtomicServiceWeb

InterstitialDialogAction

HalfScreenLaunchComponent

NavPushPathHelper

Custom placeholder component

NodeContainer

ContentSlot

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

wrapBuilder

mutableBuilder

Component Preview

System Preset UI Component Library

FullScreenLaunchComponent

GridObjectSortComponent

State Management and Rendering Control

State Management with Application-Level Variables

Built-in Environment Variables

ForEach

LazyForEach

Repeat

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 Event Callbacks

Deprecated Components and APIs

JavaScript Components

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

CanvasRenderingContext2D

OffscreenCanvasRenderingContext2D

Basic Usage of Custom Components

Data Transfer and Processing

Crown Rotation Event Monitoring

Dynamic Component Creation

Data Type Attributes

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

Multi-Language Capability

CanvasRenderingContext2D

Monitoring Rotating Crown Events

JavaScript Service Widget UI Components

Multi-Language Capability

Version Compatibility Adaptation

Custom Component Basic Usage

OH_NativeXComponent Native XComponent

ArkUI_EventModule

WindowManager

OH_DisplayManager

ArkUI_RenderNodeUtils

Header Files

common_attributes.h

drag_and_drop.h

drawable_descriptor.h

native_interface_accessibility.h

native_interface_focus.h

native_interface_xcomponent.h

native_key_event.h

native_material.h

native_node.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)

native_xcomponent_key_event.h

oh_window_event_filter.h

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_Curve

ArkUI_Curve*

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

OHNativeWindow

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_Matrix4RotationOptions

ArkUI_Matrix4ScaleOptions

ArkUI_Matrix4TranslationOptions

ArkUI_PointF

ArkUI_TranslationOptions

ArkUI_ScaleOptions

ArkUI_RotationOptions

ArkUI_NativeDialog

ArkUI_LayoutConstraint

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

Error Codes

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

Compilation Error Codes

ArkWeb

ArkTS API

@ohos.web.webview (Webview)

Module Description

Functions

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)

AIPageCommand

AIPageInteraction

AIPageResult

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)

Enums

Types

@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)

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)

Enums

Types

Class (WebController)

arkweb_net_error_list.h

arkweb_scheme_handler.h

arkweb_type.h

native_interface_arkweb.h

Structs

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

@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)

Application

WorkSchedulerExtensionContext

APIs No Longer Maintained

@ohos.backgroundTaskManager (Background Task Management)

@ohos.bundleState (Device Usage Statistics)

@ohos.reminderAgent (Agent-powered Reminder)

C APIs

Modules

BackgroundProcessManager

TransientTask

Header Files

background_process_manager.h

transient_task_api.h

transient_task_type.h

Structs

TransientTask_DelaySuspendInfo

TransientTask_TransientTaskInfo

Error Codes

backgroundTaskManager Error Codes

backgroundProcessManager Error Codes

reminderAgentManager Error Codes

workScheduler Error Codes

content_embed_common.h

content_embed_document.h

content_embed_extension.h

content_embed_proxy.h

Structs

ContentEmbed_Document

ContentEmbed_Storage

ContentEmbed_StorageElement

ContentEmbed_StorageElements

ContentEmbed_Stream

ContentEmbed_ExtensionContext

ContentEmbed_ExtensionContext*

ContentEmbed_ExtensionInstance

ContentEmbed_ExtensionInstance*

ContentEmbed_ExtensionProxy

ContentEmbed_Capability

Core File Kit

ArkTS APIs

@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_cloud_disk_manager.h

cloud_disk_error_code.h

oh_archive.h

oh_archive_errcode.h

Structs

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

ArchiveReadCtx

ArchiveStreamWriteCtx

ArchiveStreamReadCtx

Error Codes

File Management Error Codes

Data Augmentation Kit

ArkTS API

rag (Retrieval Augmentation Generation)

retrieval (Intelligence Data Platform)

knowledgeProcessor (Knowledge Processing)

localChatModel (On-Device Q&A Model)

ArkTS API Error Codes

aip_retrieval_condition.h

aip_retrieval_condition_vector.h

aip_retrieval_query.h

aip_retrieval_record.h

Form Kit

ArkTS APIs

@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)

application

FormExtensionContext

FormEditExtensionContext

LiveFormExtensionContext

APIs No Longer Maintained

@ohos.application.formBindingData (formBindingData)

@ohos.application.formError (formError)

@ohos.application.formInfo (formInfo)

@ohos.application.formProvider (formProvider)

@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

Structs

InputMethod_AttachOptions

InputMethod_CursorInfo

InputMethod_InputMethodProxy

InputMethod_PrivateCommand

InputMethod_TextAvoidInfo

InputMethod_TextConfig

InputMethod_TextEditorProxy

Error Codes

Input Method Framework Error Codes

@ohos.i18n (Internationalization)

@ohos.intl (Internationalization)

@ohos.resourceManager (Resource Management)

@ohos.sendableResourceManager (Resource Manager)

NativeResourceManager

ResourceManager_Configuration

DateTimeRule

InitialTimeZoneRule

TimeArrayTimeZoneRule

Resource Manager Error Codes

ArkTS API Error Codes

ArkTS Components

HdsNavigation (Navigation Root View Container)

HdsNavDestination (Navigation Child Page Container)

MultiWindowEntryInAPP

HdsColorPicker (Color Picker Component)

System

Security

Asset Store Kit

ArkTS APIs

@ohos.security.asset (Asset Store Service)

Asset Store Service Error Code

Confidential Space Kit

ArkTS API

@hms.security.confidentialSpace (Confidential Space Service)

ArkTS API Error Codes

Crypto Architecture Kit

ArkTS APIs

@ohos.security.cryptoFramework (Crypto Framework)

APIs No Longer Maintained

@system.cipher (Cipher Algorithm)

C APIs

Modules

CryptoArchitectureKit

CryptoKeyAgreementApi

crypto_architecture_kit.h

crypto_key_agreement.h

OH_CryptoSm2CiphertextSpec

OH_CryptoKeyPair

OH_CryptoPubKey

OH_CryptoPrivKey

OH_CryptoAsymKeyGenerator

OH_CryptoPrivKeyEncodingParams

OH_CryptoAsymKeySpec

OH_CryptoAsymKeyGeneratorWithSpec

OH_CryptoKeyAgreement

OH_CryptoEccSignatureSpec

OH_CryptoSymCipher

OH_CryptoSymCipherParams

OH_CryptoSymKey

OH_CryptoSymKeyGenerator

Error Codes

Crypto Framework Error Codes

Data Protection Kit

ArkTS APIs

@ohos.dlpPermission (DLP)

@ohos.security.identifySensitiveContent (Identifying Sensitive Content)

DLP Service Error Codes

BusinessRiskIntelligentDetection

SecurityAudit

AntifraudPicker

TrustedAuthentication (Digital Shield)

DlpAntiPeep

SuperPrivacyMode

ArkTS API Error Codes

BusinessRiskIntelligentDetection

SecurityAudit

AntifraudPicker

TrustedAuthentication (Digital Shield)

device_security_mode.h

SecurityAntivirus_Antivirus

SecurityAudit_AuthClientConfiguration

REST API

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

ArkTS APIs

fileGuard (Hierarchical File Management)

recoveryKey (Enterprise Recovery Key)

Enterprise Data Guard Kit Error Codes

Enterprise Threat Protection Kit

ArkTS API

virusRemediation (Virus Detection and Handling)

ArkTS API Error Codes

Online Authentication Kit

ArkTS API Error Codes

FIDO2 (Passkey Service)

Header file

fido2_api.h

Structs

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

Uint8Buff

Device Certificate Kit

ArkTS APIs

@ohos.security.cert (Certificate)

@ohos.security.certManager (Certificate Management)

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

OH_CM_CredentialDetailList

OH_CM_UkeyInfo

Error Codes

Certificate Error Codes

Certificate Management Error Codes

Certificate Management Dialog Box Error Codes

Universal Keystore Kit

ArkTS APIs

@ohos.security.huks (Universal Keystore)

@ohos.security.huksExternalCrypto (External Key Management)

@ohos.security.CryptoExtensionAbility (Key Extension Ability)

C APIs

Modules

HuksExternalCryptoApi

HuksExternalCryptoTypeApi

native_huks_external_crypto_api.h

native_huks_external_crypto_type.h

OH_Huks_ExternalCryptoParam

OH_Huks_ExternalCryptoParamSet

OH_Huks_KeyMaterialRsa

OH_Huks_KeyMaterialEcc

OH_Huks_KeyMaterialDsa

OH_Huks_KeyMaterialDh

OH_Huks_KeyMaterial25519

OH_Huks_KeyAliasSet

Error Codes

HUKS Error Codes

User Authentication Kit

ArkTS APIs

@ohos.userIAM.userAuth (User Authentication)

ArkTS Components

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

Error Codes

User Authentication Error Codes

Network

Accessory Kit

ArkTS APIs

accessoryAccessManager (Accessory Integration Management)

Connectivity Kit

ArkTS APIs

@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)

tag

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

ArkTS APIs

@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_err_code.h

Error Codes

Device Management Error Codes

Link Enhancement Error Codes

Proxy Channel Management Error Codes

NearLink Kit

ArkTS APIs

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

Network Kit

ArkTS APIs

@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)

net_connection_type.h

net_ssl_c.h

net_ssl_c_type.h

net_trafficfilter.h

net_trafficfilter_type.h

http_interceptor_type.h

NetConn_NetCapabilities

NetConn_NetAddr

NetConn_Route

NetConn_HttpProxy

NetConn_ConnectionProperties

NetConn_NetHandleList

NetConn_NetSpecifier

NetConn_NetConnCallback

NetConn_ProbeResultInfo

NetConn_TraceRouteInfo

NetConn_TraceRouteOption

NetStack_CertBlob

NetStack_CertificatePinning

NetStack_Certificates

WebSocket

WebSocket_CloseResult

WebSocket_CloseOption

WebSocket_ErrorResult

WebSocket_OpenResult

WebSocket_Header

WebSocket_RequestOptions

Http_PerformanceTiming

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)

Error Codes

HTTP Error Codes

Socket Error Codes

WebSocket Error Codes

Network Connection Management Error Codes

Ethernet Connection Error Codes

Extensible 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

netQuality (Network Quality)

netHandover (Network Handover)

netBoost (Network Acceleration)

ArkTS API Error Codes

network_boost_handover.h

network_boost_quality.h

network_boost.h

Structs

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

ArkTS APIs

rcp (Data Requests)

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

Rcp_CertificateAuthority

Rcp_ClientCertificate

Rcp_Configuration

Rcp_ConnectionConfiguration

Rcp_ContentOrPathOrCallback

Rcp_CookieAttributeEntry

Rcp_FormFieldFileValue

Rcp_MultipartFormFieldValue

Rcp_OnDataReceiveCallback

Rcp_OnHeaderReceiveCallback

Rcp_OnProgressCallback

Rcp_OnVoidCallback

Rcp_ProxyConfiguration

Rcp_Request

Rcp_RequestContent

Rcp_RequestCookieEntry

Rcp_Response

Rcp_ResponseCallbackObject

Rcp_ResponseCookies

Rcp_SecurityConfiguration

Rcp_ServerAuthentication

Rcp_SessionConfiguration

Rcp_SessionListener

Rcp_StaticDnsRule

Rcp_StaticDnsRuleItem

Rcp_SyncInterceptor

Rcp_SyncInterceptorArray

Rcp_TimeInfo

Rcp_Timeout

Rcp_TracingConfiguration

Rcp_TransferConfiguration

Rcp_TransferRange

Rcp_Urls

Rcp_WebProxy

Rcp_OnBinaryReceiveCallback

Rcp_OnStatusCodeReceiveCallback

Rcp_OnGetDataCallback

Key Fields in Fault Logs

Service Collaboration Kit

ArkTS APIs

@hms.collaboration.serviceInteraction (OneHop)

ArkTS Components

CollaborationCamera (Device Interconnectivity Component)

CollaborationService (Device Interconnectivity Component)

CollaborationDevicePicker (Hopping Control)

devicePicker (Device Selection Controller)

C APIs

Modules

ServiceCollaboration

Header Files and Structs

Header Files

service_collaboration_api.h

Structs

ServiceCollaboration_CollaborationDeviceInfo

ServiceCollaboration_CollaborationDeviceInfoSets

ServiceCollaboration_SelectInfo

ServiceCollaborationCallback

ServiceCollaboration_SelectInfoV2

Error Codes

Telephony Kit

ArkTS API

@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_radio_type.h

Structs

Telephony_NetworkState

Error Codes

Telephony Error Codes

@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)

commonEvent

CommonEventData

CommonEventPublishData

CommonEventSubscriber

CommonEventSubscribeInfo

Others

@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

@ohos.commonEvent (Common Event)

@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)

oh_commonevent_support.h

oh_pasteboard.h

oh_pasteboard_err_code.h

CommonEvent_SubscribeInfo

CommonEvent_PublishInfo

CommonEvent_RcvData

Pasteboard_ProgressInfo

Pasteboard_GetDataParams

OH_PasteboardObserver

Print_PrinterCapability

Print_PrintAttributes

Print_PrintDocCallback

Scan_ScannerDevice

Scan_PictureScanProgress

Scan_ScannerOptions

Error Codes

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

Common 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

FAST Kit

ArkTS API

@hms.fast.mathPrediction (Mathematical Prediction)

@hms.fast.schedulingOptimization (System Performance Optimization)

ArkTS API Error Codes

C API

Modules

FAST

Header Files and Structs

Header Files

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

Structs

FAST_BiquadCoefficients

FAST_BiquadCoefficientsD

Function Flow Runtime Kit

ffrt_function_header_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)

Input_InterceptorEventCallback

Input_InterceptorOptions

Global Shortcut Key Error Codes

Input Device Error Codes

Mouse Pointer Error Codes

IR Management Error Codes

Input Event Injection Error Codes

MDM Kit

ArkTS APIs

@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)

application

EnterpriseAdminExtensionContext

Error Codes

Enterprise Device Management Error Codes

OH_QoS_GewuCreateSessionResult

OH_QoS_GewuSubmitRequestResult

Hotspot Accelerate Error Codes

Service Support Kit

ArkTS APIs

deviceDetection (Device Hardware Consistency Check)

ArkTS API Error Codes

Hardware

Car Kit

ArkTS APIs

navigationInfoMgr (Navigation Information Management)

smartMobilityCommon (Smart Mobility)

ArkTS API Error Codes

Appendix

naviTurnMode

trafficLane

Driver Development Kit

ArkTS API

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

@ohos.driver.deviceManager (Peripheral Management)

application

DriverExtensionContext

scsi_peripheral_api.h

scsi_peripheral_types.h

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

Multimodal Awareness Kit

ArkTS APIs

@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)

Error Codes

Motion Awareness Error Codes

Metadata Binding Error Codes

Device Status Awareness Error Codes

User Status Awareness Error Codes

Pen Kit

ArkTS APIs

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)

Header Files and Structs

Header Files

native_gcp_api.h

native_handwrite_api.h

Structs

HMS_GCP_Color

HMS_GCP_PickedColorInfo

HandWrite_HistoricalPoint

ArkTS API Error Codes

Sensor Service Kit

ArkTS API

@ohos.sensor (Sensor)

@ohos.vibrator (Vibrator)

@system.sensor (Sensor)

@system.vibrator (Vibrator)

Sensor_SubscriptionId

Sensor_SubscriptionAttribute

Sensor_Subscriber

Vibrator_Attribute

Vibrator_FileDescription

@ohos.distributedHardware.mechanicManager (Mechanic Manager)

Error Codes

Mechanic Manager Error Codes

Wear Engine Kit

ArkTS APIs

wearEngine (Wearable Capabilities)

wearEngineLite (Wearable Capabilities) (Lite)

ArkTS API Error Codes

AOD Navigation Kit

ArkTS APIs

aodNaviManager (AOD Navigation Service)

ArkTS API Error Codes

Debugging Tools

Performance Analysis Kit

ArkTS API

@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_AppEventInfo

HiAppEvent_AppEventGroup

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

HiTraceId

Error Codes

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

Test Kit

ArkTS API

@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)

@ohos.application.testRunner (TestRunner)

@ohos.UiTest

@ohos.test.PerfTest

Dependent Elements and Definitions

AbilityDelegator

AbilityDelegatorArgs

ShellCmdResult

APIs No Longer Maintained

@ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)

Media

@ohos.multimedia.audio (Audio Management)

Module Description

Functions

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)

@ohos.multimedia.audioHaptic (Audio-Haptic)

@ohos.multimedia.systemSoundManager (System Sound Management)

multimedia

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

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_AudioFormat

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_MIDIEvent

OH_MIDIDeviceInformation

OH_MIDIPortInformation

OH_MIDIPortDescriptor

native_avcapability.h

native_avcodec_audiocodec.h

native_avcodec_base.h

media_types.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

OH_AVCodecAsyncCallback

DRM_MediaKeySystemInfo

OH_AudioObjectPosition

OH_AudioVividMetaBuilderStruct

APIs No Longer Maintained

avcodec_audio_channel_layout.h

native_avcodec_audiodecoder.h

native_avcodec_audioencoder.h

AVSession Kit

ArkTS APIs

@ohos.multimedia.avsession (AVSession Management)

Module Description

Functions

Class (AVCastPickerHelper)

Interface (AVCastController)

Interface (AVSession)

Interface (AVSessionController)

Interfaces (Others)

Enums

Types

@ohos.multimedia.avCastPickerParam (AVCastPicker Parameters)

@ohos.multimedia.avMusicTemplate (Audio Template)

Module Description

Functions

Class (AVMusicTemplate)

Class (AVMusicTemplateController)

@ohos.multimedia.avCastPicker (AVCastPicker)

@ohos.multimedia.avInputCastPicker (AVInputCastPicker)

native_avsession_errors.h

native_avcastcontroller.h

native_avplaybackstate.h

native_avqueueitem.h

native_avsession_base.h

native_deviceinfo.h

Structs

OH_AVMetadataBuilderStruct

OH_AVMetadataStruct

AVSession_PlaybackPosition

OH_AVSession

OH_AVCastController

OH_AVSession_AVPlaybackState

OH_AVSession_AVQueueItem

OH_AVSession_AVMediaDescription

OH_AVSession_AVMediaDescriptionBuilder

AVSession_OutputDeviceInfo

AVSession_DeviceInfo

Error Codes

AVSession Management Error Codes

Audio Template Error Codes

Camera Kit

ArkTS APIs

@ohos.multimedia.camera (Camera Management)

Module Description

Functions

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)

Enums

Types

Deprecated Interface (CaptureSession, deprecated)

@ohos.multimedia.cameraPicker (Camera Picker)

metadata_object_ext.h

Camera_FrameRateRange

Camera_VideoProfile

Camera_OutputCapability

Camera_Device

Camera_DeviceQueryInfo

Camera_StatusInfo

Camera_Point

Camera_Location

Camera_PhotoCaptureSetting

OH_Camera_PhotoCaptureSettingExt

Camera_FrameShutterInfo

Camera_CaptureEndInfo

Camera_Rect

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

Camera_Manager

CameraInput_Callbacks

Camera_Input

CameraManager_Callbacks

CaptureSession_Callbacks

Camera_CaptureSession

MetadataOutput_Callbacks

Camera_MetadataOutput

OH_PhotoNative

PhotoOutput_Callbacks

Camera_PhotoOutput

PreviewOutput_Callbacks

Camera_PreviewOutput

VideoOutput_Callbacks

Camera_VideoOutput

Camera_OcclusionDetectionResult

OH_Camera_ZoomRange

OH_Camera_PhysicalAperture

OH_Camera_ZoomPointInfo

@ohos.multimedia.drm (Digital Rights Management)

Module Description

Functions

Interface (MediaKeySession)

Interface (MediaKeySystem)

native_mediakeysession.h

native_mediakeysystem.h

Structs

DRM_MediaKeyRequestInfo

DRM_MediaKeyRequest

DRM_Statistics

DRM_OfflineMediakeyIdArray

DRM_KeysInfo

DRM_MediaKeyStatus

DRM_PsshInfo

DRM_MediaKeySystemInfo

DRM_MediaKeySystemDescription

MediaKeySystem

MediaKeySession

MediaKeySession_Callback

OH_MediaKeySession_Callback

@ohos.multimedia.image (Image Processing)

Module Description

Functions

Interface (AuxiliaryPicture)

Interface (Image)

Interface (ImageCreator)

Interface (ImagePacker)

Interface (ImageReceiver)

Interface (ImageSource)

Interface (Metadata)

Class (ExifMetadata)

Class (MakerNoteHuaweiMetadata)

Class (HeifsMetadata)

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

@ohos.multimedia.videoProcessingEngine (Video Processing Engine)

image_packer_native.h

image_receiver_native.h

image_source_native.h

image_pixel_map_mdk.h

image_pixel_map_napi.h

image_receiver_mdk.h

image_source_mdk.h

image_effect.h

image_effect_errors.h

image_effect_filter.h

image_processing.h

image_processing_types.h

Structs

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_PackingOptionsForSequence

OH_ImageReceiverNative

OH_ImageReceiverOptions

OH_PictureNative

OH_AuxiliaryPictureNative

OH_AuxiliaryPictureInfo

OhosPixelMapCreateOps

OhosPixelMapInfo

OhosImageReceiverInfo

OhosImageSourceDelayTimeList

OhosImageSourceSupportedFormat

OhosImageSourceSupportedFormatList

OhosImageSourceProperty

OhosImageSourceUpdateData

OH_ImageEffect

ImageEffect_DataValue

ImageEffect_FilterNames

ImageEffect_FilterDelegate

ImageEffect_Region

ImageEffect_Size

ImageProcessing_ColorSpaceInfo

OH_PictureNative_AuxiliaryPictureCopyItem

OH_PictureNative_MetadataCopyItem

Error Codes

Image Error Codes

Video Processing Engine Error Codes

Media Kit

ArkTS APIs

@ohos.multimedia.media (Media)

Module Description

Functions

Interface (AVAdsController)

Interface (AVDownloaderManager)

Interface (AVImageGenerator)

Interface (AVMetadataExtractor)

Interface (AVPlayer)

Interface (AVRecorder)

Interface (AVScreenCaptureRecorder)

Interface (AVTranscoder)

Interface (MediaSource)

Interface (MediaSourceLoadingRequest)

Interfaces (Others)

Enums

Types

Deprecated Interface (AudioPlayer, deprecated)

Deprecated Interface (AudioRecorder, deprecated)

Deprecated Interface (VideoPlayer, deprecated)

@ohos.multimedia.videoProcessing (Video Processing)

multimedia

SoundPool (Sound Pool)

avimage_generator_base.h

avmetadata_extractor.h

avmetadata_extractor_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

OH_AVMetadataExtractor

MediaKeySession

DRM_MediaKeySystemInfo

AVPlayerCallback

OH_AVPlayer

OH_AVRecorder_Profile

OH_AVRecorder_Location

OH_AVRecorder_MetadataTemplate

OH_AVRecorder_Metadata

OH_AVRecorder_Config

OH_AVRecorder_Range

OH_AVRecorder_EncoderInfo

OH_AVRecorder

OH_AVTranscoder

OH_AVTranscoder_Config

OH_AVScreenCaptureConfig

OH_PrivacyProtectInfo

OH_AVScreenCaptureCallback

OH_AVScreenCapture_ContentFilter

OH_AVScreenCapture_CaptureStrategy

OH_AVScreenCapture_UserSelectionInfo

OH_AVScreenCaptureHighlightConfig

OH_LowPowerAudioSink

OH_LowPowerAudioSinkCallback

OH_AVSamplesBuffer

OH_LowPowerAVSink_Capability

OH_LowPowerVideoSink

OH_LowPowerVideoSinkCallback

VideoProcessing_ColorSpaceInfo

OH_VideoProcessing

NativeWindow

OH_AVFormat

VideoProcessing_Callback

OH_AVPlaybackStrategy

OH_AVMediaSource

OH_AVHttpHeader

OH_AVMediaSourceLoadingRequest

OH_AVMediaSourceLoader

OH_AVSeiMessageArray

OH_AVMetadataExtractor_OutputParam

OH_AVMetadataExtractor_FrameInfo

OH_MultiDisplayCapability

OH_AVPlayerVideoOutput

@ohos.file.photoAccessHelper (Album Management)

Module Description

Functions

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)

Enums

Types

@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)

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

Structs

MediaLibrary_RequestId

OH_MediaAssetManager

OH_MediaAssetChangeRequest

OH_MovingPhoto

OH_MediaAsset

MediaLibrary_RequestOptions

Error Codes

Media Library Error Codes

Ringtone Kit

ArkTS APIs

ringtone (Ringtone Service)

ArkTS API Error Codes

Scan Kit

ArkTS APIs

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

AR Engine

ArkTS APIs

arEngine (AR Capabilities)

arViewController (AR Scene Management Capabilities)

ArkTS Components

ARView (AR Scene Visualization)

C APIs

Modules

AR Engine

Header Files and Structs

Header Files

ar_engine_core.h

Structs

AREngine_ARAugmentedImageSource

AREngine_ClipPlaneDistance

AREngine_ARSemanticDensePointData

AREngine_ARSemanticDenseCubeData

AR Engine Error Codes

ArkGraphics 2D

ArkTS APIs

@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)

Class (SamplingOptions)

Class (TypefaceArguments)

Interfaces (Others)

Enums

@ohos.graphics.hdrCapability (HDR Capability)

@ohos.graphics.text (Text)

@ohos.graphics.uiEffect (Cascading Effect)

C APIs

Modules

OH_NativeBuffer

NativeColorSpaceManager

native_color_space_manager.h

native_display_soloist.h

drawing_color_filter.h

drawing_color_space.h

drawing_error_code.h

drawing_filter.h

drawing_font.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.h

drawing_path_effect.h

drawing_path_iterator.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

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

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_Run

OH_Drawing_FontFullDescriptor

OH_Drawing_FontVariationAxis

OH_Drawing_FontVariationInstance

OH_Drawing_FontVariationInstanceCoordinate

OH_Drawing_PathIterator

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

colorSpaceManager Error Codes

Drawing and Display Error Codes

ArkGraphics 3D

ArkTS APIs

@ohos.graphics.scene (ArkGraphics 3D)

ScenePostProcessSettings

Graphics Accelerate Kit

ArkTS API

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

C API

Modules

GraphicsAccelerate

Header Files and Structs

Header Files

abr_base.h

abr_gles.h

frame_generation_base.h

frame_generation_gles.h

frame_generation_vk.h

FG_ContextDescription_VK

FG_Dimension2D

FG_DispatchDescription_GLES

FG_DispatchDescription_VK

FG_PerFrameExtendedCameraInfo

FG_IntegrationInfo

OpenGTX_ConfigDescription

OpenGTX_FrameRenderInfo

OpenGTX_GameSceneInfo

OpenGTX_NetworkInfo

OpenGTX_NetworkLatency

OpenGTX_ResolutionValue

spatial_recon_interface.h

Modules

SpatialRecon

Structs

HMS_SpatialRecon_ModelWriteInfo

HMS_SpatialRecon_DataFrame

HMS_SpatialRecon_Session

Header Files and Structs

Header Files

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

Structs

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

Account Kit

ArkTS APIs

@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

REST APIs

General Information

Open API Call Credentials

Overview

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

Overview

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

Overview

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

Appendix

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

REST API Error Codes

Ads Kit

ArkTS APIs

@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)

Error Codes

Ads Service Framework Error Codes

OAID Error Codes

AppGallery Kit

ArkTS APIs

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

Posting Back the Attribution Result

App Linking Kit

ArkTS APIs

deferredLink (Deferred Link Capability)

Calendar Kit

ArkTS APIs

@ohos.calendarManager (Calendar Manager)

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

ArkTS APIs

cloudCommon (Common Module)

cloudFunction (Cloud Functions Module)

cloudStorage (Cloud Storage Module)

cloudDatabase (Cloud DB Module)

ArkTS API Error Codes

Contacts Kit

ArkTS API

@ohos.contact (Contacts)

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

@hms.enterpriseSpaceService.spaceManager (Workspace Management)

ArkTS API Error Codes

File Manager Service Kit

ArkTS APIs

fileManagerService

ArkTS API Error Codes

Icon Format Description

game_controller_type.h

GameDevice_AllDeviceInfos

GameDevice_DeviceInfo

GameDevice_DeviceEvent

GamePad_ButtonEvent

GamePad_AxisEvent

GamePad_PressedButton

Game Service Kit

ArkTS APIs

gamePlayer (Basic Game Service)

gamePerformance (Game Scene Perception)

gameNearbyTransfer (Nearby Transfer)

ArkTS API Error Codes

C APIs

Modules

GamePerformance

Header Files and Structs

Obtaining the Player ID

Obtaining playerId/openId/unionId Through gamePlayerId

Converting teamPlayerId in Batches

Disassociating an Account

Account Disassociation Notification

Health Service Kit

ArkTS APIs

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)

REST API

Overview

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

LiveViewLockScreenExtensionAbility

LiveViewLockScreenExtensionContext

LiveViewCardExtensionAbility

LiveViewCardExtensionContext

ArkTS API Error Codes

API Parameter Mapping Between Live View Kit and Push Kit

Location Kit

ArkTS APIs

@ohos.geoLocationManager (Geolocation Manager)

@ohos.app.ability.FenceExtensionAbility (FenceExtensionAbility)

@ohos.app.ability.FenceExtensionContext (FenceExtensionContext)

APIs No Longer Maintained

@ohos.geolocation (Geolocation)

@system.geolocation (Geolocation)

Location_RequestConfig

Location_Info

Error Codes

Location Kit Error Codes

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)

Types

Enums

Functions

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

Appendix

POI Types

City Codes and Administrative Division Codes

Supported Countries/Regions for Route Planning

ArkTS Components

MapComponent (Map Component)

Notification Kit

ArkTS APIs

@ohos.notificationManager (NotificationManager)

@ohos.notificationExtensionSubscription (notificationExtensionSubscription)

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

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

Notification

NotificationActionButton

NotificationCommonDef

NotificationContent

NotificationExtensionContent

NotificationUserInput

NotificationExtensionSubscriptionInfo

APIs No Longer Maintained

@ohos.notification (Notification)

@system.notification (Notification)

Notification Error Codes

Payment Kit

ArkTS API

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

Payment Result Callback Notification

Payment Query

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Applying for Refunds

Refund Result Callback Notification

Refund Query

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Payment and Signing

Pre-order

Payment Result Callback Notification

Payment Query

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Applying for Refunds

Refund Result Callback Notification

Refund Query

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

Pre-signing

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

Refund Query

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Bill

Querying Reconciliation Statements

Querying Settlement Bills

Platform Merchant/Service Provider

Basic Payment

Pre-order

Closing an Order

Payment Result Callback Notification

Payment Query

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Requesting Refunds

Refund Result Callback Notification

Refund Query

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Payment and Signing

Pre-order

Payment Result Callback Notification

Payment Query

Querying Order Information by sysTransOrderNo

Querying Order Information by mercOrderNo

Applying for Refunds

Refund Result Callback Notification

Refund Query

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

Pre-signing

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

Refund Query

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Combined Payment (Only for Platform Merchants)

Pre-order

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

Refund Query

Querying Refund Order Information by sysRefundOrderNo

Querying Refund Order Information by mercRefundOrderNo

Bill

Querying Reconciliation Bills

Querying Settlement Bills

Common APIs

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

Coupon Batch

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

User Coupons

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

Appendix

PDF Kit

ArkTS APIs

pdfService (PDF Services)

pdfViewManager (PDF Preview)

ArkTS Components

PdfView (PDF Preview Component)

ArkTS API Error Codes

Preview Kit

ArkTS APIs

filePreview (File Preview)

openFileBoost (File Open Boost) (Deprecated)

ArkTS API Error Codes

C APIs

Modules

Preview

Header Files and Structs

Anonymous Application Identifier (AAID)

pushCommon

pushService

RemoteNotificationExtensionAbility

RemoteNotificationExtensionContext

serviceNotification

VoIPExtensionAbility (Deprecated)

VoIPExtensionContext (Deprecated)

PushExtensionAbility

PushExtensionContext

RemoteLocationExtensionAbility

RemoteLocationExtensionContext

ArkTS API Error Codes

REST APIs

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

Service Updates Sending API

Service Updates Parameters

Reader Kit

ArkTS APIs

bookParser (Book Parsing Capability)

readerCore (Reader Kit Core Capabilities)

ArkTS Components

ReadPageComponent (Reading Page Component)

ArkTS API Error Codes

Scenario Fusion Kit

ArkTS APIs

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

ArkTS API

@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

Share Kit

ArkTS APIs

systemShare (System Share)

harmonyShare (Huawei Share)

ArkTS API Error Codes

Wallet Kit

ArkTS APIs

walletPass (Pass Capability)

walletTransitCard (Transportation Card Capability)

ArkTS API Error Codes

REST API Result Codes

Weather Service Kit

ArkTS APIs

weatherService (Weather Data Service)

ArkTS API Error Codes

ArkTS API Error Codes

Header Files and Structs

HiAISingleOpDescriptor_ConvolutionParam

HiAI_SingleOpExecutorConvolutionParam

HiAI_SingleOpExecutorFusedConvolutionActivationParam

Core Speech Kit

ArkTS API

textToSpeech (Text to Speech)

speechRecognizer (Speech Recognition)

ArkTS API Error Codes

Core Vision Kit

ArkTS API

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

Intents Kit

ArkTS APIs

insightIntent

InsightIntentUIExtensionAbility

ArkTS API Error Codes

jsonObject (Description of Parameters in Entity Return Value)

ArkTS API Error Codes

MindSpore Lite Kit

ArkTS APIs

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

OH_AI_TensorHandleArray

OH_AI_DeviceInfoHandle

OH_AI_TensorHandle

OH_AI_AllocatorHandle

OH_AI_ModelHandle

OH_AI_TrainCfgHandle

Neural Network Runtime Kit

neural_network_core.h

neural_network_runtime.h

neural_network_runtime_type.h

TextReader (Reading Control)

ReadStateCode (Reading Status)

WindowManager (Window Management)

ArkTS Components

TextReaderIcon (Speaker Icon)

TextReaderIconV2 (Speaker Icon)

AICaptionComponent (AICaption Component)

ArkTS API Error Codes

Vision Kit

ArkTS API

interactiveLiveness (Face Liveness Detection)

visionImageAnalyzer (AI Image Recognition)

ArkTS Components

CardRecognition (Card Recognition Control)

DocumentScanner (Document Scanning Control)

ArkTS API Error Codes

Common Capabilities

ArkTS API

Class (Console)

loadNativeModule (Synchronously and Dynamically Loading a System Library)

JSVM_PropertyDescriptor

JSVM_ExtendedErrorInfo

JSVM_TypeTag

JSVM_PropertyHandlerConfigurationStruct

JSVM_DefineClassOptions

JSVM_EscapableHandleScope__*

JSVM_CallbackInfo__*

JSVM_Deferred__*

JSVM_CallbackStruct*

JSVM_PropertyHandlerConfigurationStruct*

JSVM_CompileProfile

PurgMem

JSVM_DeserializeResult

Standard Libraries

Vulkan Development Overview

Vulkan Surface Development

Vulkan External Memory Development

VkSurfaceCreateInfoOHOS

VkNativeBufferOHOS

VkSwapchainImageCreateInfoOHOS

VkPhysicalDevicePresentationPropertiesOHOS

VkNativeBufferUsageOHOS

VkNativeBufferPropertiesOHOS

VkNativeBufferFormatPropertiesOHOS

VkImportNativeBufferInfoOHOS

VkMemoryGetNativeBufferInfoOHOS

Native API Symbols Not Exported

EGL Symbols Exported from Native APIs

ICU4C Symbols Exported from Native APIs

OpenGL ES 3.2 Symbols Exported from Native APIs

OpenGL Symbols

Seccomp-Provided System Call List

Certificate Management Error Codes

Last updated: 2026-10-15 01:23

Content overview

17500001 Internal Error

17500002 Certificate Not Exist

17500003 Invalid Certificate or Credential

17500004 The Number of Certificates or Credentials Reaches the Limit

17500005 Application Not Authorized

17500007 Device in Advanced Security Mode

17500009 Specified Certificate Storage Path Not Supported

17500010 Failed to Access the USB Credential

17500011 Failed to Validate the Input Parameter

Expand

NOTE

This topic describes only module-specific error codes. For details about universal error codes, see Universal Error Codes.

17500001 Internal Error

Error Message

Internal error. Possible causes: 1. IPC communication failed; 2. Memory operation error; 3. File operation error.

Description

Internal error. Possible causes: 1. IPC failed. 2. An error occurs during memory manipulation. 3. The file operation is incorrect.

Possible Causes

An internal error occurs when the API is called.

Solution

Check for and rectify the internal error.

17500002 Certificate Not Exist

Error Message

The certificate does not exist.

Description

The certificate does not exist.

Possible Causes

The certificate does not exist during certificate management.

Solution

Check whether the certificate exists.

17500003 Invalid Certificate or Credential

Error Message

The keystore is in an invalid format or the keystore password is incorrect.

Description

The keystore format is invalid or the keystore password is incorrect.

Possible Causes

The input certificate or credential is invalid.

Solution

Check that the certificate or credential is valid.

17500004 The Number of Certificates or Credentials Reaches the Limit

Error Message

The number of certificates or credentials reaches the maximum allowed.

Description

The number of certificates or credentials has reached the maximum.

Possible Causes

The number of installed certificates or credentials has reached the maximum.

Solution

Clear expired certificates or credentials.

17500005 Application Not Authorized

Error Message

The application is not authorized by the user.

Description

The app is not authorized.

Possible Causes

The user has not authorized the application to use the specified credential.

Solution

Check that the credential is correct, and authorize the application to use the credential.

17500007 Device in Advanced Security Mode

Error Message

The device enters advanced security mode.

Description

The device enters the advanced security mode.

Possible Causes

The user has enabled the advanced security mode.

Solution

Guide the user to disable the advanced security mode on the application UI.

17500009 Specified Certificate Storage Path Not Supported

Error Message

The device does not support the specified certificate store path.

Description

The device does not support the specified certificate storage path.

Possible Causes

The device does not support the specified certificate storage path.

Solution

Check whether the entered certificate type is correct.

17500010 Failed to Access the USB Credential

Error Message

The USB key service access failed.

Description

Failed to access the USB Key service.

Possible Causes

The USB hardware driver service is abnormal.

Solution

Check whether the USB is properly connected or the USB driver is working properly.

17500011 Failed to Validate the Input Parameter

Error Message

The input parameters validation failed.

Description

Failed to validate the input parameters.

Possible Causes

The parameter format is abnormal or the parameter range is invalid.

Solution

Check the input parameter format or range of the API.

Certificate Error Codes

Certificate Management Dialog Box Error Codes

Send feedback

Was this page helpful?

Send feedback

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

Community Q&A Intelligent Assistant