xref: /drivers/interface/location/agnss/v2_0/IAGnssCallback.idl (revision c5e268c6)

/*
 * Copyright (c) 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.
 */

/*
 * @addtogroup HdiAGnss
 * @{
 *
 * @brief Provides unified APIs for the AGNSS service.
 *
 * The upper layer can use the interfaces provided by this module to set the AGNSS callback, AGNSS server address,
 * AGNSS reference information, and setId.
 *
 * @since 5.0
 */

/*
 * @file IAGnssCallback.idl
 *
 * @brief Defines the agnss callback to request the upper layer to establish or release data services,
 * request the upper layer to deliver setId, and request the upper layer to deliver the agnss reference information.
 *
 * @since 5.0
 * @version 2.0
 */

package ohos.hdi.location.agnss.v2_0;

import ohos.hdi.location.agnss.v2_0.AGnssTypes;

/*
 * @brief Defines the agnss callback to request the upper layer to establish or release data services,
 * request the upper layer to deliver setId, and request the upper layer to deliver the agnss reference information.
 *
 * @since 5.0
 */
[callback] interface IAGnssCallback {
    /*
     * @brief Request the upper layer to establish or release data services.
     *
     * @param request Indicates the request information for operating the data service.
     * For details, see {@link AGnssDataLinkRequest}.
     * @return Returns <b>0</b> if send request successed; returns a negative value otherwise.
     *
     * @since 5.0
     * @version 2.0
     */
    RequestSetUpAgnssDataLink([in] struct AGnssDataLinkRequest request);

    /*
     * @brief Request the upper layer to deliver the subscriber identity.
     *
     * @param type Indicates the type of setId. For details, see {@link SubscriberSetIdType}.
     * @return Returns <b>0</b> if send request successed; returns a negative value otherwise.
     *
     * @since 5.0
     * @version 2.0
     */
    RequestSubscriberSetId([in] enum SubscriberSetIdType type);

    /*
     * @brief Request upper-layer ingest reference information.
     *
     * @param type Indicates the type of reference information. For details, see {@link AGnssRefInfoType}.
     * @return Returns <b>0</b> if send request successed; returns a negative value otherwise.
     *
     * @since 5.0
     * @version 2.0
     */
    RequestAgnssRefInfo([in] enum AGnssRefInfoType type);
}
/** @} */