Salesforceコラム
Salesforceに特化した情報をお届けします

Salesforce開発におけるAnnouncementsクラスとは?

2021年03月30日

SalesforceのChatterによるお知らせ機能とは


「お知らせ(Announcement)」とは、SalesforceのChatterを利用し、情報を強調表示、発信させるために使用します。また、この「お知らせ」の投稿に関して、ユーザはディスカッション、いいね、コメントの投稿の対応が可能です。

この「お知らせ」の取得、作成、更新、削除をApexで管理する際に用いられるのが「Announcements」クラスです。

Salesforce環境のApex、Lightningとは


Apex は、Salesforce環境開発用のオブジェクト指向のプログラミング言語です。

開発者が Lightningプラットフォームサーバで、フローとトランザクションの制御ステートメントをAPIへのコールと組み合わせて実行できることを実現しています。

Lightning プラットフォームとは、セールスフォース・ドットコム社が提供するステップ開発のためのクラウドプラットフォーム(PaaS)です。

「ノンプログラミングでのアプリケーション開発」機能もあり、Salesforceのアプリケーションで提供されている多くの機能を利用できるため、機能拡張のような特に親和性の高いアプリケーションを作成できます。

Announcements クラスとは


Salesforceのお知らせに関する情報にアクセスして、お知らせを投稿するためのクラスです。

・名前空間

ConnectApi

・使用方法

ConnectApi.Announcements クラスを使用して、お知らせを取得、作成、更新、および削除します。お知らせは、情報を強調表示するために使用します。

ユーザは、お知らせに対するディスカッション、いいね、コメントの投稿ができます。フィード投稿を削除するとお知らせが削除されます。

お知らせを作成すると、お知らせのテキストを含むフィード項目も作成されます。お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の11:59 p.m. までSalesforce UIの指定の場所に表示されます。

Announcements のメソッドとは


Announcements クラスに対して具体的な処理を行うメソッドは次のとおりです。すべてのメソッドが静的です。

1.deleteAnnouncement(communityId, announcementId)

お知らせを削除します。

API バージョン:31.0

Chatter が必要かどうか:はい

署名:public static void deleteAnnouncement(String communityId, String announcementId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

announcementId

型: String

0BT というプレフィックスが付いたお知らせ ID。

戻り値

型: Void

使用方法

グループ内のお知らせのリストを取得するには、getAnnouncements(communityId, parentId) または getAnnouncements(communityId, parentId, pageParam, pageSize) をコールします。

お知らせをグループに投稿するには、postAnnouncement(communityId, announcement) をコールします。

2.getAnnouncement(communityId, announcementId)

お知らせを取得します。

API バージョン:31.0

Chatter が必要かどうか:はい

署名:public static ConnectApi.Announcement getAnnouncement(String communityId, String announcementId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

announcementId

型: String

0BT というプレフィックスが付いたお知らせ ID。

戻り値

型: ConnectApi.Announcement

使用方法

グループ内のお知らせのリストを取得するには、getAnnouncements(communityId, parentId) または getAnnouncements(communityId, parentId, pageParam, pageSize) をコールします。

お知らせをグループに投稿するには、postAnnouncement(communityId, announcement) をコールします。

3.getAnnouncements(communityId, parentId)

お知らせの最初のページを取得します。

API バージョン:36.0

ゲストユーザが使用可能:38.0

Chatter が必要かどうか:はい

署名:public static ConnectApi.AnnouncementPage getAnnouncements(String communityId, String parentId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

parentId

型: String

お知らせの親エンティティの ID。お知らせがグループに表示されるときのグループ ID です。

戻り値

型: ConnectApi.AnnouncementPage

4.getAnnouncements(communityId, parentId, pageParam, pageSize)

お知らせのページを取得します。

API バージョン:36.0

ゲストユーザが使用可能:38.0

Chatter が必要かどうか:はい

署名:public static ConnectApi.AnnouncementPage getAnnouncements(String communityId, String parentId, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

parentId

型: String

お知らせの親エンティティの ID。お知らせがグループに表示されるときのグループ ID です。

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

1 ページあたりのお知らせの数を指定します。

戻り値

型: ConnectApi.AnnouncementPage

5.postAnnouncement(communityId, announcement)

お知らせを投稿します。

API バージョン:36.0

Chatter が必要かどうか:はい

署名:public static ConnectApi.Announcement postAnnouncement(String communityId, ConnectApi.AnnouncementInput announcement)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

announcement

型: ConnectApi.AnnouncementInput

ConnectApi.AnnouncementInput オブジェクト。

戻り値

型: ConnectApi.Announcement

6.updateAnnouncement(communityId, announcementId, expirationDate)

お知らせの表示期限を更新します。

API バージョン:31.0

Chatter が必要かどうか:はい

署名:public static ConnectApi.Announcement updateAnnouncement(String communityId, String announcementId, Datetime expirationDate)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

announcementId

型: String

0BT というプレフィックスが付いたお知らせ ID。

expirationDate

型: Datetime

別のお知らせが最初に投稿されていない限り、この日付の午後 11 時 59 分まで Salesforce UI にお知らせが表示されます。Salesforce UI では、expirationDate の時間値は無視されます。ただし、時間値を使用して各自の UI で独自の表示ロジックを作成することはできます。

戻り値

型: ConnectApi.Announcement

使用方法
グループ内のお知らせのリストを取得するには、getAnnouncements(communityId, parentId) または getAnnouncements(communityId, parentId, pageParam, pageSize) をコールします。

お知らせをグループに投稿するには、postAnnouncement(communityId, announcement) をコールします。

SalesforceのAnnouncementsクラスを理解して、お知らせ投稿機能を管理しよう!


営業支援、案件管理という意味でも情報を強調表示させるお知らせ投稿の機能は重要です。また、即時にユーザがディスカッション、コメント、いいねで反応できるので情報に対する反応も受け取ることができます。

適切にConnectApi.Announcementsクラスを使用して、お知らせを取得、作成、更新、および削除することによって、ベストな情報展開を実現しましょう。


Salesforceでのキャリアアップをお考えの方は、現在募集中の求人情報をご覧ください。

また、直接のエントリーも受け付けております。

エントリー(応募フォーム)