Difference between revisions of "Extensions.Flash.GetListOfValidFlashSessions"

From emotive
Jump to navigation Jump to search
Line 3: Line 3:
 
{{ClassificationActivity | GetListOfValidFlashSessions | Returns a list of valid flash sessions | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash session related terms]] | - | - }}
 
{{ClassificationActivity | GetListOfValidFlashSessions | Returns a list of valid flash sessions | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash session related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
List<String> GetListOfValidFlashSessions(Audience audience, ComChannel comChannel, Direction direction);
+
ListTerm = Flash.GetListOfValidFlashSessions(Audience, ComChannelTerm, Direction);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 21: Line 21:
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
ComChannel myComCannel = GetComChannel("LL_AirbaUDS", "", false);
+
DiagCom.ComChannel ComChannel1;
List<String> result = GetListOfValidFlashSessions(myComCannel, @Audience:SUPPLIER, UPLOAD);
+
List<String> List1;
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
 +
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
 
</syntaxhighlight>
 
</syntaxhighlight>
 
 
== See also ==
 
== See also ==
 
[[GetFlashSession]] <br/>
 
[[GetFlashSession]] <br/>

Revision as of 10:29, 6 February 2015

Classification

Name GetListOfValidFlashSessions
Short Description Returns a list of valid flash sessions
Class Term
Extension OTX Flash extension
Group Flash session related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = Flash.GetListOfValidFlashSessions(Audience, ComChannelTerm, Direction);

Description

The GetListOfValidFlashSessions term is a list of strings to the valid FlashSessions identified.

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
List List of valid FlashSessions.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] Communication Channel.
Audience Audience Value @Audience:SUPPLIER [0..1] This optional attribute defines a filter to a special audience. Only Flash sessions with the specified audience will be returned. When the attribute is not set, no filtering is performed. Audiences = {SUPPLIER|DEVELOPMENT|MANUFACTURING|AFTER SALES|AFTERMARKET}.
Direction Direction Value UPLOAD [0..1] This attribute defines the type of Flash sessions is returned. Directions = {UPLOAD|DOWNLOAD}.

OTL Examples

DiagCom.ComChannel ComChannel1;
List<String> List1;

ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);

See also

GetFlashSession
GetSessionID
GetSessionPriority
GetNumberOfBlocks
IsDownloadSession
GetFlashKey