asdoc/org/apache/royale/storage/IPermanentStorage.js.json

{ "type": "interface",
  "qname": "org.apache.royale.storage.IPermanentStorage",
"baseInterfaceNames": [
"org.apache.royale.events.IEventDispatcher"]
,
    "description": "The IPermanentStorage interface provides the template for creating an interface to a device's native file system.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.0"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
    "qname": "readTextFromDataFile",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "A convenience function to read an entire file as a single string of text. The file is storaged in the application's data storage directory.",
    "tags": [
    {  "tagName": "param",
           "values": ["fileName The name of the file."]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "fileName", "type": "String"}]}
  ,
  { "type": "method",
    "qname": "writeTextToDataFile",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "A convenience function write a string into a file that resides in the application's data storage directory. If the file already exists it is replaced with the string.",
    "tags": [
    {  "tagName": "param",
           "values": ["fileName The name of file.", "text The string to be stored."]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "fileName", "type": "String"},
    { "name": "text", "type": "String"}]}
  ,
  { "type": "method",
    "qname": "openOutputDataStream",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Opens an output stream into a file in the data storage directory. A Ready event is dispatched when the stream has been opened. Use the stream to write data to the file.",
    "tags": [
    {  "tagName": "param",
           "values": ["fileName The name of file."]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "fileName", "type": "String"}]}
  ,
  { "type": "method",
    "qname": "openInputDataStream",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Opens an input stream into a file in the data storage directory. A Ready event is dispatched when the stream has been opened. Use the stream to read data from the file.",
    "tags": [
    {  "tagName": "param",
           "values": ["fileName The name of file."]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "fileName", "type": "String"}]}
  ]
  }