Class Info |
|---|
public final class Channel extends GenericJson 资源变更通知通道数据模型类。 |
Qualifier and Type |
Method Name and Description |
|---|---|
clone() 克隆一个Channel类对象。 |
|
Long |
获取通知通道到期的日期和时间。 |
String |
getUrl() 获取接收通道通知的业务服务器地址。 |
String |
getId() 获取一个唯一的ID,标识这个订阅通道。 |
String |
获取资源类型,固定值为api#channel。 |
Map<String, String> |
获取控制下发信道行为的附加参数。 |
Boolean |
获取是否需要信道的有效载荷。 |
String |
获取资源ID,标识通道上接收通知的资源。 |
String |
获取资源版本标识符。 |
String |
getType() 获取发送机制类型,当前固定值web_hook。 |
String |
获取任意字符串,携带回传给url。 |
set(String fieldName, Object value) 设置自定义属性及属性值。 |
|
setCategory(String category) 设置资源类型,固定值为api#channel。 |
|
setExpirationTime(Long expirationTime) 设置通知通道到期的日期和时间。 |
|
setId(String id) 设置一个唯一的ID,标识这个订阅通道。 |
|
setParams(Map<String, String> params) 设置控制下发信道行为的附加参数。 |
|
setPayload(Boolean payload) 设置是否需要信道的有效载荷。 |
|
setResourceId(String resourceId) 设置资源ID,标识通道上接收通知的资源。 |
|
setResourceUri(String resourceUri) 设置资源版本标识符。 |
|
setType(String type) 设置发送机制类型,当前固定值web_hook。 |
|
setUrl(String url) 设置接收通道通知的业务服务器地址。 |
|
setUserToken(String userToken) 设置任意字符串,携带回传给url。 |
Method |
|---|
public String getUrl() 获取接收通道通知的业务服务器地址。 |
Returns
Type |
Description |
|---|---|
String |
返回接收通道通知的业务服务器地址。 |
Method |
|---|
public Channel setUrl(String url) 设置接收通道通知的业务服务器地址。 |
Parameters
Name |
Description |
|---|---|
url |
接收通道通知的业务服务器地址,必须为HTTPS地址,格式为https://…… 。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public String getId() 获取一个唯一的ID,标识这个订阅通道。 |
Returns
Type |
Description |
|---|---|
String |
唯一的ID,标识这个订阅通道。 |
Method |
|---|
public Channel setId(String id) 设置一个唯一的ID,标识这个订阅通道。 |
Parameters
Name |
Description |
|---|---|
id |
唯一的ID,标识这个订阅通道。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public String getCategory() 获取资源类型,固定值为api#channel。 |
Returns
Type |
Description |
|---|---|
String |
资源类型,固定值为api#channel。 |
Method |
|---|
public Channel setCategory(String category) 设置资源类型,固定值为api#channel。 |
Parameters
Name |
Description |
|---|---|
category |
资源类型,固定值为api#channel。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public String getResourceId() 获取资源ID,标识通道上接收通知的资源。 |
Returns
Type |
Description |
|---|---|
String |
资源ID,标识通道上接收通知的资源。 |
Method |
|---|
public Channel setResourceId(String resourceId) 设置资源ID,标识通道上接收通知的资源。 |
Parameters
Name |
Description |
|---|---|
resourceId |
资源ID,标识通道上接收通知的资源(响应结果必选)。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public String getResourceUri() 获取资源版本标识符。 |
Returns
Type |
Description |
|---|---|
String |
资源版本标识符。 |
Method |
|---|
public Channel setResourceUri(String resourceUri) 设置资源版本标识符。 |
Parameters
Name |
Description |
|---|---|
resourceUri |
资源版本标识符(响应结果必选)。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public String getUserToken() 获取任意字符串,携带回传给url。 |
Returns
Type |
Description |
|---|---|
String |
任意字符串,携带回传给url。 |
Method |
|---|
public Channel setUserToken(String userToken) 设置任意字符串,携带回传给url。 |
Parameters
Name |
Description |
|---|---|
userToken |
任意字符串。发送消息回调通知时,回传给业务,可选参数,如业务方接收的回调通知中需要携带userToken信息,可设置该参数,格式要求:使用数字或字母(大小写均可),长度<=64。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public String getType() 发送机制类型,当前固定值web_hook,表示通过web类型进行回调通知。 |
Returns
Type |
Description |
|---|---|
String |
发送机制类型,当前固定值web_hook,表示通过web类型进行回调通知。 |
Method |
|---|
public Channel setType(String type) 设置发送机制类型,当前固定值web_hook,表示通过web类型进行回调通知。 |
Parameters
Name |
Description |
|---|---|
type |
发送机制类型,当前固定值web_hook,表示通过web类型进行回调通知。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public Long getExpirationTime() 获取通知通道到期的日期和时间,以Unix时间戳表示,以毫秒为单位,File资源最长1天,Change资源最长一周。 |
Returns
Type |
Description |
|---|---|
Long |
通知通道到期的日期和时间。 |
Method |
|---|
public Channel setExpirationTime(Long expirationTime) 设置通知通道到期的日期和时间。 |
Parameters
Name |
Description |
|---|---|
expirationTime |
通知通道到期的日期和时间,以Unix时间戳表示,以毫秒为单位,File资源最长1天,Change资源最长一周。不传的话,Change资源默认有效期1小时。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public Map<String, String> getParams() 获取控制下发信道行为的附加参数。 |
Returns
Type |
Description |
|---|---|
Map<String, String> |
控制下发信道行为的附加参数。 |
Method |
|---|
public Channel setParams(Map<String, String> params) 设置控制下发信道行为的附加参数。 |
Parameters
Name |
Description |
|---|---|
params |
控制下发信道行为的附加参数。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |
Method |
|---|
public Boolean getPayload() 获取是否需要信道的有效载荷。 |
Returns
Type |
Description |
|---|---|
Boolean |
是否需要信道的有效载荷。 |
Method |
|---|
public Channel setPayload(Boolean payload) 设置是否需要信道的有效载荷。 |
Parameters
Name |
Description |
|---|---|
payload |
是否需要信道的有效载荷。 true:需要;false:无需。 |
Returns
Type |
Description |
|---|---|
Channel |
返回一个Channel对象。 |