Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: Callback.GetCallbackPoint

Scoped Name

APIServer.Callback.GetCallbackPoint

Interface

Field Variable ...as Description
CallbackPointID Input Input The unique identification of the callback point.

Mandatory.

CallbackPointID Output Output The unique identification of the callback point.
CallbackPointName Output Output The name of the callback point. This is the name shown in lists/dropdowns etc.
CallbackPointLocalGlobal Output Output Specifies whether the callback point is local or global. For local callback points, you add functions for each site, while any functions added to a global callback point will be used no matter which site is being accessed.
CallbackPointURLForHelp Output Output By specifying a URL for e.g. a static HTML page, you can provide an explanation of the callback point, how it is used - what the interface of the callback functions must be etc.

This URL will be available as a link on the page showing the callback point in the administration interface.

CallbackPointComment Output Output Any comment/explanation/textual description you want to provide for the callback point.
CallbackPointType Output Output Specifies whether the callback point is a system callback point (used by the WebsydianExpress runtime) or a user defined callback point.
CachingEnabled Output Output A yes/no field specifying whether the functions for the callback point should be cached.

For future use - the caching is currently not implemented.

Location Output Output Specifies whether the function is placed on the webserver or on the database server.

Description

The API retrieves information about the specified callback point.

Events

Universal events