231 device documentation return value description

[zccafa3]

#231

[zccafa3]

Changes have not been built and integration tested.
Also I would have created some automated tests for the changes, but I am not familiar with java language, sorry.

[CoolCat467]

Seems simple enough, but wondering, what does removing the newline in FileImportExportCardItemDevice.java do?

[zccafa3]

@CoolCat467 nothing significant, just a bit of house-work.

import devices

d_bus = devices.bus()

d_tn = "file_import_export"

for line in str(d_bus.find(type_name=d_tn)).split("\n"):
    doc = ""
    for index, char in enumerate(line):
        if index > 0 and index % 80 == 0:
            doc += "\n"
        doc += char
    print(doc)

Returns the following;

beginExportFile(name: String): void
Begins exporting a file to external data storage. Requires calls to writeExportF
ile() to provide data of the exported file and a call to finishExportFile() to c
omplete the export.
This method may error if the device is currently exporting or importing.
  name  the name of the file being exported.
writeExportFile(data: byte[]): void
Appends more data to the currently being exported file.
This method may error if the device is not currently exporting or the export was
 interrupted.

  data  the contents of the file being exported.
finishExportFile(): void
Finishes an export. This will prompt present users to select an external file lo
cation for the file being exported. If multiple users are present, the file is p
rovided to all users.
This method may error if the device is not currently exporting or the export was
 interrupted.
requestImportFile(): boolean
beginImportFile(): ImportedFileInfo
Begins a file import operation. This will prompt present users to select an exte
rnally stored file for import. If multiple users are present, the first user to 
select a file will have their file uploaded. Use the readImportFile() method to 
read the contents of the file being imported.
This method may error if the device is currently exporting or importing.
readImportFile(): byte[]
Tries to read some data from a file being imported. Returns zero length data if 
no data is available yet. Returns null when no more data is available.
This method may error if the device is not currently importing or the import was
 interrupted.
reset(): void
Resets the device and cancels any currently running export or import operation.

That change simply removes the newline in the writeExportFile method, between the description and the parameterDescriptions.

[CoolCat467]

Ah ok