短消息接口函数_c语言函数接口定义

uc_pm_location(integer uid , bool newpm)

函数参数

本接口函数运行后会发送一个 header 的 location 请求，使当前页面跳转到短消息中心。所以请不要在这个函数运行前后有任何的输出性的代码。如果 newpm 为 1 则进入短消息中心后，会默认打开新件箱。

进入短消息中心示例 (PHP)

bool/array uc_pm_checknew(integer uid [, bool more])

函数参数

返回值 (当 more = 0 时)

返回值 (当 more = 1 时)

返回值 (当 more = 2 时)

返回值 (当 more = 3 时)

本接口函数会检查指定用户是否有新的短消息。

检查新短消息示例 (PHP)

integer uc_pm_send(integer fromuid , string msgto , string subject , string message [, bool instantly , integer replypmid , bool isusername])

函数参数

返回值

本接口函数用于发送短消息。当 instantly 为 1 时，短消息会直接发送出去，否则本函数会发送一个 header 的 location 请求，使当前页面跳转到短消息中心的发送短消息页面。因此，当 instantly 为 0 时请不要在这个函数运行前后有任何的输出性的代码。fromuid 为 0 时为发送系统消息。msgto 默认为用户 ID，如果要让用户名作为参数，可让 isusername 为 1。replypid 为 0 表示发送的短消息为短消息话题的发起者，如果 replypid 为指定的消息 ID 则表示发送的短消息为回复指定短消息话题的回复信息。如果 instantly 为 1，那么发送成功后函数返回发送成功的最后一条消息 ID，返回 0 表示发送失败。

发送短消息示例 (PHP)

integer uc_pm_delete(integer uid , string folder , array pmids)

函数参数

返回值

本接口函数将删除指定文件夹中的指定消息 ID 的短消息。pmids 参数是一个自由 Key 数组类型，如“ array(1, 2, 3, 4, 5 …) ”，数组的每一个值均为消息 ID。删除的每一条短消息 UCenter 会进行对方删除状态的检测，如果短消息对方也是删除状态，那么当前消息将在数据库中删除，否则只记录一个删除标记。

删除短消息示例 (PHP)

integer uc_pm_deleteuser(integer uid , array touids)

函数参数

返回值

本接口函数将删除和 uid 对话的 touids 中的所有短消息。

uc_pm_readstatus(integer uid , array uids [, array pmids, bool status])

函数参数

本接口函数用于标记短消息的已读/未读状态。uids 和 pmids 参数是一个自由 Key 数组类型，如“ array(1, 2, 3, 4, 5 …) ”，数组的每一个值均为 ID。

标记短消息状态示例 (PHP)

array uc_pm_list(integer uid [, integer page , integer pagesize , string folder , string filter, integer msglen])

函数参数

返回值

本接口函数用于获取指定文件夹的短消息列表。函数已内置分页，直接通过 page 和 pagesize 即可实现翻页。

uc_pm_ignore(integer uid)

函数参数

本接口函数用于直接忽略未读短消息的提示状态。

array uc_pm_view(integer uid , integer pmid [, integer touid , integer daterange])

函数参数

返回值

本接口函数用于返回指定用户的指定消息 ID 的消息，返回的数据中包含针对这个消息的回复。如果指定 touid 参数，那么短消息将列出所有 uid 和 touid 之间的短消息，daterange 可以指定返回消息的日期范围。

integer uc_pm_viewnode(integer uid [, integer type , integer pmid])

函数参数

返回值

如果 type 为 0，则本接口函数返回指定 pmid 的单条消息内容。如果 type 为 1 或 2，则本接口函数返回指定用户接收的最后单条消息内容。

string uc_pm_blackls_get(integer uid)

函数参数

返回值

本接口函数返回用户的黑名单设置的内容。

获取黑名单示例 (PHP)

bool uc_pm_blackls_set(integer uid , string blackls)

函数参数

返回值

本接口函数用于更新用户的黑名单列表数据。设置黑名单后，黑名单中的人员将无法发送短消息给 uid 指定的用户。黑名单中被忽略的人员用用户名表示，多个忽略人员名单时用逗号 “,” 隔开(如:张三,李四,王五)，如需禁止所有用户发来的短消息，请用 “{ALL}” 表示。

更新黑名单示例 (PHP)

bool uc_pm_blackls_add(integer uid , array username)

函数参数

返回值

本接口函数用于添加用户的黑名单项目。如需添加屏蔽所有用户的设置，请让 username 数组中包含 “{ALL}”

添加黑名单项目示例 (PHP)

uc_pm_blackls_delete(integer uid , array username)

函数参数

本接口函数用于删除用户的黑名单项目。如需删除屏蔽所有用户的设置，请让 username 数组中包含 “{ALL}”

添加黑名单项目示例 (PHP)