Interface IRealtimeRequest

Current version: 4.0

Interface for real-time notification requests.

Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsNotifications
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public interface IRealtimeRequest

Properties

Gets or sets the target when the notification is clicked.

Declaration
RequestResponse
Uri Link { get; set; }
Property Value
TypeDescription
Uri

NotificationLevel

Gets or sets the notification level.

Declaration
RequestResponse
NotificationLevel NotificationLevel { get; set; }
Property Value
TypeDescription
NotificationLevel

Options

Gets or sets the notification options. This directly maps to the notification API standard used by browsers. See https://developer.mozilla.org/en-US/docs/Web/API/notification for more information.

Declaration
RequestResponse
JObject Options { get; set; }
Property Value
TypeDescription
JObject

Title

Gets or sets the title of the notification.

Declaration
RequestResponse
string Title { get; set; }
Property Value
TypeDescription
string

Methods

GetBody()

Gets the notification body from the Options object.

Declaration
RequestResponse
string GetBody()
Returns
TypeDescription
string

The notification body.

GetIcon()

Gets the notification icon from the Options object.

Declaration
RequestResponse
string GetIcon()
Returns
TypeDescription
string

The notification icon.

SetBody(string)

Sets the notification body on the Options object.

Declaration
RequestResponse
void SetBody(string body)
Parameters
TypeNameDescription
stringbody

The notification body.

SetIcon(string)

Sets the notification icon on the Options object.

Declaration
RequestResponse
void SetIcon(string icon)
Parameters
TypeNameDescription
stringicon

The notification icon.

Validate()

Validates the real-time request.

Declaration
RequestResponse
void Validate()
Exceptions
TypeCondition
ValidationException

When the request has invalid properties.

Do you have some feedback for us?

If you have suggestions for improving this article,