示例中心
功能在线体验
控制台

高德 开发 高德地图车机版 开发指南 C++平台 用户相关

更新时间:2018年07月23日

1.收藏夹信息查询

AmapApiRetCode AMapFavoriteReq(EGFavType eFavType)

  • 函数说明

  查询用户收藏夹的所有POI信息,包括家、公司、收藏点的POI信息、历史目的地。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 eFavType 

EGFAV_NORMAL = 0,       /**< 普通收藏点 */

EGFAV_HOME,        /**< 家 */

EGFAV_OFFICE,        /**< 公司 */

EGFAV_HISTORY,        /**< 历史目的地 */


  • 相关函数        

  AMapFavoriteRcvCbReg  

  • 典型应用

一般用于语音交互场合,比如用户通过VR说“历史目的地”,调用该接口传入 EGFAV_HISTORY ,导航就可以将历史目的地的信息透传给系统侧。


AmapApiRetCode AMapFavoriteRcvCbReg(FUNC_FavouriteRcv pFuncCb)

  • 函数说明

  接收导航透出的收藏夹信息。获取失败的原因详见下面参数说明。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pFuncCb 

收藏夹信息回调函数指针


 回调函数定义    typedef int (*FUNC_FavouriteRcv)(EGSetFavErr eErr, EGFavType eFavType, VEC_POI_INFO vecPoi)

参数

参数说明

 n32Ret 

EGERR_GETFAV_SUCCESS = 0, /**< 获取成功 */

EGERR_GETFAV_NO_DATA, /**< 没有数据 */

 eFavType 

EGFAV_NORMAL = 0,        /**< 普通收藏点 */

EGFAV_HOME,        /**< 家 */

EGFAV_OFFICE,        /**< 公司 */

EGFAV_HISTORY,        /**< 历史目的地 */

 vecPoi 

收藏夹POI信息集合,参考POI搜索章节的关键字搜索

  • 相关函数        

  AMapFavoriteReq 

  • 典型应用

2.添加当前车位到导航收藏夹

 AmapApiRetCode AMapAddFavorite(EGFavType eType, bool bForceRepalace) 

  • 函数说明

  添加当前车位所在的POI点信息到导航的收藏夹。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 eType 

EGFAV_NORMAL = 0,    /**< 普通收藏点 */

EGFAV_HOME,        /**< 家 */

EGFAV_OFFICE,        /**< 公司 */

EGFAV_HISTORY,        /**< 历史目的地 */


 bForceRepalace 

true - 强制替换。即如果当前收藏点已经收藏了,强制替换为当前的收藏点

false - 不替换。


  • 相关函数 

AMapAddFavoriteCbReg

  • 典型应用

一般用于收藏当前车位的信息至导航的收藏夹,但是如果此时收藏点信息已经存在了,且用户传入的是强制替换,那就直接替换重复的收藏点信息;如果用户传入的是不强制替换,那么就有二次交互的流程,导航会反馈给用户数据重复,这时候用户可以根据导航的反馈决定是否替换,即可再次调用该接口传入EGFAV_HOME和true(替换)或者false(不替换)实现收藏点的添加。

3.添加任意POI信息到导航收藏夹

AmapApiRetCode AMapAddPoiToNaviFavoriteReq(EGFavType eType, STSetDestInfo* pPoiInfo)

  • 函数说明

  添加任意点的POI信息到导航的收藏夹。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 eType

EGFAV_NORMAL  = 0,        /**< 普通收藏点 */

EGFAV_HOME  = 1,        /**< 家 */

EGFAV_OFFICE  = 2,        /**< 公司 */

EGFAV_HISTORY  = 3,        /**< 历史目的地 */


 pPoiInfo

char strName[MAX_POI_NAME_LEN + 1]; /**< 目的地名称 */ -- 非必填

STCoord stCoord; /**< 到达经纬度 */ -- 非必填

STCoord stShowCoord; /**< 显示经纬度 */ -- 必填

EGRoutingPolicy eRoutingPolicy; /**< 算路策略 */ -- 非必填

bool bMidWay; /**< 是否中途点 */ -- 非必填

char strPoiId[MAX_POI_ID_LEN + 1]; /**< POI id */ -- 非必填

char strAddr[MAX_POI_ADDR_LEN + 1]; /**< POI 地址 */ -- 非必填

EPoiType ePoiType; /**< POI类型 */ -- 非必填

char strTypeCode[16]; /**< POI TypeCode */ -- 非必填

int n32CoordType;/**< 0 - 高德坐标系 1 - 非高德坐标系*/ -- 非必填


  • 相关函数 

AMapAddFavoriteCbReg

  • 典型应用

与AMapAddFavorite不同,该接口是支持添加任意POI信息到导航收藏夹的,且如果有重复的直接强制替换,没有二次交互。注册接收导航侧添加收藏点是否成功的接口还是AMapAddFavoriteCbReg,与AMapAddFavorite共用。


AmapApiRetCode AMapAddFavoriteCbReg(FUNC_AddFavouriteRcv pFuncCb)

  • 函数说明

  系统接收导航返回收藏POI信息的结果反馈

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pFuncCb 

POI收藏反馈回调函数指针


 回调函数定义    typedef int (*FUNC_AddFavouriteRcv)(EGSetFavErr eErr)

参数

参数说明

 eErr 

EGERR_SETFAV_SUCCESS = 0, /**< 设置成功 */

EGERR_SETFAV_HOME_EXIST, /**< 家已经存在 */

EGERR_SETFAV_WORK_EXIST, /**< 公司已经存在 */

EGERR_SETFAV_NO_GPS_LOC, /**< GPS未定位 */

EGERR_SETFAV_NO_BASESTATION_LOC, /**< 基站未定位 */

EGERR_SETFAV_NO_DATA, /**< 没有数据 */

EGERR_SETFAV_REPEAT, /**< 重复数据 */

  • 相关函数 

AMapAddFavorite

  • 典型应用

一般用于语音交互场合,和AMapAddFavorite根据场景配合使用。

4. 取消收藏

AmapApiRetCode AMapCancleAddFarvorite(EGFavType eType)

  • 函数说明

  向导航请求取消当前的收藏。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 eType

EGFAV_NORMAL          = 0,        /**< normal favorites */

EGFAV_HOME            = 1,        /**< home */

EGFAV_OFFICE          = 2,        /**< office */

EGFAV_HISTORY         = 3,        /**< destination histories */

EGFAV_HISTORYINPUT_HISTORY = 4, /**< 历史搜索记录及历史目的地列表的记录 */


  • 相关函数 
  • 典型应用

5. 账号互通相关接口

5.1 绑定高德帐号

AmapApiRetCode AMapBindAccountReq(STGAccountBindReq *pBindReq)

  • 函数说明

  系统通知导航进行账户绑定。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pBindReq

string strSerKey;/**< 高德后台服务端分配给车企的ID,必填 */

string strCompany;/**< 车企名称,必填 */

string strUsrId;/**< 用户ID,必填 */

string strName;/**< 用户昵称 */

string strHeadAddr;/**< 用户头像地址 */

STGGpsTime tagBindTime;/**< 24小时制 */

string strPhoneNum;/**< 设备唯一识别码,如UUID */

string strBindedAccountId;/**< 用户已绑定过的账户ID*/


  • 相关函数 
  • 典型应用

 车机系统需要有一个界面,承载【绑定高德账号】按钮及【解绑高德账号】按钮,用户点击“绑定”调起高德执行绑定。 


AmapApiRetCode AMapRcvAccountInfoCbReg(FUNC_AccountInfoRcv pFuncb)

  • 函数说明

   高德绑定成功/失败通过回调函数通知系统 ,系统注册回调接收导航返回的头像信息、昵称、帐号信息。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pFuncb

帐号相关信息接收回调函数指针


回调函数定义    typedef int (*FUNC_AccountInfoRcv)(STGAmpAccountInfo* pAccountInfo)

参数

参数说明

 pAccountInfo

unsigned char* pImage; /**< 图片原始数据,未经解析的 */

unsigned int un32ImageSize; /**< 图片大小,单位:像素 */

string strName;  /**<  用户昵称 */

string strAutoAccount;/**< 高德帐号信息 */

bool bBindSuccess;/**< 是否绑定成功 */

EGTrigger eTrigger; /**< 帐号绑定的触发者 */

  • 相关函数 
  • 典型应用

5.2 导航查询车企账户信息

AmapApiRetCode AMapNaviQueryAccountCbReg(FUNC_NaviQueryAccountRcv pFuncb)

  • 函数说明

  系统注册回调接收导航查询车企的帐号信息。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pFuncb

接收导航请求账户信息的回调函数指针


回调函数定义    typedef int (*FUNC_NaviQueryAccountRcv)()

  • 相关函数 

 AMapCarAccoutNotify

  • 典型应用

 系统接收到导航发起的账号查询请求,通过接口返回当前车机登陆的账号信息 。


AmapApiRetCode AMapCarAccoutNotify(STGCarAccountInfo *pCarAccount)

  • 函数说明

  系统向导航通知车企帐号相关的信息,包含车企帐号信息、绑定的高德帐号信息、登录状态。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pCarAccount

string strSerKey;/**< 高德后台服务端分配给车企的ID,必填 */

string strCompany;/**< 车企名称,必填 */

string strSourceToken; /**< 车企帐号登录后的令牌,如果是已登录状态,必填*/

string strAutoAccount;/**< 本车企帐号绑定的高德帐号 - 高德已登录时必填,未登录时传空*/

string strCarAccount;/**< 车企帐号信息 - 车企已登录时必填,未登录时传空 */

bool bIsLogin;/**< 是否有高德帐号登录,必填 */

unsigned char* pImage; /**< 车企帐号图片原始数据,未经解析的. 已登录状态下必填 , 未登录状态下传空  */

unsigned int un32ImageSize; /**< 车企帐号图片大小,单位:像素.已登录状态下必填 , 未登录状态下传空 */

string strSourceUserName; /**< 车企帐号昵称. 已登录状态下必填 , 未登录状态下传空 */

string strDeviceId; /**< 设备唯一ID, 如UUID.非必填*/

string strAuthorId; /**< 车企账号代表的唯一ID,即AuthID. 已登录状态下必填 , 未登录状态下传空 */


  • 相关函数 

 AMapNaviQueryAccountCbReg

  • 典型应用

5.3 系统注销高德帐号

AmapApiRetCode AMapUnregAmapAccountReq(STGAccountUnregReq *pUnreg)

  • 函数说明

  系统向导航发起注销高德帐号的请求。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pUnreg

string strSerKey; /**< 高德后台服务端分配给车企的ID,必填 */ 

string strCompany;/**< 车企名称,必填 */

string strUsrId;/**< 用户ID,必填 */

string strPhoneNum;/**< 用户手机号 */


  • 相关函数 
  • 典型应用

 用户可通过车机系统的个人中心进行了解绑操作,解绑后高德Auto账号将退出登录状态,在车机账号中所有涉及高德的数据也被清空了,其中就包括地
图收藏夹,高德Auto不再与车机系统同步信息了。 


AmapApiRetCode AMapUnregRcvCbReg(FUNC_UnregRcv pFuncb)

  • 函数说明

 系统注册回调,用于接收导航侧帐号注销的结果通知。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pFuncb

接收注销结果回调函数指针


回调函数定义   typedef int (*FUNC_UnregRcv)(bool bRet)

参数

参数说明

 bRet

false - 失败

true - 成功

  • 相关函数 

AMapUnregAmapAccountReq

  • 典型应用

5.4 导航登录/登出状态通知

AmapApiRetCode AMapLogOnStatusRcvCbReg(FUNC_LogOnStatusRcv pFuncb)

  • 函数说明

 系统注册回调,用于接收导航侧的登录/登出状态通知。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pFuncb

解绑定接收回调函数指针


回调函数定义    typedef int (*FUNC_LogOnStatusRcv)(EUserAccountStatus  eStatus ,  STGLogOnInfo* pInfo)

参数

参数说明

  eStatus

E_ACT_LOG_IN, /**< 登入*/

E_ACT_LOG_OUT,/**< 主动登出(导航发起的登出)*/

E_ACT_PASSIVE_LOG_OUT,/**<被动登出(车企发起的登出)>*/

  pInfo

unsigned char* pImage; /**< 高德帐号图片原始数据,未经解析的 */

unsigned int un32ImageSize; /**< 高德帐号图片大小,单位:像素 */

string strName;  /**<  用户昵称 */

string strAutoAccount;/**< 高德帐号信息 */

string strUserAccount; /**< 用户帐号信息 */

  • 相关函数 
  • 典型应用

  Auto成功登录,需要通知车机系统当前登录高德账号信息,由系统侧判断是否需要进行绑定。 用户主动在auto端登出账号,需要通知车机系统当前账号
退出的信息。由系统侧判断是否需要执行解绑。

 5.5 导航通知系统进行帐号注册

AmapApiRetCode AMapRegisterRcvCbReg(FUNC_RegisterRcv pFuncb)

  • 函数说明

    用户在auto车机端进行账号登录操作时,根据项目配置判断是否需要先登陆车企账号。查询车机系统账号信息判断当前车企账号是否登录,若未登录,auto通过该接口可调起车机系统的登录页。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pFuncb

系统接收帐号注册通知的回调函数指针


回调函数定义    typedef int (*FUNC_RegisterRcv)()

  • 相关函数 
  • 典型应用

6. 停车支付场景

6.1 停车场支付信息接收

AmapApiRetCode AMapParkPayInfoRcvCbReg(FUNC_ParkPayInfoRcv pFuncCb)

  • 函数说明

   导航会根据车辆在不同的停车场场景,主动发送支付信息给车机。

  • 参数说明

参数

参数说明

是否必填

格式/样例

 pFuncCb

 接收支付信息的回调函数指针


回调函数的定义       typedef int (*FUNC_ParkPayInfoRcv)(STGPackPayInfo *pPayInfo)

参数

参数说明

 pPayInfo

EParkMode eParkMode; /**< 场景类型 */ -- 入场、场中、岗亭。

string strParkName;/**< 停车场名称 */

string strTitle;/**< 标题 */

string strContent;/**< 内容 */

VEC_BTN_TIPS vecButtonText;/**< 提示按钮内容 */

bool bIsPayByNoPasswd;/**< 免密支付状态 */

float f32TotalFee;/**< 支付费用/总费用 */

float f32UnPayFee;/**< 未支付费用 */

STGGpsTime tagDateTime;/**< 入场时间 */ -- 24小时制

unsigned int un32StayTime;/**< 停留时间 */ -- 单位是分钟

  • 相关函数        

AMapCancelPayByNoPasswdReq 

  • 典型应用

 停车场支付场景。

6.2 取消免密支付

AmapApiRetCode AMapCancelPayByNoPasswdReq()

  • 函数说明

   停车场支付默认是支付宝免密支付,用户可以通过该接口取消免密支付。

  • 参数说明
  • 相关函数        

AMapParkPayInfoRcvCbReg 

  • 典型应用

 停车场支付场景。 


示例中心 功能
在线体验
常见问题