docs: 完善通知模板文档
This commit is contained in:
parent
e8c4f1594e
commit
2a9d07e35e
@ -1,9 +1,12 @@
|
|||||||
package com.cicdi.notify.template;
|
package com.cicdi.notify.template;
|
||||||
|
|
||||||
|
import com.cicdi.notify.NotifierProvider;
|
||||||
|
|
||||||
import java.io.Serializable;
|
import java.io.Serializable;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 通知模板
|
* 通知模板
|
||||||
|
* <p>不同的服务商{@link TemplateProvider},{@link NotifierProvider}需要实现对应的模板</p>
|
||||||
*
|
*
|
||||||
* @author xueye
|
* @author xueye
|
||||||
*/
|
*/
|
||||||
|
@ -1,26 +1,33 @@
|
|||||||
package com.cicdi.notify.template;
|
package com.cicdi.notify.template;
|
||||||
|
|
||||||
|
import com.cicdi.notify.NotifierProvider;
|
||||||
|
import com.cicdi.notify.NotifyType;
|
||||||
|
|
||||||
import java.io.Serializable;
|
import java.io.Serializable;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 模板属性
|
* 通知模板配置属性
|
||||||
*
|
*
|
||||||
* @author xueye
|
* @author xueye
|
||||||
*/
|
*/
|
||||||
public class TemplateProperties implements Serializable {
|
public class TemplateProperties implements Serializable {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 模板类型
|
* 通知模板类型
|
||||||
|
*
|
||||||
|
* @see NotifyType
|
||||||
*/
|
*/
|
||||||
private String type;
|
private String type;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 模板提供商
|
* 通知模板服务商
|
||||||
|
*
|
||||||
|
* @see NotifierProvider
|
||||||
*/
|
*/
|
||||||
private String provider;
|
private String provider;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 模板
|
* 通知模板的JSON字符串
|
||||||
*/
|
*/
|
||||||
private String template;
|
private String template;
|
||||||
|
|
||||||
@ -47,4 +54,5 @@ public class TemplateProperties implements Serializable {
|
|||||||
public void setTemplate(String template) {
|
public void setTemplate(String template) {
|
||||||
this.template = template;
|
this.template = template;
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -1,29 +1,38 @@
|
|||||||
package com.cicdi.notify.template;
|
package com.cicdi.notify.template;
|
||||||
|
|
||||||
|
import com.cicdi.notify.DefaultNotifyType;
|
||||||
import com.cicdi.notify.NotifyType;
|
import com.cicdi.notify.NotifyType;
|
||||||
import com.cicdi.notify.Provider;
|
import com.cicdi.notify.Provider;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 模板提供商
|
* 通知模板服务商
|
||||||
|
* <p>模板服务商用于生成对应服务商支持的通知模板</p>
|
||||||
*
|
*
|
||||||
* @author xueye
|
* @author xueye
|
||||||
|
* @see Template
|
||||||
*/
|
*/
|
||||||
public interface TemplateProvider {
|
public interface TemplateProvider {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return 通知类型
|
* @return 通知类型
|
||||||
* @see NotifyType
|
* @see NotifyType
|
||||||
|
* @see DefaultNotifyType
|
||||||
*/
|
*/
|
||||||
NotifyType getType();
|
NotifyType getType();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return 通知提供商
|
* 获取模板的服务商
|
||||||
|
*
|
||||||
|
* @return 模板服务商
|
||||||
*/
|
*/
|
||||||
Provider getProvider();
|
Provider getProvider();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param properties 模板属性
|
* 根据通知模板配置属性生成通知模板
|
||||||
* @return 模板
|
*
|
||||||
|
* @param properties 通知模板配置属性
|
||||||
|
* @return 通知模板
|
||||||
*/
|
*/
|
||||||
Template createTemplate(TemplateProperties properties);
|
Template createTemplate(TemplateProperties properties);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user