com.taotao.boot.sms.common.repository.VerificationCodeRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of taotao-boot-starter-sms-common Show documentation

taotao-boot-starter-sms-common

The newest version!

/*
 * Copyright (c) 2020-2030, Shuigedeng ([email protected] & https://blog.taotaocloud.top/).
 *
 * 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
 *
 *      https://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.
 */

package com.taotao.boot.sms.common.repository;

import com.taotao.boot.sms.common.model.VerificationCode;
import org.springframework.lang.Nullable;

/**
 * 验证码储存接口
 *
 * @author shuigedeng
 * @version 2022.04
 * @since 2022-04-27 17:49:20
 */
public interface VerificationCodeRepository {

    /**
     * 根据手机号码查询验证码
     *
     * @param phone 手机号码
     * @param identificationCode 识别码
     * @return {@link VerificationCode }
     * @since 2022-04-27 17:49:20
     */
    @Nullable
    VerificationCode findOne(String phone, @Nullable String identificationCode);

    /**
     * 保存验证码
     *
     * @param verificationCode 验证码
     * @since 2022-04-27 17:49:20
     */
    void save(VerificationCode verificationCode);

    /**
     * 删除验证码
     *
     * @param phone 手机号码
     * @param identificationCode 识别码
     * @since 2022-04-27 17:49:20
     */
    void delete(String phone, @Nullable String identificationCode);
}