1 Star 0 Fork 3.9K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.telephony.observer.d.ts 40.29 KB
一键复制 编辑 原始数据 按行查看 历史
dingxiaochen 提交于 2024-07-09 17:13 +08:00 . fix js docs.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935
/*
* Copyright (C) 2021-2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit TelephonyKit
*/
import type { Callback } from './@ohos.base';
import type radio from './@ohos.telephony.radio';
import type data from './@ohos.telephony.data';
import type call from './@ohos.telephony.call';
import type sim from './@ohos.telephony.sim';
/**
* Monitors telephony state updates of a device, including updates of the network state,
* signal strength, call state, the data link connection state and others.
*
* @namespace observer
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
declare namespace observer {
/**
* Describes the network registration state.
*
* @typedef { radio.NetworkState }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
type NetworkState = radio.NetworkState;
/**
* Describes the signal strength information.
*
* @typedef { radio.SignalInformation }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
type SignalInformation = radio.SignalInformation;
/**
* Describes current cell information.
*
* @typedef { radio.CellInformation }
* @syscap SystemCapability.Telephony.StateRegistry
* @systemapi Hide this for inner system use.
* @since 6
*/
type CellInformation = radio.CellInformation;
/**
* Describes the cellular data link connection state.
*
* @typedef { data.DataConnectState }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
type DataConnectState = data.DataConnectState;
/**
* Describes the radio access technology.
*
* @typedef { radio.RadioTechnology }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
type RatType = radio.RadioTechnology;
/**
* Describes the cellular data flow type.
*
* @typedef { data.DataFlowType }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
type DataFlowType = data.DataFlowType;
/**
* Indicates the states of call.
*
* @typedef { call.CallState }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
type CallState = call.CallState;
/**
* Indicates the SIM card types.
*
* @typedef { sim.CardType }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
type CardType = sim.CardType;
/**
* Indicates the SIM card states.
*
* @typedef { sim.SimState }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
type SimState = sim.SimState;
/**
* Callback when the network state corresponding to the default sim card is updated.
*
* @permission ohos.permission.GET_NETWORK_INFO
* @param { 'networkStateChange' } type - Event type. Indicates the networkStateChange event to be subscribed to.
* @param { Callback<NetworkState> } callback - Indicates the callback for
* getting an instance of the {@code NetworkState} class.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
function on(type: 'networkStateChange', callback: Callback<NetworkState>): void;
/**
* Callback when the network state corresponding to the monitored {@code slotId} is updated.
*
* @permission ohos.permission.GET_NETWORK_INFO
* @param { 'networkStateChange' } type - Event type. Indicates the networkStateChange event to be subscribed to.
* @param { object } options - Indicates the ID of the target card slot.
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
* @param { Callback<NetworkState> } callback - Indicates the callback for getting
* an instance of the {@code NetworkState} class.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
/**
* Callback when the network state corresponding to the monitored {@code slotId} is updated.
*
* @permission ohos.permission.GET_NETWORK_INFO
* @param { 'networkStateChange' } type - Event type. Indicates the networkStateChange event to be subscribed to.
* @param { ObserverOptions } options - Indicates the options for observer.
* @param { Callback<NetworkState> } callback - Indicates the callback for getting
* an instance of the {@code NetworkState} class.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function on(type: 'networkStateChange', options: ObserverOptions, callback: Callback<NetworkState>): void;
/**
* Cancel callback when the network state is updated.
*
* @param { 'networkStateChange' } type - Event type. Indicates the networkStateChange event to unsubscribe from.
* @param { Callback<NetworkState> } callback - Indicates the callback for getting
* an instance of the {@code NetworkState} class.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
function off(type: 'networkStateChange', callback?: Callback<NetworkState>): void;
/**
* Callback when the signal strength corresponding to the default sim card is updated.
*
* @param { 'signalInfoChange' } type - Event type. Indicates the signalInfoChange event to be subscribed to.
* @param { Callback<Array<SignalInformation>> } callback - Indicates the callback for getting
* an array of instances of the classes derived from {@link SignalInformation}.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
function on(type: 'signalInfoChange', callback: Callback<Array<SignalInformation>>): void;
/**
* Callback when the signal strength corresponding to a monitored {@code slotId} is updated.
*
* @param { 'signalInfoChange' } type - Event type. Indicates the signalInfoChange event to be subscribed to.
* @param { object } options - Indicates the ID of the target card slot.
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
* @param { Callback<Array<SignalInformation>> } callback - Indicates the callback for getting
* an array of instances of the classes derived from {@link SignalInformation}.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
/**
* Callback when the signal strength corresponding to a monitored {@code slotId} is updated.
*
* @param { 'signalInfoChange' } type - Event type. Indicates the signalInfoChange event to be subscribed to.
* @param { ObserverOptions } options - Indicates the options for observer.
* @param { Callback<Array<SignalInformation>> } callback - Indicates the callback for getting
* an array of instances of the classes derived from {@link SignalInformation}.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function on(type: 'signalInfoChange', options: ObserverOptions, callback: Callback<Array<SignalInformation>>): void;
/**
* Cancel callback when the signal strength is updated.
*
* @param { 'signalInfoChange' } type - Event type. Indicates the signalInfoChange event to unsubscribe from.
* @param { Callback<Array<SignalInformation>> } callback - Indicates the callback to unsubscribe from
* the signalInfoChange event.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
function off(type: 'signalInfoChange', callback?: Callback<Array<SignalInformation>>): void;
/**
* Callback when the cell information corresponding to the default sim card is updated.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'cellInfoChange' } type - Event type. Indicates the cellInfoChange event to be subscribed to.
* @param { Callback<Array<CellInformation>> } callback - Indicates the callback for getting
* an array of instances of the classes derived from {@link CellInformation}.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @systemapi Hide this for inner system use.
* @since 8
*/
function on(type: 'cellInfoChange', callback: Callback<Array<CellInformation>>): void;
/**
* Callback when the cell information corresponding to a monitored {@code slotId} is updated.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'cellInfoChange' } type - Event type. Indicates the cellInfoChange event to be subscribed to.
* @param { object } options - Indicates the ID of the target card slot.
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
* @param { Callback<Array<CellInformation>> } callback - Indicates the callback for getting
* an array of instances of the classes derived from {@link CellInformation}.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @systemapi Hide this for inner system use.
* @since 8
*/
/**
* Callback when the cell information corresponding to a monitored {@code slotId} is updated.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'cellInfoChange' } type - Event type. Indicates the cellInfoChange event to be subscribed to.
* @param { ObserverOptions } options - Indicates the options for observer.
* @param { Callback<Array<CellInformation>> } callback - Indicates the callback for getting
* an array of instances of the classes derived from {@link CellInformation}.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @systemapi Hide this for inner system use.
* @since 11
*/
function on(type: 'cellInfoChange', options: ObserverOptions, callback: Callback<Array<CellInformation>>): void;
/**
* Cancel callback when the cell information is updated.
*
* @param { 'cellInfoChange' } type - Event type. Indicates the cellInfoChange event to unsubscribe from.
* @param { Callback<Array<CellInformation>> } callback - Indicates the callback to unsubscribe from
* the cellInfoChange event.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @systemapi Hide this for inner system use.
* @since 8
*/
function off(type: 'cellInfoChange', callback?: Callback<Array<CellInformation>>): void;
/**
* Callback when the cellular data link connection state corresponding to the default sim card is updated.
*
* @param { 'cellularDataConnectionStateChange' } type - Event type. Indicates the cellularDataConnectionStateChange
* event to be subscribed to.
* @param { Callback<{ state: DataConnectState, network: RatType }> } callback - Indicates the callback for
* getting the cellular data link connection state, and networkType Indicates the radio access technology
* for cellular data services.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
/**
* Callback when the cellular data link connection state corresponding to the default sim card is updated.
*
* @param { 'cellularDataConnectionStateChange' } type - Event type. Indicates the cellularDataConnectionStateChange
* event to be subscribed to.
* @param { Callback<DataConnectionStateInfo> } callback - Indicates the callback for
* getting the cellular data link connection state, and networkType Indicates the radio access technology
* for cellular data services.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function on(type: 'cellularDataConnectionStateChange', callback: Callback<DataConnectionStateInfo>): void;
/**
* Callback when the cellular data link connection state corresponding to the monitored {@code slotId} is updated.
*
* @param { 'cellularDataConnectionStateChange' } type - Event type. Indicates the cellularDataConnectionStateChange
* event to be subscribed to.
* @param { object } options - Indicates the ID of the target card slot.
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
* @param { Callback<{ state: DataConnectState, network: RatType }> } callback - Indicates the callback for
* getting the cellular data link connection state, and networkType Indicates the radio access technology for
* cellular data services.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
/**
* Callback when the cellular data link connection state corresponding to the monitored {@code slotId} is updated.
*
* @param { 'cellularDataConnectionStateChange' } type - Event type. Indicates the cellularDataConnectionStateChange
* event to be subscribed to.
* @param { ObserverOptions } options - Indicates the options for observer.
* @param { Callback<DataConnectionStateInfo> } callback - Indicates the callback for
* getting the cellular data link connection state, and networkType Indicates the radio access technology for
* cellular data services.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function on(type: 'cellularDataConnectionStateChange', options: ObserverOptions,
callback: Callback<DataConnectionStateInfo>): void;
/**
* Cancel callback when the cellular data link connection state is updated.
*
* @param { 'cellularDataConnectionStateChange' } type - Event type. Indicates the cellularDataConnectionStateChange
* event to unsubscribe from.
* @param { Callback<{ state: DataConnectState, network: RatType }> } callback - Indicates the callback to unsubscribe
* from the cellularDataConnectionStateChange event.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
/**
* Cancel callback when the cellular data link connection state is updated.
*
* @param { 'cellularDataConnectionStateChange' } type - Event type. Indicates the cellularDataConnectionStateChange
* event to unsubscribe from.
* @param { Callback<DataConnectionStateInfo> } callback - Indicates the callback to unsubscribe
* from the cellularDataConnectionStateChange event.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function off(type: 'cellularDataConnectionStateChange', callback?: Callback<DataConnectionStateInfo>): void;
/**
* Callback when the uplink and downlink data flow state of cellular data services
* corresponding to the default sim card is updated.
*
* @param { 'cellularDataFlowChange' } type - Event type. Indicates the cellularDataFlowChange event to be subscribed to.
* @param { Callback<DataFlowType> } callback - Indicates the callback for getting the cellular data flow state.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
function on(type: 'cellularDataFlowChange', callback: Callback<DataFlowType>): void;
/**
* Callback when the uplink and downlink data flow state of cellular data services
* corresponding to the monitored {@code slotId} is updated.
*
* @param { 'cellularDataFlowChange' } type - Event type. Indicates the cellularDataFlowChange event to be subscribed to.
* @param { object } options - Indicates the ID of the target card slot.
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
* @param { Callback<DataFlowType> } callback - Indicates the callback for getting the cellular data flow state.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
/**
* Callback when the uplink and downlink data flow state of cellular data services
* corresponding to the monitored {@code slotId} is updated.
*
* @param { 'cellularDataFlowChange' } type - Event type. Indicates the cellularDataFlowChange event to be subscribed to.
* @param { ObserverOptions } options - Indicates the options for observer.
* @param { Callback<DataFlowType> } callback - Indicates the callback for getting the cellular data flow state.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function on(type: 'cellularDataFlowChange', options: ObserverOptions, callback: Callback<DataFlowType>): void;
/**
* Cancel callback when the uplink and downlink data flow state of cellular data services is updated.
*
* @param { 'cellularDataFlowChange' } type - Event type. Indicates the cellularDataFlowChange event to unsubscribe from.
* @param { Callback<DataFlowType> } callback - Indicates the callback to unsubscribe from
* the cellularDataFlowChange event.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
function off(type: 'cellularDataFlowChange', callback?: Callback<DataFlowType>): void;
/**
* Callback when the call state corresponding to the default sim card is updated.
*
* @param { 'callStateChange' } type - Event type. Indicates the callStateChange event to be subscribed to.
* @param { Callback<{ state: CallState, number: string }> } callback - Indicates the callback for
* getting the call state and the called number.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
/**
* Callback when the call state corresponding to the default sim card is updated.
*
* @param { 'callStateChange' } type - Event type. Indicates the callStateChange event to be subscribed to.
* @param { Callback<CallStateInfo> } callback - Indicates the callback for
* getting the call state and the called number.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function on(type: 'callStateChange', callback: Callback<CallStateInfo>): void;
/**
* Callback when the call state corresponding to the monitored {@code slotId} is updated.
*
* @param { 'callStateChange' } type - Event type. Indicates the callStateChange event to be subscribed to.
* @param { object } options - Indicates the ID of the target card slot.
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
* @param { Callback<{ state: CallState, number: string }> } callback - Indicates the callback for
* getting the call state and the called number.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
/**
* Callback when the call state corresponding to the monitored {@code slotId} is updated.
*
* @param { 'callStateChange' } type - Event type. Indicates the callStateChange event to be subscribed to.
* @param { ObserverOptions } options - Indicates the options for observer.
* @param { Callback<CallStateInfo> } callback - Indicates the callback for
* getting the call state and the called number.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function on(type: 'callStateChange', options: ObserverOptions, callback: Callback<CallStateInfo>): void;
/**
* Cancel callback when the call state is updated.
*
* @param { 'callStateChange' } type - Event type. Indicates the callStateChange event to unsubscribe from.
* @param { Callback<{ state: CallState, number: string }> } callback - Indicates the callback to
* unsubscribe from the callStateChange event.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 6
*/
/**
* Cancel callback when the call state is updated.
*
* @param { 'callStateChange' } type - Event type. Indicates the callStateChange event to unsubscribe from.
* @param { Callback<CallStateInfo> } callback - Indicates the callback to
* unsubscribe from the callStateChange event.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function off(type: 'callStateChange', callback?: Callback<CallStateInfo>): void;
/**
* Callback when the sim state corresponding to the default sim card is updated.
*
* @param { 'simStateChange' } type - Event type. Indicates the simStateChange event to be subscribed to.
* @param { Callback<SimStateData> } callback - Indicates the callback for getting the SimStateData object.
* including state Indicates the sim state, and reason Indicates the cause of the change.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
function on(type: 'simStateChange', callback: Callback<SimStateData>): void;
/**
* Callback when the sim state corresponding to the monitored {@code slotId} is updated.
*
* @param { 'simStateChange' } type - Event type. Indicates the simStateChange event to be subscribed to.
* @param { object } options - Indicates the ID of the target card slot.
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
* @param { Callback<SimStateData> } callback - Indicates the callback for getting the SimStateData object.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
/**
* Callback when the sim state corresponding to the monitored {@code slotId} is updated.
*
* @param { 'simStateChange' } type - Event type. Indicates the simStateChange event to be subscribed to.
* @param { ObserverOptions } options - Indicates the options for observer.
* @param { Callback<SimStateData> } callback - Indicates the callback for getting the SimStateData object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
function on(type: 'simStateChange', options: ObserverOptions, callback: Callback<SimStateData>): void;
/**
* Cancel callback when the sim state is updated.
*
* @param { 'simStateChange' } type - Event type. Indicates the simStateChange event to unsubscribe from.
* @param { Callback<SimStateData> } callback - Indicates the callback to unsubscribe from the simStateChange event.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
function off(type: 'simStateChange', callback?: Callback<SimStateData>): void;
/**
* Receives an ICC account change. This callback is invoked when the ICC account updates
* and the observer is added to monitor the updates.
*
* @param { 'iccAccountInfoChange' } type - iccAccountInfoChange
* @param { Callback<void> } callback - including state Indicates the ICC account information,
* and reason Indicates the cause of the change.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 10
*/
function on(type: 'iccAccountInfoChange', callback: Callback<void>): void;
/**
* Cancel to receive an ICC account change.
*
* @param { 'iccAccountInfoChange' } type - iccAccountInfoChange
* @param { Callback<void> } callback - including state Indicates the ICC account information,
* and reason Indicates the cause of the change.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @throws { BusinessError } 8300001 - Invalid parameter value.
* @throws { BusinessError } 8300002 - Service connection failed.
* @throws { BusinessError } 8300003 - System internal error.
* @throws { BusinessError } 8300999 - Unknown error.
* @syscap SystemCapability.Telephony.StateRegistry
* @since 10
*/
function off(type: 'iccAccountInfoChange', callback?: Callback<void>): void;
/**
* Indicates SIM card type and status.
*
* @interface SimStateData
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
export interface SimStateData {
/**
* Indicates the SIM card type.
*
* @type { CardType }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
type: CardType;
/**
* Indicates the SIM card states.
*
* @type { SimState }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 7
*/
state: SimState;
/**
* Indicates the SIM card lock type.
*
* @type { LockReason }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
reason: LockReason;
}
/**
* Indicates call state and number.
*
* @interface CallStateInfo
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
export interface CallStateInfo {
/**
* Indicates call state.
*
* @type { CallState }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
state: CallState;
/**
* Indicates call number.
*
* @type { string }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
number: string;
}
/**
* Indicates cellular data connect state and technology type.
*
* @interface DataConnectionStateInfo
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
export interface DataConnectionStateInfo {
/**
* Indicates cellular data connect state.
*
* @type { DataConnectState }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
state: DataConnectState;
/**
* Indicates technology type.
*
* @type { RatType }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
network: RatType;
}
/**
* Indicates observer options.
*
* @interface ObserverOptions
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
export interface ObserverOptions {
/**
* Indicates the ID of the target card slot.
*
* @type { number }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 11
*/
slotId: number;
}
/**
* Enum for SIM card lock type.
*
* @enum { number }
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
export enum LockReason {
/**
* Indicates no SIM lock.
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_NONE,
/**
* Indicates the PIN lock.
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PIN,
/**
* Indicates the PUK lock.
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PUK,
/**
* Indicates network personalization of PIN lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PN_PIN,
/**
* Indicates network personalization of PUK lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PN_PUK,
/**
* Indicates network subset personalization of PIN lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PU_PIN,
/**
* Indicates network subset personalization of PUK lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PU_PUK,
/**
* Indicates service provider personalization of PIN lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PP_PIN,
/**
* Indicates service provider personalization of PUK lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PP_PUK,
/**
* Indicates corporate personalization of PIN lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PC_PIN,
/**
* Indicates corporate personalization of PUK lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_PC_PUK,
/**
* Indicates SIM/USIM personalization of PIN lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_SIM_PIN,
/**
* Indicates SIM/USIM personalization of PUK lock(refer 3GPP TS 22.022 [33]).
*
* @syscap SystemCapability.Telephony.StateRegistry
* @since 8
*/
SIM_SIM_PUK,
}
}
export default observer;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助