获取菜篮子开关状态功能
getBasketStatus
引入
@ray-js/ray^1.5.0 以上版本可使用
import { getBasketStatus } from '@ray-js/ray'
参数
无参数。
返回
GetBasketStatusResponse
属性 | 类型 | 说明 |
---|---|---|
appId | number | appId |
basketStatus | string | 菜篮子状态,true -开启;false -关闭 |
函数定义示例
/**
* 获取菜篮子开关状态
*/
export function getBasketStatus(): Promise<GetBasketStatusResponse>
获取菜篮子列表
getBasketList
引入
@ray-js/ray^1.5.0 以上版本可使用
import { getBasketList } from '@ray-js/ray'
参数
无参数。
返回
GetBasketListResponse
BasketInfo[]
,菜篮子信息数组。
BasketInfo
属性 | 类型 | 说明 |
---|---|---|
menuId | number | 食谱 ID |
name | string | 食谱名称 |
tagId | number | 食材标签 ID |
tagName | string | 食材标签名称 |
foodId | number | 食材 ID |
foodImage | string | 食材图片 |
foodName | string | 食材名称 |
foodDesc | string | 食材备注 |
amount | string | 食材数量(默认单位:克) |
secAmount | string | 第二单位数量 |
secUnit | string | 第二单位 ID |
secUnitCode | string | 第二单位 Code |
secUnitDesc | string | 第二单位描述 |
ownStatus | number | 持有状态 |
函数定义示例
/**
* 获取菜篮子列表
*/
export function getBasketList(): Promise<GetBasketListResponse>
添加食材到菜篮子
addFoodToBasket
引入
@ray-js/ray^1.5.0 以上版本可使用
import { addFoodToBasket } from '@ray-js/ray'
参数
AddFoodToBasketParams
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
foodList | FoodInfoToAdd[] | 是 | 食材信息列表 |
FoodInfoToAdd
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
menuId | number | 是 | 食谱 ID |
tagId | number | 否 | 食材标签 ID |
foodId | number | 是 | 食材 ID |
amount | string | 是 | 食材数量(默认单位:克) |
secAmount | string | 否 | 第二单位数量 |
secUnit | string | 否 | 第二单位 ID |
返回
AddFoodToBasketResponse
boolean
,表示添加成功或失败。
函数定义示例
/**
* 添加食材到菜篮子
*/
export function addFoodToBasket(params: AddFoodToBasketParams): Promise<AddFoodToBasketResponse>
👉 立即免费领取开发资源,体验涂鸦 MiniApp 小程序开发。
编辑菜篮子中的食材
updateFoodInBasket
引入
@ray-js/ray^1.5.0 以上版本可使用
import { updateFoodInBasket } from '@ray-js/ray'
参数
UpdateFoodInBasketParams
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
foodInfo | FoodInfoToUpdate | 是 | 食材信息 |
FoodInfoToUpdate
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
foodId | number | 是 | 食材 ID |
tagId | number | 否 | 食材标签 ID |
dataType | number | 是 | 数据维度 |
amountType | number | 是 | 数量类型 |
menuIds | number[] | 是 | 食谱 IDs |
amount | string | 否 | 食材数量 |
secUnit | string | 否 | 第二单位 ID |
返回
UpdateFoodInBasketResponse
boolean
,表示编辑成功或失败。
函数定义示例
/**
* 编辑菜篮子中的食材
*/
export function updateFoodInBasket(
params: UpdateFoodInBasketParams
): Promise<UpdateFoodInBasketResponse>
删除菜篮子中的食材
deleteFoodFromBasket
引入
@ray-js/ray^1.5.0 以上版本可使用
import { deleteFoodFromBasket } from '@ray-js/ray'
参数
DeleteFoodFromBasketParams
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
foodList | FoodInfoToDelete[] | 是 | 食材信息列表 |
FoodInfoToDelete
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
menuId | number | 是 | 食谱 ID |
tagId | number | 否 | 食材标签 ID |
foodId | number | 是 | 食材 ID |
secUnit | string | 否 | 第二单位 ID |
ownStatus | number | 是 | 持有状态 |
返回
DeleteFoodFromBasketResponse
boolean
,表示删除成功或失败。
函数定义示例
/**
* 删除菜篮子中的食材
*/
export function deleteFoodFromBasket(
params: DeleteFoodFromBasketParams
): Promise<DeleteFoodFromBasketResponse>
将菜篮子中的食材变为已持有
ownFoodInBasket
引入
@ray-js/ray^1.5.0 以上版本可使用
import { ownFoodInBasket } from '@ray-js/ray'
参数
OwnFoodInBasketParams
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
foodList | FoodInfoToOwn[] | 是 | 食材信息列表 |
FoodInfoToOwn
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
menuId | number | 是 | 食谱 ID |
tagId | number | 否 | 食材标签 ID |
foodId | number | 是 | 食材 ID |
secUnit | string | 否 | 第二单位 ID |
返回
OwnFoodInBasketResponse
boolean
,表示持有成功或失败。
函数定义示例
/**
* 将菜篮子中的食材变为已持有
*/
export function ownFoodInBasket(params: OwnFoodInBasketParams): Promise<OwnFoodInBasketResponse>
👉 立即免费领取开发资源,体验涂鸦 MiniApp 小程序开发。
将菜篮子中的食材变为未持有状态
wantFoodInBasket
引入
@ray-js/ray^1.5.0 以上版本可使用
import { wantFoodInBasket } from '@ray-js/ray'
参数
WantFoodInBasketParams
- 菜篮子食材未持有参数对象。
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
foodList | FoodInfoToWant[] | 是 | 食材信息列表 |
FoodInfoToWant
未持有的食材信息。
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
menuId | number | 是 | 食谱 ID |
tagId | number | 否 | 食材标签 ID |
foodId | number | 是 | 食材 ID |
secUnit | string | 否 | 替换食材第二单位(元数据 ID) |
返回
WantFoodInBasketResponse
boolean
,表示将菜篮子中的食材变为未持有结果的成功或失败。
函数定义示例
/**
* 将菜篮子中的食材变为未持有
* @param params - 菜篮子食材未持有参数
* @returns 将菜篮子中的食材变为未持有结果的 Promise
*/
export function wantFoodInBasket(params: WantFoodInBasketParams): Promise<WantFoodInBasketResponse>
清空菜篮子中所有食材
cleanBasket
引入
@ray-js/ray^1.5.0 以上版本可使用
import { cleanBasket } from '@ray-js/ray'
参数
无
返回
CleanBasketResponse
boolean
,表示清空菜篮子中所有食材结果的成功或失败。
函数定义示例
/**
* 清空菜篮子中所有食材
* @returns 清空菜篮子中所有食材结果的 Promise
*/
export function cleanBasket(): Promise<boolean>
获取菜篮子中未持有状态食材的营养成分
getNutritionOfBasket
引入
@ray-js/ray^1.5.0 以上版本可使用
import { getNutritionOfBasket } from '@ray-js/ray'
参数
无
返回
NutritionInfo
营养成分信息。
属性 | 类型 | 说明 |
---|---|---|
code | string | 营养成分 Code |
value | string | 营养成分值 |
函数定义示例
/**
* 获取菜篮子中未持有状态食材的营养成分
* @returns 获取菜篮子中未持有状态食材的营养成分结果的 Promise
*/
export function getNutritionOfBasket(): Promise<NutritionInfo[]>
判断食谱中是否有添加过食材至菜篮子
checkMenuExistInBasket
引入
@ray-js/ray^1.5.0 以上版本可使用
import { checkMenuExistInBasket } from '@ray-js/ray'
参数
CheckMenuExistInBasketParams
- 食谱是否有食材添加至菜篮子参数对象。
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
menuId | number | 是 | 食谱 ID |
返回
CheckMenuExistInBasketResponse
boolean
,表示判断食谱中是否有添加过食材至菜篮子结果。
函数定义示例
/**
* 判断食谱中是否有添加过食材至菜篮子
* @param params - 食谱是否有食材添加至菜篮子参数
* @returns 的 Promise
*/
export function checkMenuExistInBasket(
params: CheckMenuExistInBasketParams
): Promise<CheckMenuExistInBasketResponse>
👉 立即免费领取开发资源,体验涂鸦 MiniApp 小程序开发。