この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

CustomNotification クラス

CustomNotification は、Apex コードからカスタム通知を作成、設定、送信するために使用されます。

名前空間

メッセージ通信

使用方法

CustomNotification では、2 つの方法でカスタム通知を作成および設定できます。

デフォルトのコンストラクターを使用してインスタンスを作成し、さまざまな setter メソッドを使用して通知属性を設定します。
インスタンスを作成し、同時にパラメーター化されたコンストラクターを使用して通知パラメーターを設定します。

カスタム通知を設定したら、send() をコールして通知を送信します。

通知対象

通知対象は、受信側のクライアントアプリケーションによってユーザーが通知に応答するときに適切なレコードまたはページに移動するために使用されます。たとえば、レコードが更新されたとユーザーが通知された場合、通知に応答すると関連レコードが開く場合があります。

通知の対象を指定する必要があります。対象は targetID 属性または targetPageRef 属性を使用して指定できます。どちらの属性も必須ではありませんが、両方の属性が省略された場合、send() で例外が発生します。通知に適した対象が存在しない場合は、targetID を 000000000000000AAA などのダミーの値に設定します。ダミーの値は、例外を防ぐだけでなく、クライアントアプリケーションで通知に応答したときの自動的な移動も防ぎます。

同じ通知で targetID と targetPageRef の両方を設定できます。通知を受信したクライアントアプリケーションによって、通知に応答するときにどの対象を使用するか (存在する場合) が決まります。

Winter ’21 より前には、通知の対象レコード (targetID) しか設定できませんでした。ほとんどのクライアントアプリケーションでは通知ペイロードに targetID があることを想定しています。targetPageRef しか含まれない通知を処理するようにクライアントアプリケーションを更新できない場合は、targetID をダミーの値に設定してください。

重要

実行コンテキストおよび通知の権限

デフォルトでは、Apex コードはシステムモードで実行され、CustomNotification を使用して通知を送信するためにユーザー権限は必要ありません。ただし、たとえば開発者コンソールで匿名 Apex を実行するなど、Apex コードがユーザーコンテキストで実行されている場合、「カスタム通知を送信」ユーザー権限がチェックされ、必要な権限がない場合は send() が失敗します。

例

次の例の Apex クラスでは、カスタム通知を受信者リストに送信するための静的メソッドが提供されます。Apex からカスタム通知を送信するには、トリガーやフローなど、任意の場所からこのメソッドをコールします。

1public without sharing class CustomNotificationFromApex {
2
3    public static void notifyUsers(Set<String> recipientsIds, String targetId) {
4
5        // Get the Id for our custom notification type
6        CustomNotificationType notificationType = 
7            [SELECT Id, DeveloperName 
8             FROM CustomNotificationType 
9             WHERE DeveloperName='Custom_Notification'];
10        
11        // Create a new custom notification
12        Messaging.CustomNotification notification = new Messaging.CustomNotification();
13
14        // Set the contents for the notification
15        notification.setTitle('Apex Custom Notification');
16        notification.setBody('The notifications are coming from INSIDE the Apex!');
17
18        // Set the notification type and target
19        notification.setNotificationTypeId(notificationType.Id);
20        notification.setTargetId(targetId);
21        
22        // Actually send the notification
23        try {
24            notification.send(recipientsIds);
25        }
26        catch (Exception e) {
27            System.debug('Problem sending notification: ' + e.getMessage());
28        }
29    }
30}

この例ではハードコードされた文字列 Custom_Notification をカスタム通知種別の DeveloperName (API 参照名とも呼ばれる) として使用しています。各自のコードでカスタム通知種別を使用してください。

CustomNotification.send() でエラーが発生する場合があり、この例では最小限の処理にとどめています。本番環境での使用を計画しているコードには、より大規模なエラー処理を追加してください。

メモ

CustomNotification のコンストラクター

CustomNotification のコンストラクターは次のとおりです。