ChangeSynergy::apiSubscriber
预订列表将允许用户将自身标记为 CR 的订户。当用户请求成为 CR 的订户时,他们希望随时知悉 CR 更改。该类允许对预订列表的单个用户进行操作。
以下方法可用:
sub new(xmlData)
初始化新创建的 ChangeSynergy::apiSubscriber 类,以便使其表示传入的 xml 数据。
my $subscriber = new ChangeSynergy::apiSubscriber(xmlData); 参数: xmlData - 需要解析成可用格式的 XML 数据。
抛出: die - 如果不能解析 xml 数据
将当前订户标记为已从预订列表中删除。
注:该操作不会立即将订户从列表中除去。必须为 CR 更新 XML 信息后,该订户才会被除去。 请参阅 getSubscription() 方法下 apiObjectData 类的示例,以获取为 CR 更新 XML 的方法。
$subscriber->deleteSubscriber();
获取电子邮件地址属性。
my $xmlData = $subscriber->getEmailAddress();
返回:标量 此对象所表示的订户的电子邮件地址。
获取实名属性。
my $xmlData = $subscriber->getRealName();
返回:标量 此对象所表示的订户的实名。
获取订户对象的当前状态。可以是以下的任何一个值:globals->{UNCHANGED}、globals->{DELETED}、globals->{ADDED} 或 globals->{MODIFIED}。 此信息主要用于更新服务器的 XML 构造。
my $xmlData = $subscriber->getXmlData();
返回:标量 订户的状态。
获取用户名属性。
my $xmlData = $subscriber->getUserName();
返回:标量 此对象所表示的订户的用户名。
获取构造 apiSubscriber 对象所用的 XML 数据。
注意:仅适用于调试。
my $xmlData = $subscriber->getXmlData();
返回:标量 用于构造此对象的 XML 数据,非常适用于调试。
设置订户的电子邮件地址属性。
$subscriber->setEmailAddress("John.Smith@company.com");
设置订户的实名属性。
$subscriber->setRealName("John Smith");
设置订户的用户名属性。
$subscriber->setUserName("jsmith");
获取发送给 IBM Rational Change 服务器以更新预订列表的 XML 数据。 当调用 ChangeSynergy::apiSubscription 对象的 toSubmitXml 方法时,调用此方法。
my $xmlData = $subscriber->toSubmitXml();
返回:标量 发送到 IBM Rational Change 服务器的 XML 数据。