Share via

UserNotificationChannel Class

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

public class UserNotificationChannel

This class provides the notification change reader which handles the receiving and management of user notifications for the application.

Constructor Summary

Constructor Description
UserNotificationChannel(@NonNull UserDataFeed userDataFeed)

Creates and initializes a new instance of UserNotificationChannel

Method Summary

Modifier and Type Method and Description
UserNotificationReader createReader()

Create a user notification reader to receive and manage user notifications published by app server.

UserNotificationReader createReaderWithOptions(@NonNull UserNotificationReaderOptions options)

Create a user notification reader with options

UserNotificationReader createReaderWithState(@NonNull String serializedState)

Create a user notification reader to receive and manage user notifications published by app server. The reader will start at the provided tracking state.

AsyncOperation<UserNotificationUpdateResult> deleteUserNotificationAsync(@NonNull String notificationId)

Delete a user notification based on its id.

UserDataFeedSyncScope getSyncScope()

Gets the sync scope for this user notification channel.

AsyncOperation<UserNotification> getUserNotificationAsync(@NonNull String notificationId)

Get a user notification based on its id.

Constructor Details

UserNotificationChannel

public UserNotificationChannel(@NonNull UserDataFeed userDataFeed)

Creates and initializes a new instance of UserNotificationChannel

Parameters:

userDataFeed

Method Details

createReader

public UserNotificationReader createReader()

Create a user notification reader to receive and manage user notifications published by app server.

createReaderWithOptions

public UserNotificationReader createReaderWithOptions(@NonNull UserNotificationReaderOptions options)

Create a user notification reader with options

Parameters:

options

createReaderWithState

public UserNotificationReader createReaderWithState(@NonNull String serializedState)

Create a user notification reader to receive and manage user notifications published by app server. The reader will start at the provided tracking state.

Parameters:

serializedState

deleteUserNotificationAsync

public AsyncOperation deleteUserNotificationAsync(@NonNull String notificationId)

Delete a user notification based on its id.

Parameters:

notificationId

getSyncScope

public static UserDataFeedSyncScope getSyncScope()

Gets the sync scope for this user notification channel.

getUserNotificationAsync

public AsyncOperation getUserNotificationAsync(@NonNull String notificationId)

Get a user notification based on its id.

Parameters:

notificationId

Applies to