Bz eListServerUpdateEvent - Revision history

Zehra: redirect, since events are in official docs

2025-11-27T02:46:19Z

redirect, since events are in official docs

← Older revision		Revision as of 02:46, 27 November 2025
Line 1:		Line 1:
	~~{{BZFS_API_Doc}}~~		#REDIRECT [[Category:BZFS API Docs]]
	~~{{BZFS_API_Events}}~~

	~~==Overview==~~
	~~The '''bz_eListServerUpdateEvent''' is an API event called before the server adds itself to the list server.~~

	~~==Data==~~
	~~'''bz_eListServerUpdateEvent''' returns the '''bz_ListServerUpdateEvent_V1''' data class.~~

	~~{\| border="1" cellpadding="20" cellspacing="0"~~
	~~!name~~
	~~!type~~
	~~!value description~~
	\|-
	~~\|eventType~~
	~~\|[[Event(API)\|bz_eEventType]]~~
	~~\| bz_eListServerUpdateEvent~~
	\|-
	~~\|address~~
	~~\|[[bz_ApiString]]~~
	~~\|The public address of the server, as specified with the '''-publicaddr''' [[BZFS_Command_Line_Options \|command-line option]].~~
	\|-
	~~\|description~~
	~~\|[[bz_ApiString]]~~
	~~\|The public description of the server, as specified with the '''-publictitle''' [[BZFS_Command_Line_Options \|command-line option]].~~
	\|-
	~~\|groups~~
	~~\|[[bz_ApiString]]~~
	~~\|The groups the server will be advertised to, as specified with the '''-advertise''' [[BZFS_Command_Line_Options \|command-line option]].~~
	\|-
	~~\|handled~~
	~~\|bool~~
	~~\|Whether or not the plugin will be overriding the values~~
	\|-
	~~\|eventTime~~
	~~\|double~~
	~~\|The server time the event occurred (in seconds.)~~
	\|}

	~~==Uses==~~
	~~Allows the plugin to programmatically change the information sent to the list server; all fields (except the event type) are read/write.~~

	[[Category:~~BZFS_API_Docs]]~~
	~~[[Category:BZFS_API_Events~~]]

Allejo: Added info on handled bool

2013-12-23T01:12:01Z

Added info on handled bool

← Older revision		Revision as of 01:12, 23 December 2013
Line 31:		Line 31:
	\|handled		\|handled
	\|bool		\|bool
	\|		\|Whether or not the plugin will be overriding the values
	\|-		\|-
	\|eventTime		\|eventTime

Brad: /* Data */

2012-10-15T16:21:49Z

Data

← Older revision		Revision as of 16:21, 15 October 2012
Line 23:		Line 23:
	\|description		\|description
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|The public description of the server, as specified with the '''-~~public~~''' [[BZFS_Command_Line_Options \|command-line option]].		\|The public description of the server, as specified with the '''-publictitle''' [[BZFS_Command_Line_Options \|command-line option]].
	\|-		\|-
	\|groups		\|groups

Xalendare: /* Data */ Added eventTime field.

2009-05-08T02:50:27Z

Data: Added eventTime field.

← Older revision		Revision as of 02:50, 8 May 2009
Line 32:		Line 32:
	\|bool		\|bool
	\|		\|
			\|-
			\|eventTime
			\|double
			\|The server time the event occurred (in seconds.)
	\|}		\|}

Xalendare: Added documentation for event.

2009-05-08T02:39:54Z

Added documentation for event.

New page

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eListServerUpdateEvent''' is an API event called before the server adds itself to the list server.

==Data==
'''bz_eListServerUpdateEvent''' returns the '''bz_ListServerUpdateEvent_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
| bz_eListServerUpdateEvent
|-
|address
|[[bz_ApiString]]
|The public address of the server, as specified with the '''-publicaddr''' [[BZFS_Command_Line_Options |command-line option]].
|-
|description
|[[bz_ApiString]]
|The public description of the server, as specified with the '''-public''' [[BZFS_Command_Line_Options |command-line option]].
|-
|groups
|[[bz_ApiString]]
|The groups the server will be advertised to, as specified with the '''-advertise''' [[BZFS_Command_Line_Options |command-line option]].
|-
|handled
|bool
|
|}

==Uses==
Allows the plugin to programmatically change the information sent to the list server; all fields (except the event type) are read/write.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]