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

Newer Version Available

This content describes an older version of this product. View Latest

Announcements クラス

お知らせに関する情報にアクセスして、お知らせを投稿します。

名前空間

ConnectApi

使用方法

ConnectApi.Announcements クラスを使用して、お知らせを取得、作成、更新、および削除します。お知らせは、情報を強調表示するために使用します。ユーザは、お知らせに対するディスカッション、いいね!、コメントの投稿ができます。フィード投稿を削除するとお知らせが削除されます。

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

Announcements のメソッド

Announcements のメソッドは次のとおりです。すべてのメソッドが静的です。

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) をコールします。

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) をコールします。

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 です。

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 ページあたりのお知らせの数を指定します。

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

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) をコールします。