nsILoginInfo

出典: MDC

nsILoginInfoはFirefox 3のログインマネージャにて格納されるログインのための情報を保持するオブジェクトです。

ログインを作成し、管理するにはnsILoginManagerを使用する必要があります。Using nsILoginManagerの例をご覧ください。

目次 1 メソッドの概要 2 属性 3 メソッド 3.1 init() 3.1.1 引数 3.2 equals() 3.2.1 引数 3.2.2 戻り値 3.3 matches() 3.3.1 引数 3.3.2 戻り値 4 参照 5 See also

nsILoginInfo は toolkit/components/passwordmgr/public/nsILoginInfo.idl で定義されています。これは scriptable で 非凍結です。 (Mozilla 1.9から更新されていません)

Inherits from: nsISupports

Implemented by: @mozilla.org/login-manager/loginInfo;1. インスタンスを作成するためには次の例を使用してください。

var myLoginInfo = Components.classes["@mozilla.org/login-manager/loginInfo;1"]
                   .createInstance(Components.interfaces.nsILoginInfo);

[編集] メソッドの概要

void init(in AString aHostname, in AString aFormSubmitURL, in AString aHttpRealm, in AString aUsername, in AString aPassword, in AString aUsernameField, in AString aPasswordField);

boolean equals(in nsILoginInfo aLoginInfo);

boolean equalsIgnorePassword(in nsILoginInfo aLoginInfo);

[編集] 属性

属性	型	記述
hostname	AString	ログインが実行されるホストの名前。URLとしてフォーマットされます。（例として、"http://www.wite.com")。ポート番号(":123")が追加されることもあるでしょう。
formSubmitURL	AString	フォームベースのログインがサブミットされるURL。HTMLフォームから獲得されるログイン向けにはこのフィールドはform要素のaction属性になり、パスは削除されます（例として、"http://www.site.com"）。action属性のないフォームはデフォルトとしてフォームの元のURLにサブミットされます。そのためにそれはここに格納されます。このフィールドはログインがプロトコル認証から得られた場合にはNULLです。
httpRealm	AString	ログインが要求されたHTTP Realm。HTTPサーバが401の結果を返した時、WWW-Authenticateヘッダは"保護空間"を特定するRealmを含みます。RFC 2617を参照してください。結果に realm が含まれていなかった場合、あるいは空白だった場合は、代わりにホスト名が使われます。HTMLフォームから獲得されたログインに関してはこのフィールドはNULLです。
username	AString	ログインのユーザ名
usernameField	AString	フォーム内のユーザ名入力フィールドのname属性。フォームを利用しないログインでは、空白の文字列 ("") を指定する必要があります。
password	AString	ログインのパスワード。
passwordField	AString	パスワード入力フィールドのname属性。プロトコル認証から獲得されたログインではこのフィールドはNULLになります。

[編集] メソッド

[編集] init()

新しく作成されたnsILoginInfoオブジェクトを初期化します。

 void init(in AString aHostname,
   in AString aFormSubmitURL,
   in AString aHttpRealm,
   in AString aUsername,
   in AString aPassword,
   in AString aUsernameField,
   in AString aPasswordField
 );

[編集] 引数

aHostname

hostnameフィールドに割り当てられる値

aFormSubmitURL

formSubmitURLフィールドに割り当てられる値

aHttpRealm

httpRealmフィールドに割り当てられる値

aUsername

usernameフィールドに割り当てられる値

aPassword

passwordフィールドに割り当てられる値

aUsernameField

usernameFieldフィールドに割り当てられる値

aPasswordField

passwordFieldフィールドに割り当てられる値

[編集] equals()

このログインが別のnsILoginInfoオブジェクトと完全に等しいかどうか確定する

 boolean equals(
   in nsILoginInfo aLoginInfo
 );

[編集] 引数

aLoginInfo

等しさを比較するログイン

[編集] 戻り値

もし二つのログインが完全に等しければtrue、そうでなければfalse。

[編集] matches()

このログインが他の nsILoginInfo オブジェクトとほぼ等しいかどうかを判別するテストを行います。passwordField と usernameField の値は無視され、password の値も任意で無視できます。このログインの formSubmitURL が空白の文字列である (かつ null でない) 場合は、ワイルドカードと同等に扱われます。

 boolean matches(
   in nsILoginInfo aLoginInfo,
   in boolean      ignorePassword
 );

[編集] 引数

aLoginInfo

等しさを比較するログイン

ignorePassword

true の場合、判別時にパスワードの値を検査しません。

[編集] 戻り値

2つのログインが同等ならばtrue、等しくなければfalse。

[編集] 参照

[編集] See also

nsILoginManager, Using nsILoginManager