SharePoint 2010增强后的通知功能

SharePoint 2010增强后的通知功能

 

Microsoft SharePoint Foundation 2010 扩展了通知（Alert）框架，现在用户可以以短信 (SMS)的 形式将订阅信息发送到移动设备上。下图为新的订阅命令在功能区中的位置：

添加订阅的页面：

短信部分的功能是通过新增的短信服务框架（Mobile Messaging Framework）实现的。为了支持SMS短信通知， Microsoft.SharePoint.SPAlert 类增加了一个名为DeliveryChannels的属性。该属性可以指示相应的通知是作为电子邮件(SPAlertDeliveryChannels.Email)还是作为短信(SPAlertDeliveryChannels.Sms)来进行发送。
短信息最终会通过Internet上的短信网关发送出去。您需要有一个短信服务提供商(MSP)为您指定的账户。服务器场管理员可以在 SharePoint 管理中心的配置移动账户页面中设置这些帐户信息。这样SMS通知功能才能启用。
配置移动账户在管理中心的位置：

移动账户设置：

通过编程的方式，我们也可以在Web应用程序的层次上对该帐户进行更改。

通过编程为一个Web应用程序指定MSP 账户
1、 调用SPMobileMessagingAccount()构造器，不需要指定SPMobileMessageServiceProvider参数。
2、 调用UpdateSmsAccount(SPMobileMessagingAccount)方法来进行指定。
下面的例子中webApp是一个SPWebApplication对象。需要注意的是，MSP提供的服务地址必须是“https”开头的，也就是必须是一个SSL URL。另外，UpdateSmsAccount(SPMobileMessagingAccount)方法的调用必须放在匿名委托RunWithElevatedPrivileages(SPSecurity.CodeToRunElevated)方法中。

代码

using Microsoft.SharePoint;
using System.Security;
…
SecureString password = new SecureString();
password.AppendChar('a');
password.AppendChar('Z');
password.AppendChar('3');
password.AppendChar('&');

SPMobileMessagingAccount account =
new SPMobileMessagingAccount("Contoso Messaging",
"https://contoso.com/services/mobilemessages",
"BobG",
password);
SPSecurity.RunWithElevatedPrivileges(delegate()
{
webApp.UpdateSmsAccount(account);
webApp.Update();
});

当指定完成后，以后我们就可以通过Web应用程序的OutboundSmsServiceAccount属性来引用该账户对象了。

代码

SPMobileMessagingAccount account = webApp.OutboundSmsServiceAccount;
if (account == null || !account.IsValidAccount())
{
throw new SPException("The account passed in is invalid.");
}
else
{
SPMobileMessageWebService messagingWebService = new SPMobileMessageWebService(account);
}

Mobile Messaging Framework提供了很强的可扩展性。我们完全可以在自己创建的 SharePoint 解决方案中利用它实现发送手机短信的功能。我们也可以根据需要创建完全自定义的通知系统。而且，如果我们的消息传递方案使用 Office Mobile Service(简称OMS) 协议的话，那么实际上大部分开发工作MS 都已经替我们完成了。现有SharePoint对象模型中包含了完整的类定义，来方便我们操作OMS协议的 Web Method调用以及返回的XML 响应的解析。

通过Office Mobile Service实现消息发送

OMS协议是对SMS和MMS消息结构协议的实现，用于手机消息通信。OMS依赖于Web Service和SOAP协议。SharePoint中使用了其中SMS的部分。Microsoft.SharePoint.MobileMessage命名空间下名称中有MMS的和所有MMS消息相关的内容只用于内部使用，无法在代码中调用。

新建一条短信
通过调用SPMobileMessageWebService对象的SendMessage(String)方法可以发送短信。但是，首先我们需要新建一条短信。有3种方式来新建：
1、 调用静态方法BuildSmsMessage(SPMobileMessagingAccount,String,String)。只需要传递一个发送者账户，一个接受者和消息内容即可。简单，但是灵活性很低。
2、 调用SetTextContent()的某个重载。首先需要构建一个SPMobileMessageSmsBuilder并通过AddResipient(String)方法来添加接收者。然后将消息从SetTextContent() 创建的SPMobileSmsMessage对象转化成用于OMS协议的XML消息。通过这种方式可以很方便的实现群发。这种方式还可以通过ContentParts设置分成几条来发送，以便满足MSP定制的单条字数限制。
3、 创建一个短信构建事务。该事务由以下3部分组成：
a) 调用一个StartTextMessage()
b) 调用一次或多次AddChunk(String)
c) 调用EndTextMessage()的某个重载
这种方式可以让我们调整短信的所有选项，是终极解决办法。具有最大的灵活性。我们可以自由控制消息如何分页，添加页码等等。当事务完成后，我们可以通过SPMobileMessageSmsBuilder的Message属性引用该短信对象。

不论使用哪种方法，只要是短信超过SP指定的字数限制，短信构建算法就会将其分成多条。分割点会定在文本“块”之间，而不是随意分割。所谓一块文本是指应该尽可能保证显示在一条短信中的文本。这样会使得用户收到的一系列的短信更容易理解。当然，如果某块文本本身就超过了最大字数限制，那它无论如何都会被分割。通过上面说的第3种方法，我们可以通过代码控制文本的分块。如下面的例子所示：

代码

SPMobileMessageSmsBuilder smsBuilder = new SPMobileMessageSmsBuilder(account);
smsBuilder.AddRecipient(mobile_telephone_number); //可以多次调用，以便添加多个接受者
// 开始短信构建事务
smsBuilder.StartTextMessage();
// 添加短信内容，根据需要分割成块
List<StringBuilder> messageParts = SplitLongMessage(message)
foreach (StringBuilder chunk in messageParts)
{
smsBuilder.AddChunk(chunk.ToString());
}
// 完成该事务
smsBuilder.EndTextMessage();
// 此时 smsBuilder.Message 属性可以返回一个 SPMobileSmsMessage 对象.

其中的SplitLongMessage方法实现了一个简单的算法，用于保证每个块的文本不超过SMS的133（单字节）个字符的限制。同时，它保证分割点总是在空格处，以保证不会将一个单词分开。当然，如果对于中文来说，我们需要实现更复杂的算法。

代码

public static List<StringBuilder> SplitLongMessage(String message)
{
// 通过空格分隔原始短信内容
String[] words = message.Split(null);
List<StringBuilder> chunks = new List<StringBuilder>();
StringBuilder latestChunk = new StringBuilder(132);
// 以不超过 133 个字符的方式重新组织内容
foreach (String word in words)
{
if (word.Length + latestChunk.Length <= 132) //这里不是 133 ，后面将加上一个空格
{
latestChunk.Append(word + " "); // 后面加上空格
}
else
{
// 将该块的副本添加到List
chunks.Add(new StringBuilder(latestChunk.ToString()));
// 清空最后一次输出的块，以便开始下一个
latestChunk.Remove(0, latestChunk.Length);
// 超过限制的那个单词会作为下一个块的第一个单词
latestChunk.Append(word + " ");
}
}
//添加最后面的短块
if (latestChunk.Length > 0)
{
chunks.Add(latestChunk);
}
return chunks;
}

不论是通过什么方式得到SPMobileSmsMessage对象的，最终我们要通过代码将其转换成OMS格式的XML消息。可以通过调用GetMessageXml() 来实现该转换。注意，如果我们是用的BuildSmsMessage的话，返回来的已经是XML消息了，无需进行转换。

String messageXml=smsBuilder.GetMessageXml();

发送一条消息
发送相当简单，只需要把上面得到的XML消息传给SPMobileMessageWebService对象的SendMessage方法就可以了。如下所示：

SPMobileMessageDeliveryReport report=messagingWebService.SendMessage(messageXml);

返回的结果报告中包含了短信是否发送成功，以及发送失败后的原因。我们可以根据需要对其进行进一步处理。

批量发送
如果我们需要批量发送， 那么首先需要在代码中将批量作业中产生的信息存储在队列数据结构如List(T)<SPMobileSmsMessage>中，方便统一发送。然后创建一个SPMobileMessageBatchPackage对象并将每条消息内容添加进包里。最后通过调用BatchSendMessage(SPMobileMessageBatchPackage)方法来进行发送。在这种情况下，我们不需要进行SPMobileSmsMessage的转换工作。包对象会通过Xml()返回一个整体的用于批量作业的XML，用于web service消息传输。

代码

SPMobileMessageBatchPackage package = new SPMobileMessageBatchPackage();
foreach (SPMobileSmsMessage message in messageCollection) //messageCollection是一个List(T)<SPMobileSmsMessage>对象
{
package.AddMessage(message);
}
List<SPMobileMessageDeliveryReport> reports = messagingWebService.BatchSendMessages(package);

同样我们也可以对返回的结果报告进行进一步的处理。

其他可能会用到的web service方法还有 GetUserInfo()和GetServiceInfo()，分别对应于OMS的 Web方法GetUserInfo和GetServiceInfo。

其他协议的开发
即使我们的解决方案使用的是其他的协议，也可以通过扩展该框架中的基类来简化设计开发工作。框架中的基类已为我们提供好了必要的属性和方法的默认实现。
需要注意的是，MS不支持直接从Microsoft.SharePoint.MobileMessage继承。对于非OMS的协议，我们可以考虑创建一个web service中间层来接收SharePoint传过来的OMS 协议消息，并进行转换，然后再通过相应的协议进行发送。

参考资料：
Building Block: Alerts

Overview of Mobile Messaging Development