Difference between revisions of "Extensions.Flash.GetListOfValidFlashSessions"
Jump to navigation
Jump to search
m (Hb moved page GetListOfValidFlashSessions to Extensions.Flash.GetListOfValidFlashSessions: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:Flash]] | + | {{DISPLAYTITLE: '''GetListOfValidFlashSessions'''}}[[Category:Flash]] |
== Classification == | == Classification == | ||
| − | {{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]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash session related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 11: | Line 11: | ||
The '''GetListOfValidFlashSessions''' term is a list of strings to the valid '''FlashSessions''' identified. | The '''GetListOfValidFlashSessions''' term is a list of strings to the valid '''FlashSessions''' identified. | ||
| − | {{TermReturnValue| [[List]] | List of valid FlashSessions.}} | + | {{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | List of valid FlashSessions.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [1] | Communication Channel.}} | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | Communication Channel.}} |
| − | {{TableRowPropertie2| Audience | [[Audience]] | [[Value]] | @Audience:SUPPLIER | [0..1] | <nowiki>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}.</nowiki>}} | + | {{TableRowPropertie2| Audience | [[Extensions.Flash.Audience|Audience]] | [[Value]] | @Audience:SUPPLIER | [0..1] | <nowiki>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}.</nowiki>}} |
{{TableRowPropertie1| Direction | [[Direction]] | [[Value]] | UPLOAD | [0..1] | <nowiki>This attribute defines the type of Flash sessions is returned. Directions = {UPLOAD|DOWNLOAD}.</nowiki>}} | {{TableRowPropertie1| Direction | [[Direction]] | [[Value]] | UPLOAD | [0..1] | <nowiki>This attribute defines the type of Flash sessions is returned. Directions = {UPLOAD|DOWNLOAD}.</nowiki>}} | ||
|} | |} | ||
| Line 30: | Line 30: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetFlashSession]] <br/> | + | [[Extensions.Flash.GetFlashSession|GetFlashSession]] <br/> |
| − | [[GetSessionID]] <br/> | + | [[Extensions.Flash.GetSessionID|GetSessionID]] <br/> |
| − | [[GetSessionPriority]] <br/> | + | [[Extensions.Flash.GetSessionPriority|GetSessionPriority]] <br/> |
| − | [[GetNumberOfBlocks]] <br/> | + | [[Extensions.Flash.GetNumberOfBlocks|GetNumberOfBlocks]] <br/> |
| − | [[IsDownloadSession]] <br/> | + | [[Extensions.Flash.IsDownloadSession|IsDownloadSession]] <br/> |
| − | [[GetFlashKey]] | + | [[Extensions.Flash.GetFlashKey|GetFlashKey]] |
Revision as of 07:31, 15 February 2016
Contents
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(Direction, ComChannelTerm, Audience);Description
The GetListOfValidFlashSessions term is a list of strings to the valid FlashSessions identified.
Return Value
The Term returns the value, see table below.
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
