SocketFezMemberChangeData

struct SocketFezMemberChangeData : Content

Informs Fez WebSocket clients of a change in Fez membership.

If joined is FALSE, the user has left the fez. Although seamail sockets use the same endpoint (seamail threads are Fezzes internally), this mesage will never be sent to Seamail threads as membership is fixed at creation time.

Fez socket message handlers will receive this message as a JSON string when a user joins/leaves the fez, or is added/removed by the fez owner.

See:

  • WS /api/v3/fez/:fezID/socket
Show on GitHub

  • The user that joined/left.

    Declaration

    Swift

    var user: UserHeader
    Show on GitHub

  • TRUE if this is a join.

    Declaration

    Swift

    var joined: Bool
    Show on GitHub

  • HTML fragment for the action, using the Swiftarr Web UI’s front end. Fragment is built using the same semantic data available in the other fields in this struct. Please don’t try parsing this to gather data. This field is here so the Javascript can insert HTML that matches what the HTTP endpoints render.

    Declaration

    Swift

    var html: String?
    Show on GitHub