電子マネー処理を提供するMonostateクラス。 [詳解]

#include <EMoney.h>

公開メンバ関数
bool	isAvailable () const
	電子マネー機能を利用可能であるか否かを取得する。 [詳解]

void	setSoundHook (std::function< void(const EMoneySound &)> hook)
	サウンドフック関数を設定する。 [詳解]

void	resetSoundHook ()
	サウンドフック関数を解除し、未設定状態に戻す。 [詳解]

bool	isServiceAlive () const
	サービスサーバが生存しているか否かを取得する。 [詳解]

bool	isAuthCompleted () const
	端末認証を実施済みであるか否かを取得する。 [詳解]

const wchar_t *	getTerminalId () const
	端末ID値を取得する。 [詳解]

const wchar_t *	getTerminalSerial () const
	端末シリアル値を取得する。 [詳解]

bool	isBrandAvailable (EMoneyBrandId brandId) const
	ブランドが有効であるか否かを取得する。 [詳解]

std::size_t	getAvailableBrandCount () const
	有効ブランド数を取得する。 [詳解]

const EMoneyBrand &	getAvailableBrand (std::size_t index) const
	有効ブランド情報を取得する。 [詳解]

std::vector< std::reference_wrapper< const EMoneyBrand > >	getAvailableBrands () const
	有効ブランド情報配列を取得する。 [詳解]

EMoneyOperation &	getOperation ()
	通信操作インスタンスを取得する。 [詳解]

const EMoneyOperation &	getOperation () const
	通信操作インスタンスを取得する。 [詳解]

std::size_t	getDealResultCount () const
	取引結果履歴の有効項目数を取得する。 [詳解]

const EMoneyResult &	getDealResult (std::size_t index) const
	取引結果履歴の項目を取得する。 [詳解]

std::vector< std::reference_wrapper< const EMoneyResult > >	getDealResults () const
	取引結果履歴配列を取得する。 [詳解]

bool	isReporting () const
	締め処理中であるか否かを取得する。 [詳解]

std::size_t	getReportCount () const
	締め処理結果履歴の有効項目数を取得する。 [詳解]

const EMoneyReport &	getReport (std::size_t index) const
	締め処理結果履歴の項目を取得する。 [詳解]

std::vector< std::reference_wrapper< const EMoneyReport > >	getReports () const
	締め処理結果履歴配列を取得する。 [詳解]

詳解

電子マネー処理を提供するMonostateクラス。

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

プラットフォーム情報

ALLSシリーズの電子マネー対応版SDKでのみ利用可能である。
上記以外の場合、常にサービスサーバ非生存かつ各種項目数 0 として扱われる。

関数詳解

bool amdaemon::EMoney::isAvailable ( ) const

電子マネー機能を利用可能であるか否かを取得する。

戻り値

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

void amdaemon::EMoney::setSoundHook ( std::function< void(const EMoneySound &)> hook )

サウンドフック関数を設定する。

引数

[in] hook フック関数。

参照: EMoneySound

この関数でフック関数(コールバック)を設定すると、電子マネー用のサウンドを処理すべきタイミングでこのフック関数が呼び出される。

電子マネー用のサウンドは必ず処理しなければならないため、必ずこの関数にフック関数を登録し、サウンド再生/停止処理を実施すること。

フック関数の第1引数にはサウンド情報が渡される。

メンバ関数 EMoneySound::isStopRequired が false を返す場合、メンバ関数 EMoneySound::getId や EMoneySound::getFilePath を基に、対応するサウンドの再生処理を開始すること。
メンバ関数 EMoneySound::isStopRequired が true を返す場合、電子マネー関連サウンドを再生中であればそれを即座に停止すること。

EMoneySound クラスはコピー可能であるため、必要に応じてコピーしてもよい。

フック関数未設定である場合、設定されるまでフック処理が保留される。

サウンド再生に関しては、 EMoneySound クラスの説明も参照すること。

void amdaemon::EMoney::resetSoundHook ( )

サウンドフック関数を解除し、未設定状態に戻す。

参照: setSoundHook

フック関数未設定である場合、設定されるまでフック関数呼び出しが保留される。

bool amdaemon::EMoney::isServiceAlive ( ) const

サービスサーバが生存しているか否かを取得する。

戻り値

true	生存している場合。
false	生存が確認できないか、電子マネー機能が無効である場合。

メンバ関数 isAuthCompleted が false を返す場合、疎通確認を行えないため、実際のサービスサーバ生存状態に関わらずこの関数は false を返す。

bool amdaemon::EMoney::isAuthCompleted ( ) const

端末認証を実施済みであるか否かを取得する。

戻り値: true 実施済みである場合。; false 未実施であるか、電子マネー機能が無効である場合。

参照: EMoneyOperation::authTerminal

const wchar_t* amdaemon::EMoney::getTerminalId ( ) const

端末ID値を取得する。

戻り値: 端末ID値。端末認証未実施の場合は nullptr 。

最大文字数は amdaemon::MaxEMoneyTerminalIdLength 。終端文字を含まない。

const wchar_t* amdaemon::EMoney::getTerminalSerial ( ) const

端末シリアル値を取得する。

戻り値: 端末シリアル値。端末認証未実施の場合は nullptr 。

最大文字数は amdaemon::MaxEMoneyTerminalSerialLength 。終端文字を含まない。

bool amdaemon::EMoney::isBrandAvailable ( EMoneyBrandId brandId ) const

ブランドが有効であるか否かを取得する。

引数

[in] brandId ブランドID。

戻り値

true	有効である場合。
false	無効である場合。

無効なブランドに対して残高照会や支払といった操作を行うことはできない。

std::size_t amdaemon::EMoney::getAvailableBrandCount ( ) const

有効ブランド数を取得する。

戻り値: 有効ブランド数。サービスサーバーの生存が確認できない場合や、端末認証未実施の場合は 0 。

const EMoneyBrand& amdaemon::EMoney::getAvailableBrand ( std::size_t index ) const

有効ブランド情報を取得する。

引数

[in] index 有効ブランドのインデックス。

戻り値: 有効ブランド情報。

例外

Exception

電子マネー機能が無効である場合。
引数 index に有効ブランド数以上の値を指定した場合。有効ブランド数はメンバ関数 getAvailableBrandCount で取得できる。

この関数で取得できるブランド情報は、表示優先順に並んでいる。アプリでブランド選択画面を表示する際は、この関数のインデックス順に従ってアイコン画像を並べること。

std::vector<std::reference_wrapper<const EMoneyBrand> > amdaemon::EMoney::getAvailableBrands ( ) const

inline

有効ブランド情報配列を取得する。

戻り値: 有効ブランド情報配列。

範囲for文や各種アルゴリズム関数に渡すことを想定している。

有効ブランド数を知りたいだけならばメンバ関数 getAvailableBrandCount を用いること。
特定の有効ブランド情報を取得したいだけならばメンバ関数 getAvailableBrand を用いること。

EMoneyOperation& amdaemon::EMoney::getOperation ( )

通信操作インスタンスを取得する。

戻り値: 通信操作インスタンス。

const EMoneyOperation& amdaemon::EMoney::getOperation ( ) const

通信操作インスタンスを取得する。

戻り値: 通信操作インスタンス。

std::size_t amdaemon::EMoney::getDealResultCount ( ) const

取引結果履歴の有効項目数を取得する。

戻り値: 取引結果履歴の有効項目数。最大値は amdaemon::MaxEMoneyDealResultCount 。電子マネー機能が無効である場合は 0 。

const EMoneyResult& amdaemon::EMoney::getDealResult ( std::size_t index ) const

取引結果履歴の項目を取得する。

引数

[in] index 取引結果履歴インデックス。

戻り値: 取引結果履歴項目。

例外

Exception

電子マネー機能が無効である場合。
引数 index に有効項目数以上の値を指定した場合。有効項目数はメンバ関数 getDealResultCount で取得できる。

インデックスの小さい要素ほど取引日時が新しい。

std::vector<std::reference_wrapper<const EMoneyResult> > amdaemon::EMoney::getDealResults ( ) const

inline

取引結果履歴配列を取得する。

戻り値: 取引結果履歴配列。

範囲for文や各種アルゴリズム関数に渡すことを想定している。

履歴の有効項目数を知りたいだけならばメンバ関数 getDealResultCount を用いること。
特定の履歴項目を取得したいだけならばメンバ関数 getDealResult を用いること。

bool amdaemon::EMoney::isReporting ( ) const

締め処理中であるか否かを取得する。

戻り値

true	締め処理中である場合。
false	締め処理中ではないか、電子マネー機能が無効である場合。

締め処理中である場合、 EMoneyOperation クラスの各種操作を開始することはできない。ただしメンバ関数 EMoneyOperation::checkDisplay だけは開始可能である。

std::size_t amdaemon::EMoney::getReportCount ( ) const

締め処理結果履歴の有効項目数を取得する。

戻り値: 締め処理結果履歴の有効項目数。最大値は amdaemon::MaxEMoneyReportCount 。電子マネー機能が無効である場合は 0 。

const EMoneyReport& amdaemon::EMoney::getReport ( std::size_t index ) const

締め処理結果履歴の項目を取得する。

引数

[in] index 締め処理結果履歴インデックス。

戻り値: 締め処理結果履歴項目。

例外

Exception

電子マネー機能が無効である場合。
引数 index に有効項目数以上の値を指定した場合。有効項目数はメンバ関数 getReportCount で取得できる。

インデックスの小さい要素ほど処理日時が新しい。

現状、締め処理対象ブランドは楽天Edyのみとなっている。集計期間中に対象ブランドでの支払いが一度も行われていない場合、支払件数や支払総額が 0 となるが、正常な動作である。

std::vector<std::reference_wrapper<const EMoneyReport> > amdaemon::EMoney::getReports ( ) const

inline

締め処理結果履歴配列を取得する。

戻り値: 締め処理結果履歴配列。

範囲for文や各種アルゴリズム関数に渡すことを想定している。

履歴の有効項目数を知りたいだけならばメンバ関数 getReportCount を用いること。
特定の履歴項目を取得したいだけならばメンバ関数 getReport を用いること。

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

EMoney.h

公開メンバ関数

詳解

関数詳解