Class Notifier

Exposes the user-facing notification functionality of a platform. Also manages push notifications.

Inheritance

System.Object

Notifier

AndroidNotifier

iOSNotifier

Namespace: Sensus.Notifications

Assembly: SensusAndroid.dll

Syntax

public abstract class Notifier : Object

Constructors

Notifier()

Declaration

public Notifier()

Fields

NOTIFICATION_USER_RESPONSE_ACTION_KEY

Declaration

public const string NOTIFICATION_USER_RESPONSE_ACTION_KEY = "SENSUS-NOTIFICATION-USER-RESPONSE-ACTION"

Field Value

Type	Description
System.String

NOTIFICATION_USER_RESPONSE_MESSAGE_KEY

Declaration

public const string NOTIFICATION_USER_RESPONSE_MESSAGE_KEY = "SENSUS-NOTIFICATION-USER-RESPONSE-MESSAGE"

Field Value

Type	Description
System.String

PENDING_SURVEY_BADGE_NOTIFICATION_ID

Declaration

public const string PENDING_SURVEY_BADGE_NOTIFICATION_ID = "SENSUS-PENDING-SURVEY-BADGE-NOTIFICATION"

Field Value

Type	Description
System.String

PENDING_SURVEY_TEXT_NOTIFICATION_ID

Declaration

public const string PENDING_SURVEY_TEXT_NOTIFICATION_ID = "SENSUS-PENDING-SURVEY-TEXT-NOTIFICATION"

Field Value

Type	Description
System.String

Methods

CancelNotification(String)

Declaration

public abstract void CancelNotification(string id)

Parameters

Type	Name	Description
System.String	id

ClearPushNotificationRequestBacklogAsync(CancellationToken)

Declaration

public Task ClearPushNotificationRequestBacklogAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

DeletePushNotificationRequestAsync(Guid, Protocol, CancellationToken)

Declaration

public Task DeletePushNotificationRequestAsync(Guid backendKey, Protocol protocol, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Guid	backendKey
Protocol	protocol
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

IssueNotificationAsync(String, String, String, Boolean, Protocol, Nullable<Int32>, NotificationUserResponseAction, String)

Declaration

public abstract Task IssueNotificationAsync(string title, string message, string id, bool alertUser, Protocol protocol, Nullable<int> badgeNumber, NotificationUserResponseAction userResponseAction, string userResponseMessage)

Parameters

Type	Name	Description
System.String	title
System.String	message
System.String	id
System.Boolean	alertUser
Protocol	protocol
System.Nullable<System.Int32>	badgeNumber
NotificationUserResponseAction	userResponseAction
System.String	userResponseMessage

Returns

Type	Description
System.Threading.Tasks.Task

OnNotificationUserResponseAsync(String, String)

Declaration

public Task OnNotificationUserResponseAsync(string responseAction, string responseMessage)

Parameters

Type	Name	Description
System.String	responseAction
System.String	responseMessage

Returns

Type	Description
System.Threading.Tasks.Task

ProcessReceivedPushNotificationAsync(PushNotification, CancellationToken)

Declaration

public Task ProcessReceivedPushNotificationAsync(PushNotification pushNotification, CancellationToken cancellationToken)

Parameters

Type	Name	Description
PushNotification	pushNotification
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

SendPushNotificationRequestAsync(PushNotificationRequest, CancellationToken)

Declaration

public Task SendPushNotificationRequestAsync(PushNotificationRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
PushNotificationRequest	request
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

TestHealthAsync(CancellationToken)

Declaration

public Task TestHealthAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task