API
Return to top
AvatarEditorService
编辑

服务 / AvatarEditorService

AvatarEditorService Class
​

Avatar商城的应用内购服务

Table of contents ​

Accessors
​

avatarServiceDelegate(): MulticastDelegate<(eventName: string, ...params: unknown[]) => void> client
角编商城状态发生变化时会触发的委托
onAccountBalanceUpdated(): MulticastDelegate<(balance: BalanceInfo) => void> client
获取代币和积分余额更新的委托。购买成功后/充值成功后, 都会触发
onOrderDelivered(): MulticastDelegate<(resp: ShipOrderResponse) => void> client
玩家数据服务完成发货后会触发的委托
onRecharge(): MulticastDelegate<(info: RechargeInfo) => void> client
玩家充值时会触发的委托

Methods
​

asyncCloseAvatarEditorModule(): Promise<void> client
打开角编商城
asyncDumpImg(locImgPath: string, imgName: string): Promise<string> client
本地图片路径转存成网络图
asyncGetCashPayEnabled(): Promise<boolean> client
异步查询现金支付是否支持
asyncGetCommodityByAssetIds(assetIds: string[]): Promise<CommodityListObj> client
通过资源Id获取商品列表
asyncGetCommodityListByItemIds(itemIds: number[]): Promise<CommodityListObj> client
通过物品Id获取商品列表
asyncGetCommodityListByTag(tagIds: number[]): Promise<CommodityListObj> client
获取商品列表
asyncGetMyItemsListByTag(tagIds: number[]): Promise<CommodityListObj> client
获取我可使用的物品列表
asyncGetPointPayEnabled(): Promise<boolean> client
异步查询积分支付是否支持
asyncOpenAvatarEditorModule(extraInfo?: any): Promise<boolean> client
打开角编商城
asyncSaveAvatarAndUpdateProfile(targetNPC: Character, updateHead?: boolean): Promise<number> client
保存平台形象，并更新全身照。是否更新头像，取决于入参。
getAccountBalance(): void client
获取余额。会同时更新代币和积分的余额。
placeOrder(commodityList: CommodityInfo[], [placeOrder](mw.AvatarEditorService.md#placeorder)Result): void client
下单商品并跳转支付，可以指定多个商品进行购买。如果需要携带额外信息（比如折扣token），可以加入到CommodityInfo.expand字段中
promptRecharge(): void client
拉起充值页面
setAvatarEditorButtonAbility(ability: number): void client
设置角色编辑器按钮的功能
setAvatarEditorButtonVisible(visible: boolean): void client
设置角色编辑器按钮可见性

Accessors ​

avatarServiceDelegate
​

• Static get avatarServiceDelegate(): MulticastDelegate<(eventName: string, ...params: unknown[]) => void> client

角编商城状态发生变化时会触发的委托

Returns ​

MulticastDelegate<(eventName: string, ...params: unknown[]) => void>

onAccountBalanceUpdated
​

• Static get onAccountBalanceUpdated(): MulticastDelegate<(balance: BalanceInfo) => void> client

获取代币和积分余额更新的委托。购买成功后/充值成功后, 都会触发

Returns ​

MulticastDelegate<(balance: BalanceInfo) => void>代币余额更新的委托。coin对应代币余额，point对应积分余额

onOrderDelivered
​

• Static get onOrderDelivered(): MulticastDelegate<(resp: ShipOrderResponse) => void> client

玩家数据服务完成发货后会触发的委托

Returns ​

MulticastDelegate<(resp: ShipOrderResponse) => void>订单发货的委托

onRecharge
​

• Static get onRecharge(): MulticastDelegate<(info: RechargeInfo) => void> client

玩家充值时会触发的委托

Returns ​

MulticastDelegate<(info: RechargeInfo) => void>充值时会触发的委托

Methods ​

asyncCloseAvatarEditorModule
​

• Static asyncCloseAvatarEditorModule(): Promise<void> client

打开角编商城

Returns ​

Promise<void>

asyncDumpImg
​

• Static asyncDumpImg(locImgPath, imgName): Promise<string> client

本地图片路径转存成网络图

Parameters ​

locImgPath string本地图片文件路径
imgName string本地图片文件名

Returns ​

Promise<string>成功返回url，失败返回null

asyncGetCashPayEnabled
​

• Static asyncGetCashPayEnabled(): Promise<boolean> client

异步查询现金支付是否支持

Returns ​

Promise<boolean>

asyncGetCommodityByAssetIds
​

• Static asyncGetCommodityByAssetIds(assetIds): Promise<CommodityListObj> client

通过资源Id获取商品列表

Parameters ​

assetIds string[]用于筛选商品的AssetId数组

Returns ​

Promise<CommodityListObj>商品列表

asyncGetCommodityListByItemIds
​

• Static asyncGetCommodityListByItemIds(itemIds): Promise<CommodityListObj> client

通过物品Id获取商品列表

Parameters ​

itemIds number[]用于筛选商品的ItemId数组

Returns ​

Promise<CommodityListObj>商品列表

asyncGetCommodityListByTag
​

• Static asyncGetCommodityListByTag(tagIds): Promise<CommodityListObj> client

获取商品列表

Parameters ​

tagIds number[]用于筛选商品的Tag数组

Returns ​

Promise<CommodityListObj>商品列表

asyncGetMyItemsListByTag
​

• Static asyncGetMyItemsListByTag(tagIds): Promise<CommodityListObj> client

获取我可使用的物品列表

Parameters ​

tagIds number[]用于筛选商品的Tag数组

Returns ​

Promise<CommodityListObj>物品列表

asyncGetPointPayEnabled
​

• Static asyncGetPointPayEnabled(): Promise<boolean> client

异步查询积分支付是否支持

Returns ​

Promise<boolean>

asyncOpenAvatarEditorModule
​

• Static asyncOpenAvatarEditorModule(extraInfo?): Promise<boolean> client

打开角编商城

Parameters ​

extraInfo? any额外的传参 default: undefined

Returns ​

Promise<boolean>

asyncSaveAvatarAndUpdateProfile
​

• Static asyncSaveAvatarAndUpdateProfile(targetNPC, updateHead?): Promise<number> client

保存平台形象，并更新全身照。是否更新头像，取决于入参。

Parameters ​

targetNPC Character目标NPC
updateHead? boolean是否更新头像。不影响形象保存和全身照的更新。default: true

Returns ​

Promise<number>```

getAccountBalance
​

• Static getAccountBalance(): void client

获取余额。会同时更新代币和积分的余额。

placeOrder
​

• Static placeOrder(commodityList, placeOrderResult): void client

下单商品并跳转支付，可以指定多个商品进行购买。如果需要携带额外信息（比如折扣token），可以加入到CommodityInfo.expand字段中

Parameters ​

commodityList CommodityInfo[]商品信息 range: 依据 商品数量 而定
placeOrderResult (status: number, msg: string, orderId: string) => void订单状态回调

status 含义：

ts
status = 200: 订单支付成功
status = 408: 请求超时
status = 409: 处理下单回调报错
status = 410: 处理支付回调报错
status = 501: 余额不足
status = 502: 暂未开放购买
status = 503: 参数类型错误
status = 504: 用户取消
status = 505: 轮询失败，未支付成功
status = 506: 该版本不支持 payType
status = 507: 未知异常，包括但不限于网络连接失败
其它：服务端返回的错误码，包括但不限于：下单，预支付，轮询等接口的报错
status = 200: 订单支付成功
status = 408: 请求超时
status = 409: 处理下单回调报错
status = 410: 处理支付回调报错
status = 501: 余额不足
status = 502: 暂未开放购买
status = 503: 参数类型错误
status = 504: 用户取消
status = 505: 轮询失败，未支付成功
status = 506: 该版本不支持 payType
status = 507: 未知异常，包括但不限于网络连接失败
其它：服务端返回的错误码，包括但不限于：下单，预支付，轮询等接口的报错

promptRecharge
​

• Static promptRecharge(): void client

拉起充值页面

setAvatarEditorButtonAbility
​

• Static setAvatarEditorButtonAbility(ability): void client

设置角色编辑器按钮的功能

Parameters ​

ability number1 - 去装扮；2 - 打开角编商城；3 - 打开角色名片

setAvatarEditorButtonVisible
​

• Static setAvatarEditorButtonVisible(visible): void client

设置角色编辑器按钮可见性

Parameters ​

visible booleantrue表示可见，false不可见