Share via

UserDataFeedSyncScope Class

  • Reference
Package:
com.microsoft.connecteddevices.userdata
  • java.lang.Object
    • NativeBase
      • com.microsoft.connecteddevices.userdata.UserDataFeedSyncScope

public class UserDataFeedSyncScope

This class represents the scope for synchronizing user-specific data with the Connected Devices Platform backend when the app uses certain functionality, such as useractivities. An instance can be retrieved statically from the class for the specific functionality (e.g. **UserActivityChannel**), and it is used for configuration of **UserDataFeed** behavior for synchronizing data.

Method Summary

Modifier and Type Method and Description
String getNotificationType()

Set type of change notifications for **UserDataFeed** sync scope

String getPlatform()

Set the platform to restrict incoming activities to apps which support the platform.

List<String> getSyncScopeFlags()

Set any optional flags for filtering incoming activities.

void setNotificationType(@Nullable String notificationType)

Set type of change notifications for **UserDataFeed** sync scope.

void setPlatform(@Nullable String platform)

Set the platform to restrict incoming activities to apps which support the platform. Note, it is only useful for applications which can subscribe to a user's entire data feed, not just for the current app.

void setSyncScopeFlags(@Nullable Collection<String> syncScopeFlags)

Set any optional flags for filtering incoming activities.

Method Details

getNotificationType

public String getNotificationType()

Set type of change notifications for **UserDataFeed** sync scope

Returns:

type of notification to receive (see **UserDataFeedNotificationTypes**)

getPlatform

public String getPlatform()

Set the platform to restrict incoming activities to apps which support the platform.

Returns:

the specified platform (see **UserDataFeedPlatforms**).

getSyncScopeFlags

public List getSyncScopeFlags()

Set any optional flags for filtering incoming activities.

Returns:

set of flags for sync scope (see **UserDataFeedSyncScopeFlags**).

setNotificationType

public void setNotificationType(@Nullable String notificationType)

Set type of change notifications for **UserDataFeed** sync scope.

Parameters:

notificationType - type of notification to receive (see **UserDataFeedNotificationTypes**).

setPlatform

public void setPlatform(@Nullable String platform)

Set the platform to restrict incoming activities to apps which support the platform. Note, it is only useful for applications which can subscribe to a user's entire data feed, not just for the current app.

Parameters:

platform - the specified platform (see **UserDataFeedPlatforms**).

setSyncScopeFlags

public void setSyncScopeFlags(@Nullable Collection syncScopeFlags)

Set any optional flags for filtering incoming activities.

Parameters:

syncScopeFlags - set of flags for sync scope (see **UserDataFeedSyncScopeFlags**).

Applies to