Stylelabs.M.Sdk.Contracts.Notifications

API reference
SDK reference

Interface IRealtimeRequest

Interface for real-time notification requests.

Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsNotifications

Assembly: Stylelabs.M.Sdk.dll

Syntax

public interface IRealtimeRequest

Properties

Link

Gets or sets the target when the notification is clicked.

Declaration

Uri Link { get; set; }

Property Value

Type	Description
Uri

NotificationLevel

Gets or sets the notification level.

Declaration

NotificationLevel NotificationLevel { get; set; }

Property Value

Type	Description
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

JObject Options { get; set; }

Property Value

Type	Description
JObject

Title

Gets or sets the title of the notification.

Declaration

string Title { get; set; }

Property Value

Type	Description
string

Methods

GetBody()

Gets the notification body from the Options object.

Declaration

string GetBody()

Returns

Type	Description
string	The notification body.

GetIcon()

Gets the notification icon from the Options object.

Declaration

string GetIcon()

Returns

Type	Description
string	The notification icon.

SetBody(string)

Sets the notification body on the Options object.

Declaration

void SetBody(string body)

Parameters

Type	Name	Description
string	body	The notification body.

SetIcon(string)

Sets the notification icon on the Options object.

Declaration

void SetIcon(string icon)

Parameters

Type	Name	Description
string	icon	The notification icon.

Validate()

Validates the real-time request.

Declaration

void Validate()

Exceptions

Type	Condition
ValidationException	When the request has invalid properties.

If you have suggestions for improving this article, let us know!