Extensions.Flash.IsDownloadSession

From emotive
Jump to navigation Jump to search

Classification

Name IsDownloadSession
Short Description Checks whether the flash session's direction is DOWNLOAD or not.
Class Term
Extension OTX Flash extension
Group Flash session related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm Flash.IsDownloadSession(FlashSessionTerm session);

Description

The IsDownloadSession term will return True if and only if the flash session's direction is DOWNLOAD. If the session's direction is UPLOAD, false will be returned.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Boolean Return true if the flash session's direction is DOWNLOAD, otherwise return false.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element will represent the FlashSession from which the direction will be determined.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
Boolean Boolean1 = false;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
Boolean1 = Flash.IsDownloadSession(FlashSession1);

See also

GetListOfValidFlashSessions
GetFlashSession
GetSessionID
GetFlashKey
GetSessionPriority
GetNumberOfBlocks
GetComChannel