Skip to content

mattermostmodels NotifyProps

BigMakCode edited this page Aug 5, 2024 · 1 revision

NotifyProps Public class

Description

User notification properties.

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph Mattermost.Models
  Mattermost.Models.NotifyProps[[NotifyProps]]
  end
Loading

Members

Properties

Public properties

Type Name Methods
string Channel
Set to "true" to enable channel-wide notifications (@channel, @all, etc.), "false" to disable. Defaults to "true".
get, set
string Desktop
Set to "all" to receive desktop notifications for all activity, "mention" for mentions and direct messages only,
and "none" to disable. Defaults to "all".
get, set
string DesktopSound
Set to "true" to enable sound on desktop notifications, "false" to disable. Defaults to "true".
get, set
string Email
Set to "true" to enable email notifications, "false" to disable. Defaults to "true".
get, set
string FirstName
Set to "true" to enable mentions for first name. Defaults to "true" if a first name is set, "false" otherwise.
get, set
string MentionKeys
Set to "true" to enable mentions for mention keys. Defaults to "true" if a first name is set, "false" otherwise.
get, set
string Push
Set to "all" to receive push notifications for all activity, "mention" for mentions and direct messages only,
and "none" to disable. Defaults to "mention".
get, set

Details

Summary

User notification properties.

Constructors

NotifyProps

public NotifyProps()

Properties

Channel

public string Channel { get; set; }
Summary

Set to "true" to enable channel-wide notifications (@channel, @all, etc.), "false" to disable. Defaults to "true".

Desktop

public string Desktop { get; set; }
Summary

Set to "all" to receive desktop notifications for all activity, "mention" for mentions and direct messages only, and "none" to disable. Defaults to "all".

DesktopSound

public string DesktopSound { get; set; }
Summary

Set to "true" to enable sound on desktop notifications, "false" to disable. Defaults to "true".

Email

public string Email { get; set; }
Summary

Set to "true" to enable email notifications, "false" to disable. Defaults to "true".

FirstName

public string FirstName { get; set; }
Summary

Set to "true" to enable mentions for first name. Defaults to "true" if a first name is set, "false" otherwise.

MentionKeys

public string MentionKeys { get; set; }
Summary

Set to "true" to enable mentions for mention keys. Defaults to "true" if a first name is set, "false" otherwise.

Push

public string Push { get; set; }
Summary

Set to "all" to receive push notifications for all activity, "mention" for mentions and direct messages only, and "none" to disable. Defaults to "mention".

Generated with ModularDoc

Clone this wiki locally