C# Class cn.jpush.api.JPushClient

Main Entrance - 该类为JPush服务的主要入口
Show file Open project: jpush/jpush-api-csharp-client Class Usage Examples

Public Methods

Method Description
JPushClient ( String app_key, String masterSecret ) : System

带两个参数的构造函数，该状态下，ApnsProduction默认为false
SendPush ( PushPayload payload ) : MessageResult

向某个设备或者某设别列表推送一条通知，或者消息
SendPush ( string payloadString ) : MessageResult

向某个设备或者某设别列表推送一条通知，或者消息
addRemoveDevicesFromTag ( String theTag, HashSet toAddUsers, HashSet toRemoveUsers ) : cn.jpush.api.common.resp.DefaultResult

为一个标签添加或者删除设备
deleteAlias ( String alias, String platform ) : cn.jpush.api.common.resp.DefaultResult

删除别名，以及该别名与设别之间的绑定关系
deleteTag ( String theTag, String platform ) : cn.jpush.api.common.resp.DefaultResult

删除一个标签，以及标签与设备之间的关联关系
getAliasDeviceList ( String alias, String platform ) : cn.jpush.api.device.AliasDeviceListResult

查询别名
getDeviceTagAlias ( String registrationId ) : cn.jpush.api.device.TagAliasResult

获取当前设备的所有属性，包含tags,alias
getReceivedApi ( String msg_ids ) : cn.jpush.api.report.ReceivedResult

Get received report.
getReceivedApi_v3 ( String msg_ids ) : cn.jpush.api.report.ReceivedResult

Get received report v3.
getReportMessages ( ) : MessagesResult

消息统计查询接口，这个接口是vip用户专用
getReportUsers ( TimeUnit timeUnit, String start, int duration ) : cn.jpush.api.report.UsersResult

用户统计查询接口，这个接口是vip用户专用
getTagList ( ) : cn.jpush.api.device.TagListResult

获取当前应用的所有标签
isDeviceInTag ( String theTag, String registrationID ) : cn.jpush.api.common.resp.BooleanResult

查询某个设备是否在tag下
updateDeviceTagAlias ( String registrationId, String alias, String mobile, HashSet tagsToAdd, HashSet tagsToRemove ) : cn.jpush.api.common.resp.DefaultResult

更新当前设备指定的属性，当前支持tags,alias
updateDeviceTagAlias ( String registrationId, bool clearAlias, bool clearTag ) : cn.jpush.api.common.resp.DefaultResult

清理当前设备指定的属性，当前支持tags,alias

Method Details

JPushClient() public method

带两个参数的构造函数，该状态下，ApnsProduction默认为false
public JPushClient ( String app_key, String masterSecret ) : System
app_key String Portal上产生的app_key
masterSecret String 你的API MasterSecret
return System

SendPush() public method

向某个设备或者某设别列表推送一条通知，或者消息
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public SendPush ( PushPayload payload ) : MessageResult
payload cn.jpush.api.push.mode.PushPayload
return cn.jpush.api.push.MessageResult

SendPush() public method

向某个设备或者某设别列表推送一条通知，或者消息
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public SendPush ( string payloadString ) : MessageResult
payloadString string
return cn.jpush.api.push.MessageResult

addRemoveDevicesFromTag() public method

为一个标签添加或者删除设备
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public addRemoveDevicesFromTag ( String theTag, HashSet toAddUsers, HashSet toRemoveUsers ) : cn.jpush.api.common.resp.DefaultResult
theTag String 操作的tag
toAddUsers HashSet 需要添加的registrationID的集合
toRemoveUsers HashSet 需要删除的registrationID的集合
return cn.jpush.api.common.resp.DefaultResult

deleteAlias() public method

删除别名，以及该别名与设别之间的绑定关系
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public deleteAlias ( String alias, String platform ) : cn.jpush.api.common.resp.DefaultResult
alias String 要删除的别名
platform String 可选参数，不填则默认为所有平台
return cn.jpush.api.common.resp.DefaultResult

deleteTag() public method

删除一个标签，以及标签与设备之间的关联关系
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public deleteTag ( String theTag, String platform ) : cn.jpush.api.common.resp.DefaultResult
theTag String 要删除的tag
platform String 可选参数，不填则默认为所有平台
return cn.jpush.api.common.resp.DefaultResult

getAliasDeviceList() public method

查询别名
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public getAliasDeviceList ( String alias, String platform ) : cn.jpush.api.device.AliasDeviceListResult
alias String 要查询的别名
platform String 可选参数，不填则默认为所有平台
return cn.jpush.api.device.AliasDeviceListResult

getDeviceTagAlias() public method

获取当前设备的所有属性，包含tags,alias
public getDeviceTagAlias ( String registrationId ) : cn.jpush.api.device.TagAliasResult
registrationId String 设备的registrationID
return cn.jpush.api.device.TagAliasResult

getReceivedApi() public method

Get received report.
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public getReceivedApi ( String msg_ids ) : cn.jpush.api.report.ReceivedResult
msg_ids String
return cn.jpush.api.report.ReceivedResult

getReceivedApi_v3() public method

Get received report v3.
public getReceivedApi_v3 ( String msg_ids ) : cn.jpush.api.report.ReceivedResult
msg_ids String
return cn.jpush.api.report.ReceivedResult

getReportMessages() public method

消息统计查询接口，这个接口是vip用户专用
public getReportMessages ( ) : MessagesResult
return cn.jpush.api.report.MessagesResult

getReportUsers() public method

用户统计查询接口，这个接口是vip用户专用
public getReportUsers ( TimeUnit timeUnit, String start, int duration ) : cn.jpush.api.report.UsersResult
timeUnit TimeUnit 时间单位，有三个取值:HOUR、DAY、MONTH
start String 起始时间
duration int 持续时间
return cn.jpush.api.report.UsersResult

getTagList() public method

获取当前应用的所有标签
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public getTagList ( ) : cn.jpush.api.device.TagListResult
return cn.jpush.api.device.TagListResult

isDeviceInTag() public method

查询某个设备是否在tag下
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public isDeviceInTag ( String theTag, String registrationID ) : cn.jpush.api.common.resp.BooleanResult
theTag String 查询的tag
registrationID String 需要确认的设备的registrationID
return cn.jpush.api.common.resp.BooleanResult

updateDeviceTagAlias() public method

更新当前设备指定的属性，当前支持tags,alias
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public updateDeviceTagAlias ( String registrationId, String alias, String mobile, HashSet tagsToAdd, HashSet tagsToRemove ) : cn.jpush.api.common.resp.DefaultResult
registrationId String
alias String alias名称，传递null:不改变，传递""：清空
mobile String
tagsToAdd HashSet 新添加的tags
tagsToRemove HashSet 删除的tags
return cn.jpush.api.common.resp.DefaultResult

updateDeviceTagAlias() public method

清理当前设备指定的属性，当前支持tags,alias
包含http错误码：如401,404等，错误信息，JPush returen code和JPush returen mssage 包含错误的信息
public updateDeviceTagAlias ( String registrationId, bool clearAlias, bool clearTag ) : cn.jpush.api.common.resp.DefaultResult
registrationId String
clearAlias bool 是否清除alias
clearTag bool 是否清除tags
return cn.jpush.api.common.resp.DefaultResult