|
|
| (2 intermediate revisions by 2 users not shown) |
| 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 '''-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
| |
| |
| |
| |-
| |
| |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]]
| |