OpenTestSystem.Otx.Extensions.Flash.Terms.GetListOfValidFlashSessions Class Reference

Get list of valid FlashSessions More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.Flash.Terms.GetListOfValidFlashSessions:

Public Attributes
AudienceTerm	audience
	This optional attribute defines a filter to a special audience. Only Flash sessions with the specified audience will be returned More...
ComChannelTerm	comChannel
	Comprises the handle of the communication channel (LogicalLink). More...
Directions	direction
	Defines which kind of FlashSessions shall be returned. More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Terms.Term
MetaData	metaData
	Store additional More...

Detailed Description

Get list of valid FlashSessions

The GetListOfValidFlashSessions term returns an otx:List of otx:String items which identify the FlashSessions that are valid. The validity of a FlashSession be defined by rules which exist in the respective technological environment.

Note

Important: GetListOfValidFlashSessions will return the flash sessions in the order of their session priority. The highest-ranking FlashSession will be the first item in the resulting List whereas the lowest-ranking will be the last. For equally-ranked FlashSessions the order is unspecified.

Syntax

ListTerm = Flash.GetListOfValidFlashSessions(ComChannelTerm comChannel, AudienceTerm audience, Directions direction);

Examples

// Local Declarations
DiagCom.ComChannel ComChannel1;
List<String> List1;
 
// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);

Member Data Documentation

audience

AudienceTerm OpenTestSystem.Otx.Extensions.Flash.Terms.GetListOfValidFlashSessions.audience

This optional attribute defines a filter to a special audience. Only Flash sessions with the specified audience will be returned

comChannel

ComChannelTerm OpenTestSystem.Otx.Extensions.Flash.Terms.GetListOfValidFlashSessions.comChannel

Comprises the handle of the communication channel (LogicalLink).

direction

Directions OpenTestSystem.Otx.Extensions.Flash.Terms.GetListOfValidFlashSessions.direction

Defines which kind of FlashSessions shall be returned.