クライアント側のAPI

クライアント側のAPIの概要を以下に示します。ハイブリッドアプリケーション向けのJavaScriptと、それぞれのクライアントOS向けのネイティブ言語のAPIを提供します。

JavaScript APIの概要を以下に示します。

Namespace	メソッド名	意味
FJPHandler	init	プッシュハンドラを利用するための初期設定を行う。

Android向けのAPIの概要を以下に示します。

クラス名	メソッド名	意味
PushManager	init	プッシュハンドラを利用するための初期設定（登録IDの払出しとプッシュ基盤サーバへの接続）を行い、プッシュ通知を受信できる状態にする。
PushManager	initAtomic	プッシュハンドラを利用するための初期設定（登録IDの払出しだけ）を行う。プッシュ通知を受信できない状態。
PushManager	bind	PUSH通信サービスにバインドする。これにより、APIが利用できるようになる。
PushManager	notifyMessageRead	メッセージIDを引数に指定し、IMAPSサーバへメッセージを確認したことを通知する。
PushManager	getFailedMsgIDList	通信エラーによりアプリ領域に保存したメッセージIDの一覧を取得する。
GcmRegister	register	SENDER IDでGCMのregistrationIDを要求し、IMAPSサーバに登録。IMAPSサーバ登録後に、再度、本APIを実行した場合は、GCMのregistrationID要求は行う、IMAPSサーバへの登録はregistrationIDが変更されるまでは行わない。なお、すでにIMAPSサーバ登録後のためGCMのregistrationID要求だけ行った場合でも、要求に成功した場合はPushReceiver:callbackにID登録状態であることが通知される。
GcmRegister	notifyMessageRead	メッセージIDを引数に指定し、IMAPSサーバへメッセージを確認したことを通知する。
GcmRegister	getFailedMsgIDList	通信エラーによりアプリ領域に保存したメッセージIDの一覧を取得する。

PushManager生成時に、引数としてPushReceiverを指定します。
メッセージ(エラーメッセージを含む)を受信したい場合は、以下のメソッドをオーバーライドしてください。

クラス名	メソッド名	意味
PushReceiver	Callback	PushManagerからの通知を受信。

PushMangerのbindメソッドで、引数としてPushServiceを指定します。
プッシュ通知されたメッセージを個別処理したい場合は、以下のメソッドをオーバーライドしてください。

クラス名	メソッド名	意味
PushService	notifyMessage	プッシュ通知されたメッセージを、Androidの通知領域に表示。

iOS向けのクラス、APIの概要を以下に示します。

クラス名	メソッド名	意味
FJPApplication	-	アプリ全体で共有する情報を保持。アプリケーションのエントリポイントUIApplicationMain()の引数として指定。
FJPAppDelegate	-	本クラスを親としてDelegateクラスを作成。
FJPAppDelegateの派生クラス	RegisterForRemoteNotificationTypes	APNsにリモート通知を要求する処理を記述。
FJPMessageReadManager	notifyMessageRead	メッセージIDを引数に指定し、IMAPSサーバへメッセージを確認したことを通知する。
FJPMessageReadManager	getFailedMsgIDList	通信エラーによりアプリ領域に保存したメッセージIDの一覧を取得する。
FJPNotifyDelegateの派生クラス	didNotifyMessageRead	既読通知処理が完了した場合に呼び出す関数。

Windows向けのAPIの概要を以下に示します。

クラス名	メソッド名	意味
WNSRegister	init	WNSから取得したチャネルURIをIMAPSサーバに登録します。 WNSから返されるチャネルURIが変更されることがありうるので、 WNSを利用する場合は、アプリ起動の度に本APIを必ず呼び出してください。また、本APIを呼び出す場合は、UIスレッド上から呼び出してください。
WNSRegister	setPushReceiver	本クラスからの通知を受け取るクラスを設定します。
WNSRegister	notifyMessageRead	メッセージIDを引数に指定し、IMAPSサーバへメッセージを確認したことを通知する。
WNSRegister	getFailedMsgIDList	通信エラーによりアプリ領域に保存したメッセージIDの一覧を取得する。
WNSRegister	getMessageID	トースト通知をタップ後、アプリ起動時に渡される情報からメッセージIDを取得する。

6.4.2 クライアント側のAPI