You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

123 lines
3.4 KiB

  1. ---
  2. title: Constants
  3. ---
  4. ## Conversation
  5. ### Conversation types
  6. * `1` "One to one"
  7. * `2` Group
  8. * `3` Public
  9. * `4` Changelog
  10. ### Read-only states
  11. * `0` Read-write
  12. * `1` Read-only
  13. ### Listable scope
  14. * `0` Participants only
  15. * `1` Regular users only, excluding guest app users
  16. * `2` Everyone
  17. ### Webinar lobby states
  18. * `0` No lobby
  19. * `1` Lobby for non moderators
  20. ### SIP states
  21. * `0` Disabled
  22. * `1` Enabled (Each participant needs a unique PIN)
  23. * `2` Enabled without PIN (Only the conversation token is required)
  24. ## Participants
  25. ### Participant types
  26. * `1` Owner
  27. * `2` Moderator
  28. * `3` User
  29. * `4` Guest
  30. * `5` User following a public link
  31. * `6` Guest with moderator permissions
  32. ### Participant in-call flag
  33. * `0` Disconnected
  34. * `1` In-call
  35. * `2` Provides audio
  36. * `4` Provides video
  37. * `8` Uses SIP dial-in
  38. ### Participant notification levels
  39. * `0` Default (`1` for one-to-one conversations, `2` for other conversations)
  40. * `1` Always notify
  41. * `2` Notify on mention
  42. * `3` Never notify
  43. ### Participant call notification levels
  44. * `0` Off
  45. * `1` On (default)
  46. ### Participant read status privacy
  47. * `0` Read status is public
  48. * `1` Read status is private
  49. ### Attendee types
  50. * `users` - Logged-in users
  51. * `groups` - Groups
  52. * `circles` - [Circle from the Circles app](https://github.com/nextcloud/circles)
  53. * `guests` - Guest without a login
  54. * `emails` - A guest invited by email address
  55. ### Attendee permissions
  56. * `0` Default permissions (will pick the one from the next level of: user, call, conversation)
  57. * `1` Custom permissions (this is required to be able to remove all other permissions)
  58. * `2` Start call
  59. * `4` Join call
  60. * `8` Can ignore lobby
  61. * `16` Can publish audio stream
  62. * `32` Can publish video stream
  63. * `64` Can publish screen sharing stream
  64. * `128` Can post chat message, share items and do reactions
  65. ### Attendee permission modifications
  66. * `set` - Setting this permission set.
  67. * `add` - Add the given flags to the permissions.
  68. * `remove` - Remove the given flags from the permissions.
  69. ### Actor types of chat messages
  70. * `users` - Logged-in users
  71. * `guests` - Guest users (attendee type `guests` and `emails`)
  72. * `bots` - Used by commands (actor-id is the used `/command`) and the changelog conversation (actor-id is `changelog`)
  73. * `bridged` - Users whose messages are bridged in by the [Matterbridge integration](matterbridge.md)
  74. ## Call
  75. ### Start call
  76. * `0` - Everyone
  77. * `1` - Participants of the conversation with an account on the instance
  78. * `2` - Moderators
  79. * `3` - No one
  80. ## Chat
  81. ### Shared item types
  82. * `audio` - Shared audio file
  83. * `deckcard` - Shared deck card
  84. * `file` - Shared files not falling into any other category
  85. * `location` - Shared geo location
  86. * `media` - Shared files with mimetype starting with image or video
  87. * `other` - Shared objects not falling into any other category
  88. * `voice` - Voice messages
  89. ## Poll
  90. ### Poll status
  91. * `0` - Open: Participants can cast votes
  92. * `1` - Closed: Participants can no longer cast votes and the result is displayed
  93. ### Poll mode
  94. * `0` - Public: Participants can see the result immediately and also who voted for which option
  95. * `1` - Hidden: The result is hidden until the poll is closed and then only the number of votes for each option are displayed
  96. ## Signaling modes
  97. * `internal` - No external signaling server is used
  98. * `external` - A single external signaling server is used
  99. * `conversation_cluster` - An external signaling server is assigned per conversation.