AM Daemon ライブラリリファレンス
公開メンバ関数 | 静的公開メンバ関数 | 全メンバ一覧
amdaemon::allnet::Auth クラス

ALL.Net認証情報を提供するMonostateクラス。 [詳解]

#include <Auth.h>

公開メンバ関数

bool isAvailable () const
 ALL.Net認証機能を利用可能であるか否かを取得する。 [詳解]
 
bool isGood () const
 認証が成功済みであるか否かを取得する。 [詳解]
 
bool isDevelop () const
 開発店舗であるか否かを取得する。 [詳解]
 
LineType getLineType () const
 回線種別を取得する。 [詳解]
 
const wchar_t * getGameServerUri () const
 認証レスポンスのゲームサーバURIを取得する。 [詳解]
 
const wchar_t * getGameServerHost () const
 認証レスポンスのゲームサーバホスト名を取得する。 [詳解]
 
std::uint32_t getLocationId () const
 認証レスポンスの店舗IDを取得する。 [詳解]
 
const wchar_t * getLocationName () const
 認証レスポンスの店舗名を取得する。 [詳解]
 
const wchar_t * getLocationNickname (std::size_t partIndex) const
 認証レスポンスの店舗ニックネームを取得する。 [詳解]
 
std::int32_t getRegionCode () const
 認証レスポンスの地域コードを取得する。 [詳解]
 
const wchar_t * getRegionName (std::size_t partIndex) const
 認証レスポンスの地域名を取得する。 [詳解]
 
const wchar_t * getCountryCode () const
 認証レスポンスの国コードを取得する。 [詳解]
 

静的公開メンバ関数

static std::size_t getLocationNicknamePartCount ()
 店舗ニックネームのパート数を取得する。 [詳解]
 
static std::size_t getRegionNamePartCount ()
 地域名のパート数を取得する。 [詳解]
 

詳解

ALL.Net認証情報を提供するMonostateクラス。

Core クラスのメンバ関数 Core::execute 呼び出しによって内容が更新される。

取得した認証レスポンスを画面表示する際は、 ALL.Net Programmer's Manual の「ゲーム画面に表示する際の注意事項」を確認すること。

関数詳解

static std::size_t amdaemon::allnet::Auth::getLocationNicknamePartCount ( )
static

店舗ニックネームのパート数を取得する。

戻り値
店舗ニックネームのパート数。固定値 2 。
static std::size_t amdaemon::allnet::Auth::getRegionNamePartCount ( )
static

地域名のパート数を取得する。

戻り値
地域名のパート数。固定値 4 。
bool amdaemon::allnet::Auth::isAvailable ( ) const

ALL.Net認証機能を利用可能であるか否かを取得する。

戻り値
true利用可能である場合。
false機能が無効である場合。

Daemonプロセスの設定ファイルでALL.Net認証設定を有効にしている場合であっても、 キーチップのALL.Net認証フラグが無効である場合は false を返す。

bool amdaemon::allnet::Auth::isGood ( ) const

認証が成功済みであるか否かを取得する。

戻り値
true成功済みである場合。
false未成功である場合。未試行の場合や認証機能が無効である場合も含む。
bool amdaemon::allnet::Auth::isDevelop ( ) const

開発店舗であるか否かを取得する。

戻り値
true開発店舗である場合。
false開発店舗ではないか、認証未成功の場合。

認証が成功済みであれば有効な値を返す。

ALL.Net ID を用いて判定を行っている。 ALL.Net委員会の方針上、 ALL.Net ID は返さないため、 ロケーションの判定には店舗IDを用いること。

LineType amdaemon::allnet::Auth::getLineType ( ) const

回線種別を取得する。

戻り値
回線種別。
参照
isGood

認証が成功済みであれば有効な値を返す。

const wchar_t* amdaemon::allnet::Auth::getGameServerUri ( ) const

認証レスポンスのゲームサーバURIを取得する。

戻り値
ゲームサーバURI。認証未成功の場合は不定値。
参照
isGood

認証が成功済みであれば有効な値を返す。

const wchar_t* amdaemon::allnet::Auth::getGameServerHost ( ) const

認証レスポンスのゲームサーバホスト名を取得する。

戻り値
ゲームサーバホスト名。認証未成功の場合は不定値。
参照
isGood

認証が成功済みであれば有効な値を返す。

std::uint32_t amdaemon::allnet::Auth::getLocationId ( ) const

認証レスポンスの店舗IDを取得する。

戻り値
店舗ID。認証未成功の場合は不定値。
参照
isGood

認証が成功済みであれば有効な値を返す。

const wchar_t* amdaemon::allnet::Auth::getLocationName ( ) const

認証レスポンスの店舗名を取得する。

戻り値
店舗名。認証未成功の場合は不定値。
参照
isGood

認証が成功済みであれば有効な値を返す。

const wchar_t* amdaemon::allnet::Auth::getLocationNickname ( std::size_t  partIndex) const

認証レスポンスの店舗ニックネームを取得する。

引数
[in]partIndexパートインデックス。 0 以上パート数未満。
戻り値
店舗ニックネーム。認証未成功の場合は不定値。
参照
isGood
例外
Exception引数 partIndex にパート数以上の値を指定した場合。 パート数は静的メンバ関数 getLocationNicknamePartCount で取得できる。

認証が成功済みであれば有効な値を返す。

画面表示の際は、2行で表示するか、連結して1行で表示すること。 連結する場合、間に文字を挟んではならない。(半角スペース等も不可)

std::int32_t amdaemon::allnet::Auth::getRegionCode ( ) const

認証レスポンスの地域コードを取得する。

戻り値
地域コード。認証未成功の場合は不定値。
参照
isGood

認証が成功済みであれば有効な値を返す。

const wchar_t* amdaemon::allnet::Auth::getRegionName ( std::size_t  partIndex) const

認証レスポンスの地域名を取得する。

引数
[in]partIndexパートインデックス。 0 以上パート数未満。
戻り値
地域名。認証未成功の場合は不定値。
参照
isGood
例外
Exception引数 partIndex にパート数以上の値を指定した場合。 パート数は静的メンバ関数 getRegionNamePartCount で取得できる。

認証が成功済みであれば有効な値を返す。

const wchar_t* amdaemon::allnet::Auth::getCountryCode ( ) const

認証レスポンスの国コードを取得する。

戻り値
国コード。認証未成功の場合は不定値。
参照
isGood

認証が成功済みであれば有効な値を返す。


このクラス詳解は次のファイルから抽出されました: