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

API: Presentation.GetPresentation

Scoped Name

APIServer.Presentation.GetPresentation

Interface

Field Variable ...as Description
PresentationSurrogate FetchKey Input The unique identification of the presentation. This specifies the presentation to retrieve information for.
PresentationSurrogate FetchedData Output The unique identification of the presentation.
PresentationSiteKey FetchedData Output The identification of the site the presentation belongs to.
TemplateSuffix FetchedData Output The suffix used to specify that the HTML templates are belonging to the presentation.
TemplateOverrideName FetchedData Output The template override name specified for the presentation.
PresentationName FetchedData Output The name of the presentation.
PresentationComment FetchedData Output Any comment specified for the presentation
ProcessSurrogate FetchedData Output The unique identification of the process that the presentation belongs to.
ProcessID FetchedData Output The program name of the ProcessEntryPoint used by the process that the presentation belongs to.
ProcessType FetchedData Output The type of the process that the presentation belongs to. The type can be either Business Process (literal value 4), Menu Loader (literal value 5), or Frameset Loader (literal value 6).
ProcessDescription FetchedData Output The description specified for the process that the presentation belongs to
ProcessComment FetchedData Output Any comments specified for the process that the presentation belongs to.
ProcessText FetchedData Output The name of the process that the presentation belongs to.

Description

This API can be used to retrieve data about any presentation by specifying a PresentationSurrogate (a unique identification of a Presentation). This API is mostly for future use as there are currently no available API's that return a presentation surrogate. If you want to retrieve information about the current presentation used by the session call the weebserver API GetCurrentPresentation.

Events

Universal events