TsgcWSPServer_Presence › Events

TsgcWSPServer_Presence Events

Events you can handle, grouped by purpose, followed by the full alphabetical list.

Lifecycle

Name	Description
OnConnect	Fired when a client completes the WebSocket handshake for the Presence protocol.
OnDisconnect	Fired when a client disconnects from the Presence protocol.
OnError	Fired when a transport-level error is reported for a connection.
OnException	Fired when an unhandled exception is caught while processing a Presence message.
OnRawMessage	Fired for every raw frame received before the Presence protocol parses it.

Members

Name	Description
OnBeforeNewMember	Fired before a client joins as a Presence member; set Accept to False to reject.
OnNewMember	Fired after a new member has been accepted and added to the member list.
OnRemoveMember	Fired when a member disconnects or is removed from the Presence protocol.
OnBeforeNewChannelMember	Fired before a member is added to an existing channel; set Accept to False to refuse.
OnNewChannelMember	Fired after a member has successfully joined a channel.
OnRemoveChannelMember	Fired when a member leaves a channel, whether by unsubscribing or disconnecting.
OnBeforeSendMembers	Fired before the channel member list is sent to a subscriber; set Accept to False to suppress it.
OnErrorMemberChannel	Fired when a member- or channel-related operation is rejected.

Channels

Name	Description
OnBeforeNewChannel	Fired before a new channel is created; set Accept to False to reject it.
OnNewChannel	Fired after a new channel has been accepted and registered.

Publishing

Name	Description
OnBeforePublishMsg	Fired before a client-published message is relayed; set Accept to False to drop it.
OnErrorPublishMsg	Fired when a publish request from a client is rejected.

All Events (alphabetical)

Name	Description
OnBeforeNewChannel	Fired before a new channel is created; set Accept to False to reject it.
OnBeforeNewChannelMember	Fired before a member is added to an existing channel; set Accept to False to refuse.
OnBeforeNewMember	Fired before a client joins as a Presence member; set Accept to False to reject.
OnBeforePublishMsg	Fired before a client-published message is relayed; set Accept to False to drop it.
OnBeforeSendMembers	Fired before the channel member list is sent to a subscriber; set Accept to False to suppress it.
OnConnect	Fired when a client completes the WebSocket handshake for the Presence protocol.
OnDisconnect	Fired when a client disconnects from the Presence protocol.
OnError	Fired when a transport-level error is reported for a connection.
OnErrorMemberChannel	Fired when a member- or channel-related operation is rejected.
OnErrorPublishMsg	Fired when a publish request from a client is rejected.
OnException	Fired when an unhandled exception is caught while processing a Presence message.
OnNewChannel	Fired after a new channel has been accepted and registered.
OnNewChannelMember	Fired after a member has successfully joined a channel.
OnNewMember	Fired after a new member has been accepted and added to the member list.
OnRawMessage	Fired for every raw frame received before the Presence protocol parses it.
OnRemoveChannelMember	Fired when a member leaves a channel, whether by unsubscribing or disconnecting.
OnRemoveMember	Fired when a member disconnects or is removed from the Presence protocol.