SFSDKUpdateNotificationsRequestBuilder Class Reference

Inherits from NSObject
Declared in SFRestAPI+Notifications.h

Overview

Use this interface to create a PATCH RestRequest object that calls the Notifications REST API.

– setNotificationId:

Sets the notification to update. Shouldn’t be used with setNotificationIds or setBefore.

- (SFSDKUpdateNotificationsRequestBuilder *)setNotificationId:(NSString *)notificationId

Parameters

notificationId

ID of notification to update.

Declared In

SFRestAPI+Notifications.h

– setNotificationIds:

Sets a list of notifications to update (max 50). Shouldn’t be used with setNotificationId or setBefore.

- (SFSDKUpdateNotificationsRequestBuilder *)setNotificationIds:(NSArray<NSString*> *)notificationIds

Parameters

notificationIds

Array of notifications IDs to update.

Declared In

SFRestAPI+Notifications.h

– setBefore:

Notifications occurring before the provided date will be updated. Shouldn’t be used with setNotificationId or setNotificationIds.

- (SFSDKUpdateNotificationsRequestBuilder *)setBefore:(NSDate *)date

Parameters

date

Before date. If unspecified, defaults to current date and time.

Declared In

SFRestAPI+Notifications.h

– setSeen:

Marks the notification(s) as seen (true) or unseen (false)

- (SFSDKUpdateNotificationsRequestBuilder *)setSeen:(BOOL)seen

Parameters

seen

If the notification is seen or not.

Declared In

SFRestAPI+Notifications.h

– setRead:

Marks the notification(s) as read (true) or unread (false)

- (SFSDKUpdateNotificationsRequestBuilder *)setRead:(BOOL)read

Parameters

read

If the notification is read or not.

Declared In

SFRestAPI+Notifications.h

– buildUpdateNotificationsRequest:

Returns a request to update notifications based on values from the builder.

- (SFRestRequest *)buildUpdateNotificationsRequest:(NSString *)apiVersion

Parameters

apiVersion

API version.

Declared In

SFRestAPI+Notifications.h