gergely/matrix-glib-sdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Wrap long comment line in enum docs

Browse Source
This commit is contained in:
Gergely Polonkai 2016-03-08 12:53:20 +00:00
parent 69a8dc7954
commit 83d021dfbe
1 changed files with 51 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
src/matrix-enums.vala
View File

@ -114,9 +114,13 @@ namespace Matrix {
* Event format received when synchronizing. * Event format received when synchronizing.
*/ */
public enum EventFormat { public enum EventFormat {
DEFAULT, /// event format will be omitted from the filter, so the server will use its default (usually {{{FEDERATION}}}) DEFAULT, /// event format will be omitted from the filter,
CLIENT, /// return the events in a format suitable for clients /// so the server will use its default (usually
FEDERATION; /// return the raw event as receieved over federation /// {{{FEDERATION}}})
CLIENT, /// return the events in a format suitable for
/// clients
FEDERATION; /// return the raw event as receieved over
/// federation
} }
/** /**
@ -135,10 +139,24 @@ namespace Matrix {
* Condition types for pushers. * Condition types for pushers.
*/ */
public enum PusherConditionKind { public enum PusherConditionKind {
EVENT_MATCH, /// glob pattern match on a field of the event. Requires a {{{key}}} and a {{{pattern}}} parameter EVENT_MATCH, /// glob pattern match on a field of
PROFILE_TAG, /// matches the profile tag of the device that the notification would be delivered to. Requires a {{{profile_tag}}} parameter /// the event. Requires a {{{key}}} and
CONTAINS_DISPLAY_NAME, /// matches unencrypted messages where the content's body contains the owner's display name in that room. /// a {{{pattern}}} parameter
ROOM_MEMBER_COUNT; /// matches the current number of members in the room. Requires an {{{is}}} parameter, which must be an integer, optionally prefixed by {{==}}}, {{{<}}}, {{{>}}}, {{{<=}}} or {{{>=}}}. If the prefix is omitted, it defaults to {{{==}}} PROFILE_TAG, /// matches the profile tag of the
/// device that the notification would
/// be delivered to. Requires a
/// {{{profile_tag}}} parameter
CONTAINS_DISPLAY_NAME, /// matches unencrypted messages where
/// the content's body contains the
/// owner's display name in that room.
ROOM_MEMBER_COUNT; /// matches the current number of
/// members in the room. Requires an
/// {{{is}}} parameter, which must be
/// an integer, optionally prefixed by
/// {{==}}}, {{{<}}}, {{{>}}},
/// {{{<=}}} or {{{>=}}}. If the
/// prefix is omitted, it defaults to
/// {{{==}}}
} }
/** /**
@ -146,9 +164,15 @@ namespace Matrix {
*/ */
public enum PusherKind { public enum PusherKind {
OVERRIDE, /// highest priority rules OVERRIDE, /// highest priority rules
SENDER, /// for (unencrypted) messages that match certain patterns SENDER, /// for (unencrypted) messages that match certain
ROOM, /// for all messages for a given room. The rule ID of a room rule is always the ID of the room that it affects /// patterns
CONTENT, /// for messages from a specific Matrix user ID. The rule ID of such rules is always the Matrix ID of the user whose messages they'd apply to ROOM, /// for all messages for a given room. The rule ID
/// of a room rule is always the ID of the room
/// that it affects
CONTENT, /// for messages from a specific Matrix user
/// ID. The rule ID of such rules is always the
/// Matrix ID of the user whose messages they'd
/// apply to
UNDERRIDE; /// lowest priority rules UNDERRIDE; /// lowest priority rules
} }
@ -172,11 +196,21 @@ namespace Matrix {
* Room membership types. * Room membership types.
*/ */
public enum RoomMembership { public enum RoomMembership {
UNKNOWN, /// the membership sent by the server is unknown to this SDK UNKNOWN, /// the membership sent by the server is unknown to
INVITE, /// the user has been invited to join a room, but has not yet joined it. They may not participate in the room until they join /// this SDK
JOIN, /// the user has joined the room (possibly after accepting an invite), and may participate in it INVITE, /// the user has been invited to join a room, but has
LEAVE, /// the user was once joined to the room, but has since left (possibly by choice, or possibly by being kicked) /// not yet joined it. They may not participate in
BAN, /// the user has been banned from the room, and is no longer allowed to join it until they are un-banned from the room (by having their membership state set to a value other than {{{BAN}}}) /// the room until they join
JOIN, /// the user has joined the room (possibly after
/// accepting an invite), and may participate in it
LEAVE, /// the user was once joined to the room, but has
/// since left (possibly by choice, or possibly by
/// being kicked)
BAN, /// the user has been banned from the room, and is no
/// longer allowed to join it until they are
/// un-banned from the room (by having their
/// membership state set to a value other than
/// {{{BAN}}})
KNOCK; /// this is a reserved word, which currently has no meaning KNOCK; /// this is a reserved word, which currently has no meaning
} }
@ -186,7 +220,8 @@ namespace Matrix {
public enum RoomPreset { public enum RoomPreset {
NONE, /// no preset NONE, /// no preset
PRIVATE, /// preset for private rooms PRIVATE, /// preset for private rooms
TRUSTED_PRIVATE, /// same as private rooms, but all users get the same power level as the room creator TRUSTED_PRIVATE, /// same as private rooms, but all users get
/// the same power level as the room creator
PUBLIC; /// preset for public rooms PUBLIC; /// preset for public rooms
} }