cn.stylefeng.roses.kernel.sms.modular.service

接口 SysSmsInfoService

所有超级接口:

com.baomidou.mybatisplus.extension.service.IService<SysSms>

所有已知实现类:

SysSmsInfoServiceImpl

public interface SysSmsInfoService
extends com.baomidou.mybatisplus.extension.service.IService<SysSms>

系统短信service接口

作者:

fengshuonan

字段概要

从接口继承的字段 com.baomidou.mybatisplus.extension.service.IService

DEFAULT_BATCH_SIZE

方法概要

限定符和类型	方法和说明
cn.stylefeng.roses.kernel.db.api.pojo.page.PageResult<SysSms>	page(SysSmsInfoParam sysSmsInfoParam) 短信发送记录查询
Long	saveSmsInfo(SysSmsSendParam sysSmsSendParam, String validateCode) 存储短信验证信息
boolean	sendShortMessage(SysSmsSendParam sysSmsSendParam) 发送短信
void	updateSmsInfo(Long smsId, SmsSendStatusEnum smsSendStatusEnum) 更新短息发送状态
void	validateSmsInfo(SysSmsVerifyParam sysSmsVerifyParam) 校验验证码是否正确 如果校验失败，或者短信超时，则会抛出异常

从接口继承的方法 com.baomidou.mybatisplus.extension.service.IService

count, count, getBaseMapper, getById, getEntityClass, getMap, getObj, getOne, getOne, ktQuery, ktUpdate, lambdaQuery, lambdaUpdate, list, list, listByIds, listByMap, listMaps, listMaps, listObjs, listObjs, listObjs, listObjs, page, page, pageMaps, pageMaps, query, remove, removeBatchByIds, removeBatchByIds, removeBatchByIds, removeBatchByIds, removeById, removeById, removeById, removeByIds, removeByIds, removeByMap, save, saveBatch, saveBatch, saveOrUpdate, saveOrUpdate, saveOrUpdateBatch, saveOrUpdateBatch, update, update, update, updateBatchById, updateBatchById, updateById

方法详细资料

sendShortMessage

boolean sendShortMessage(SysSmsSendParam sysSmsSendParam)

发送短信

参数:

sysSmsSendParam - 短信发送参数

返回:

true-成功，false-失败

saveSmsInfo

Long saveSmsInfo(SysSmsSendParam sysSmsSendParam,
                 String validateCode)

存储短信验证信息

参数:

sysSmsSendParam - 发送参数

validateCode - 验证码

返回:

短信记录id

updateSmsInfo

void updateSmsInfo(Long smsId,
                   SmsSendStatusEnum smsSendStatusEnum)

更新短息发送状态

参数:

smsId - 短信记录id

smsSendStatusEnum - 发送状态枚举

validateSmsInfo

void validateSmsInfo(SysSmsVerifyParam sysSmsVerifyParam)

校验验证码是否正确

如果校验失败，或者短信超时，则会抛出异常

参数:

sysSmsVerifyParam - 短信校验参数

page

cn.stylefeng.roses.kernel.db.api.pojo.page.PageResult<SysSms> page(SysSmsInfoParam sysSmsInfoParam)

短信发送记录查询

参数:

sysSmsInfoParam - 查询参数

返回:

查询分页结果