com.gitlab.summercattle.addons.wechat.miniprogram.service.MiniProgramService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cattle-addons-wechat-starter Show documentation

Cattle Framework Addons WeChat Component

The newest version!

/*
 * Copyright (C) 2018 the original author or authors.
 *
 * 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
 *
 *      http://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.gitlab.summercattle.addons.wechat.miniprogram.service;

import java.util.List;
import java.util.Map;

import com.gitlab.summercattle.addons.wechat.common.MiniProgramUserSession;
import com.gitlab.summercattle.commons.exception.CommonException;

/**
 * 微信小程序服务
 * @author orange
 *
 */
public interface MiniProgramService {

	/**
	 * 得到会话
	 * @param source 来源
	 * @param jsCode 登录时获取的code
	 * @return 小程序会话
	 * @throws CommonException 异常
	 */
	MiniProgramUserSession getSession(String source, String jsCode) throws CommonException;

	/**
	 * 绑定
	 * @param source 来源
	 * @param sessionId 临时会话Id
	 * @param code 手机号获取凭证
	 * @param parameters 参数
	 * @throws CommonException 异常
	 */
	void bind(String source, String sessionId, String code, Map parameters) throws CommonException;

	/**
	 * 得到用户加密要素信息
	 * @param source 来源
	 * @param sessionId 会话Id
	 * @return 用户加密要素信息
	 * @throws CommonException 异常
	 */
	List getUserEncryptKeys(String source, String sessionId) throws CommonException;

	/**
	 * 检查小程序Session Key是否有效
	 * @param source 来源
	 * @param sessionId 会话Id
	 * @return 小程序Session Key是否有效
	 * @throws CommonException 异常
	 */
	boolean checkSessionKey(String source, String sessionId) throws CommonException;
}