Stylelabs.M.Sdk.Models.Notifications

API reference
SDK reference

Class RealtimeRequest

Base class for real-time notification (browser notification) requests.

Inheritance

object

RealtimeRequest

RealtimeRequestBroadcast

RealtimeRequestById

RealtimeRequestByUsername

Implements

IRealtimeRequest

Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ModelsNotifications

Assembly: Stylelabs.M.Sdk.dll

Syntax

public abstract class RealtimeRequest : IRealtimeRequest

Properties

Link

Gets or sets the target when the notification is clicked.

Declaration

public Uri Link { get; set; }

Property Value

Type	Description
Uri

NotificationLevel

Gets or sets the notification level.

Declaration

public 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

public JObject Options { get; set; }

Property Value

Type	Description
JObject

Title

Gets or sets the title of the notification.

Declaration

public string Title { get; set; }

Property Value

Type	Description
string

Methods

GetBody()

Gets the notification body from the Options object.

Declaration

public string GetBody()

Returns

Type	Description
string	The notification body.

GetIcon()

Gets the notification icon from the Options object.

Declaration

public string GetIcon()

Returns

Type	Description
string	The notification icon.

SetBody(string)

Sets the notification body on the Options object.

Declaration

public void SetBody(string body)

Parameters

Type	Name	Description
string	body	The notification body.

SetIcon(string)

Sets the notification icon on the Options object.

Declaration

public void SetIcon(string icon)

Parameters

Type	Name	Description
string	icon	The notification icon.

Validate()

Validates the real-time request.

Declaration

public abstract void Validate()

Exceptions

Type	Condition
ValidationException	When the request has invalid properties.

Implements

IRealtimeRequest

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