Interface IMessageOfTheDayService

Represents the message of the day (MotD) through the Notifications service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface IMessageOfTheDayService

Examples

IMessageOfTheDayService _messageOfTheDayService = relativityFacade.Resolve<IMessageOfTheDayService>();

Methods

| Improve this Doc View Source

Dismiss(Nullable<Int32>)

Dismiss message of the day for the user with the specified ArtifactID by default dismissing MotD for Admin User provided by AdminUsername.

Declaration

void Dismiss(int? userId = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	userId	The user artifact ID.

Examples

int userArtifactID = 1015427;
_messageOfTheDayService.Dismiss(userArtifactID);

| Improve this Doc View Source

Dismiss(String)

Dismiss message of the day for the user with the specified email address.

Declaration

void Dismiss(string emailAddress)

Parameters

Type	Name	Description
System.String	emailAddress	The user email address.

Examples

string userEmailAddress = AUser@test.com;
_messageOfTheDayService.Dismiss(userEmailAddress);

| Improve this Doc View Source

Get()

Gets the message of the day.

Declaration

MessageOfTheDay Get()

Returns

Type	Description
MessageOfTheDay	Returns an MessageOfTheDay instance.

Examples

MessageOfTheDay currentMotd = _messageOfTheDayService.Get();

| Improve this Doc View Source

HasDismissed(Nullable<Int32>)

Determines whether specific user dismissed MotD. by default determining MotD dismissal for Admin User provided by AdminUsername.

Declaration

bool HasDismissed(int? userId = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	userId	The user artifact ID.

Returns

Type	Description
System.Boolean	true if an user dismissed MotD; otherwise, false.

Examples

int userArtifactID = 1015427;
bool hasDismissed = _messageOfTheDayService.HasDismissed(userArtifactID);

| Improve this Doc View Source

IsTextOnly()

Determines whether MotD is text-only.

Declaration

bool IsTextOnly()

Returns

Type	Description
System.Boolean	true if MotD is text-only; otherwise, false.

Examples

bool isTextOnly = _messageOfTheDayService.IsTextOnly();

| Improve this Doc View Source

Update(MessageOfTheDay)

Updates the message of the day.

Declaration

MessageOfTheDay Update(MessageOfTheDay entity)

Parameters

Type	Name	Description
MessageOfTheDay	entity	The entity to update.

Returns

Type	Description
MessageOfTheDay	Returns an MessageOfTheDay instance.

Examples

MessageOfTheDay currentMotd = _messageOfTheDayService.Get();
var toUpdate = new MessageOfTheDay
{
	Enabled = !currentMotd.Enabled,
	Message = Randomizer.GetString(),
	AllowDismiss = !currentMotd.AllowDismiss
};
MessageOfTheDay updatedMotd = _messageOfTheDayService.Update(toUpdate);