Interface INotificationsClient

Contains functionality to manage and send notifications.

Namespace: Stylelabs.M.Sdk.Clients

Assembly: Stylelabs.M.Sdk.dll

Syntax

public interface INotificationsClient

Methods

GetMailTemplateAsync(String, IEntityLoadConfiguration)

Gets an mail template entity by name.

Declaration

Task<IMailTemplate> GetMailTemplateAsync(string name, IEntityLoadConfiguration loadConfiguration = null)

Parameters

Type	Name	Description
System.String	name	Name of the mail template.
IEntityLoadConfiguration	loadConfiguration	The load configuration.

Returns

Type	Description
Task<IMailTemplate>	The mail template entity or null if it does not exist.

GetMailTemplateEntitiesAsync(IEnumerable<String>, IEntityLoadConfiguration)

Gets mail template entities by name. The result can have a different ordering and size (when entities don't exist) than the input.

Declaration

Task<IList<IMailTemplateEntity>> GetMailTemplateEntitiesAsync(IEnumerable<string> names, IEntityLoadConfiguration loadConfiguration = null)

Parameters

Type	Name	Description
IEnumerable<System.String>	names	Names of the mail templates.
IEntityLoadConfiguration	loadConfiguration	The load configuration.

Returns

Type	Description
Task<IList<IMailTemplateEntity>>	The mail template entities. Can contain null when a mail template was not found.

GetMailTemplateEntityAsync(String, IEntityLoadConfiguration)

Gets an mail template entity by name.

Declaration

Task<IMailTemplateEntity> GetMailTemplateEntityAsync(string name, IEntityLoadConfiguration loadConfiguration = null)

Parameters

Type	Name	Description
System.String	name	Name of the mail template.
IEntityLoadConfiguration	loadConfiguration	The load configuration.

Returns

Type	Description
Task<IMailTemplateEntity>	The mail template entity or null if it does not exist.

GetMailTemplatesAsync(IEnumerable<String>, IEntityLoadConfiguration)

Gets mail template entities by name. The result can have a different ordering and size (when entities don't exist) than the input.

Declaration

Task<IList<IMailTemplate>> GetMailTemplatesAsync(IEnumerable<string> names, IEntityLoadConfiguration loadConfiguration = null)

Parameters

Type	Name	Description
IEnumerable<System.String>	names	Names of the mail templates.
IEntityLoadConfiguration	loadConfiguration	The load configuration.

Returns

Type	Description
Task<IList<IMailTemplate>>	The mail template entities. Can contain null when a mail template was not found.

SendConfirmationEmailAsync(IEnumerable<Int64>)

Sends a registration confirmation e-mail to the specified users by id.

Declaration

Task SendConfirmationEmailAsync(IEnumerable<long> userIds)

Parameters

Type	Name	Description
IEnumerable<System.Int64>	userIds	Users that will receive the registration confirmation e-mail

Returns

Type	Description
Task

Remarks

This action requires the 'SendConfirmationEmail' privilege.

SendConfirmationEmailAsync(IEnumerable<String>)

Sends a registration confirmation e-mail to the specified users by username.

Declaration

Task SendConfirmationEmailAsync(IEnumerable<string> usernames)

Parameters

Type	Name	Description
IEnumerable<System.String>	usernames	Users that will receive the registration confirmation e-mail

Returns

Type	Description
Task

Remarks

This action requires the 'SendConfirmationEmail' privilege.

SendConfirmationEmailAsync(Int64)

Sends a registration confirmation e-mail to the specified user by id.

Declaration

Task SendConfirmationEmailAsync(long userId)

Parameters

Type	Name	Description
System.Int64	userId	User that will receive the registration confirmation e-mail

Returns

Type	Description
Task

Remarks

This action requires the 'SendConfirmationEmail' privilege.

SendConfirmationEmailAsync(Int64[])

Sends a registration confirmation e-mail to the specified users by id.

Declaration

Task SendConfirmationEmailAsync(params long[] userIds)

Parameters

Type	Name	Description
System.Int64[]	userIds	Users that will receive the registration confirmation e-mail

Returns

Type	Description
Task

Remarks

This action requires the 'SendConfirmationEmail' privilege.

SendConfirmationEmailAsync(String)

Sends a registration confirmation e-mail to the specified user by username.

Declaration

Task SendConfirmationEmailAsync(string username)

Parameters

Type	Name	Description
System.String	username	User that will receive the registration confirmation e-mail

Returns

Type	Description
Task

Remarks

This action requires the 'SendConfirmationEmail' privilege.

SendConfirmationEmailAsync(String[])

Sends a registration confirmation e-mail to the specified users by username.

Declaration

Task SendConfirmationEmailAsync(params string[] usernames)

Parameters

Type	Name	Description
System.String[]	usernames	Users that will receive the registration confirmation e-mail

Returns

Type	Description
Task

Remarks

This action requires the 'SendConfirmationEmail' privilege.

SendEmailNotificationAsync(MailRequestBroadcast)

Sends an e-mail to all users in M.

Declaration

Task SendEmailNotificationAsync(MailRequestBroadcast mailRequest)

Parameters

Type	Name	Description
MailRequestBroadcast	mailRequest	Mail request information.

Returns

Type	Description
Task

Exceptions

Type	Condition
ValidationException	When `mailRequest` has invalid properties.

SendEmailNotificationAsync(MailRequestById)

Sends an e-mail to users by user id.

Declaration

Task SendEmailNotificationAsync(MailRequestById mailRequest)

Parameters

Type	Name	Description
MailRequestById	mailRequest	Mail request information.

Returns

Type	Description
Task

Exceptions

Type	Condition
ValidationException	When `mailRequest` has invalid properties.

SendEmailNotificationAsync(MailRequestByUsername)

Sends an e-mail to users by username.

Declaration

Task SendEmailNotificationAsync(MailRequestByUsername mailRequest)

Parameters

Type	Name	Description
MailRequestByUsername	mailRequest	Mail request information.

Returns

Type	Description
Task

Exceptions

Type	Condition
ValidationException	When `mailRequest` has invalid properties.

SendRealTimeNotificationAsync(RealtimeRequestBroadcast)

Sends a real-time notification (browser notification) to all users in M.

Declaration

Task SendRealTimeNotificationAsync(RealtimeRequestBroadcast realtimeRequest)

Parameters

Type	Name	Description
RealtimeRequestBroadcast	realtimeRequest	Real-time request information.

Returns

Type	Description
Task

Exceptions

Type	Condition
ValidationException	When `realtimeRequest` has invalid properties.

SendRealTimeNotificationAsync(RealtimeRequestById)

Sends a real-time notification (browser notification) to users by user id.

Declaration

Task SendRealTimeNotificationAsync(RealtimeRequestById realtimeRequest)

Parameters

Type	Name	Description
RealtimeRequestById	realtimeRequest	Real-time request information.

Returns

Type	Description
Task

Exceptions

Type	Condition
ValidationException	When `realtimeRequest` has invalid properties.

SendRealTimeNotificationAsync(RealtimeRequestByUsername)

Sends a real-time notification (browser notification) to users by username.

Declaration

Task SendRealTimeNotificationAsync(RealtimeRequestByUsername realtimeRequest)

Parameters

Type	Name	Description
RealtimeRequestByUsername	realtimeRequest	Real-time request information.

Returns

Type	Description
Task

Exceptions

Type	Condition
ValidationException	When `realtimeRequest` has invalid properties.

Can we improve this article ? Provide feedback