RemoteNotifications 外部オブジェクト

非推奨: GeneXus 15 Upgrade 3 以降。後継機能: Notification Provider API。

通知を受信するには、こちらの記事で説明されているデバイス登録構造を使用する前に、デバイスを登録しておく必要があります。スマートデバイスアプリケーションでのプッシュ通知は、RemoteNotifications と呼ばれるスマートデバイス用の外部オブジェクトを使用して送信されます。

プロパティ

[ ErrorCode ] プロパティ

配信された通知のエラーコードを取得できます。例:

200: 配信成功。
400: クライアント側で配信エラー。
500: サーバー側で配信エラー。

[ ErrorDescription ] プロパティ

エラーの説明を取得できます。エラーが発生していない場合は空です。

メソッド

Call メソッド

通知を送信します。バッチを送信するにはパフォーマンスが不十分です。代わりに Send メソッドを使用してください。

戻り値	なし
パラメーター	ApplicationId:Character(128)、DeviceType:SmartDeviceType、DeviceToken:Character(255)、AlertMessage:Character(128)

IOSSetBadge メソッド

対象となる iOS デバイスのアプリケーションのアイコン上にバッジの数値を設定します。
このアクションは、アプリケーション識別子、デバイストークン (またはデバイス識別子)、バッジの数値、およびオプションでカスタムサウンドへのパスを指定することで実行されます。操作が正常に実行されると 0 を返します。

戻り値	Numeric(5.0)
パラメーター	ApplicationId:Character(128)、DeviceToken:Character(255)、BadgeNumber:Numeric(5.0)、Sound:Character(128)

IOSResetBadge メソッド

対象となる iOS デバイスのアプリケーションアイコン上のバッジをリセットします。操作が正常に実行されると 0 を返します。

戻り値	Numeric(5.0)
パラメーター	ApplicationId:Character(128)、DeviceToken:Character(255)

CallAction メソッド

特定のユーザー定義イベント (またはアクション) に、パラメーターを設定して通知を送信します。バッチを送信するにはパフォーマンスが不十分です。代わりに Send メソッドを使用してください。

戻り値	なし
パラメーター	ApplicationId:Character(128)、DeviceType:SmartDeviceType、DeviceToken:Character(255)、AlertMessage:Character(128)、ActionName:Character(128)、Parameters:NotificationParameters

OpenSession メソッド

通知を受け取るメインオブジェクトを指定します。

戻り値	なし
パラメーター	ApplicationId:Character(128)

Add メソッド

新しい通知を追加します (RemoteNotification SDT に基づく)。

戻り値	なし
パラメーター	RemoteNotification:RemoteNotification

Send メソッド

対象となるデバイス (事前に設定) に通知を送信します。

戻り値	Collection(RemoteNotificationResult)
パラメーター	なし

SetConfiguration メソッド

実行時に通知の設定を行えます。

戻り値	なし
パラメーター	ApplicationId:Character(128)、Configuration:NotificationsConfiguration

イベント

なし

ドメイン

SmartDeviceType ドメイン

スマートデバイスのプラットフォームを指定します。

Android	Android デバイス
BlackBerry	Blackberry デバイス (GeneXus 15 ではサポートされていません)
iOS	iOS デバイス
Windows	Windows Phone デバイス (GeneXus 15 ではサポートされていません)

ExecutionEvent

通知の実行方法を指定します。

OnLaunchByUser	ユーザーによって通知が起動されます。
OnNotificationArrive	通知が到着すると通知が起動されます。

PushNotificationPriority
通知の優先度です。

Normal	デバイスが Doze モード (省電力モード) になっている場合、デバイスを起動しません。
High	デバイスが Doze モード (省電力モード) になっている場合、デバイスを起動します。

構造化データタイプ

RemoteNotification

対象となるデバイスとその設定を説明します。

DeviceType: SmartDeviceType
対象となるデバイスのタイプを指定します。
DeviceToken: Character(256)
対象となるデバイスの識別子 (登録されたときの値) を指定します。
Title:Character(127)
通知のタイトル。
Message:Character(127)
通知のメッセージ。
Icon:Image
通知のアイコン。
Sound:Character(20)
オーディオファイル名 (Android または iOS プロジェクトに手動で追加する必要があります)。
Badge:Character(3)
iOS デバイスにアプリケーションバッジを設定します。
イベント
- Name:Character(100)
  クライアント側のイベントまたはアクションの名前 (Panel for Smart Devices または WorkWith for Smart Devices のイベント名)
- Execution:EventExecution
  通知の実行方法。
- Parameters: Collection
  - Name:Character(100)
    パラメーターの名前。クライアント側の変数名にする必要があります (Panel for Smart Devices または WorkWith for Smart Devices)。
  - Value:Character(100)
    パラメーターの値。
- Delivery
  - Priority:PushNotificationPriority
    通知の優先順位を指定します。

注

メインアプリケーションで OnNotificationArrive モードを使用して定義されたイベントには、UI を含むコマンド、関数、またはコントロール (msg、confirm など) を追加できません。このような通知は、デバイスがロックされている場合、アプリケーションがバックグラウンドで実行されている場合、およびアプリケーションが実行されていない場合でも到達できます。アプリケーションがフォアグラウンドで実行されている場合でも可能です (開発者が [ Interop.ApplicationState ] プロパティを使用して確認する必要があります)。

適用範囲

対応しているプラットフォーム:

スマートデバイス (iOS、Android)

使用可能バージョン

Add、Send、および SetConfiguration メソッドは、GeneXus X Evolution 3 以降の .NET でのみ使用できます。

参考情報

スマートデバイスアプリケーションに通知を送信する方法