ChangeSynergy::apiSubscriber
登録者リストにより、ユーザーは自分自身が CR の登録者であることを示すことができます。 ユーザーは CR への登録を依頼するとき、CR の変更時には通知してほしいと考えます。 このクラスでは、登録者リストの 1 人のユーザーに対する操作が可能です。
以下のメソッドを使用できます。
sub new(xmlData)
新しく作成される ChangeSynergy::apiSubscriber クラスを初期化して、渡される XML データを表すようにします。
my $subscriber = new ChangeSynergy::apiSubscriber(xmlData); パラメーター: xmlData - 構文解析して使用可能なフォームへ変換する必要がある XML データ。
スロー: die - XML データの構文解析ができない場合。
登録者リストから現在の登録者に削除マークを付けます。
注記: 削除マークを付けた登録者は、リストから直ちに削除されるわけではありません。登録者を削除するためには、CR を新しい XML 情報で更新する必要があります。 新しい XML で CR を更新する方法については、getSubscription() メソッドの apiObjectData クラスにある例を参照してください。
$subscriber->deleteSubscriber();
E メール・アドレス・プロパティーを取得します。
my $xmlData = $subscriber->getEmailAddress();
戻り値: スカラー このオブジェクトが表す登録者の E メール・アドレス。
実名プロパティーを取得します。
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 データ。デバッグに役立ちます。
登録者の E メール・アドレス・プロパティーを設定します。
$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 データ。