diff options
Diffstat (limited to 'SmartDeviceLink/SDLFile.h')
| -rw-r--r-- | SmartDeviceLink/SDLFile.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/SmartDeviceLink/SDLFile.h b/SmartDeviceLink/SDLFile.h index c78296c13..f8162ac0a 100644 --- a/SmartDeviceLink/SDLFile.h +++ b/SmartDeviceLink/SDLFile.h @@ -85,7 +85,7 @@ NS_ASSUME_NONNULL_BEGIN * @warning If this is not a readable file, this will return nil * * @param url The url to the file on disk that will be uploaded - * @param name The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote filesystem limitations. + * @param name The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations. * * @return An instance of this class, or nil if a readable file at the url could not be found. */ @@ -95,7 +95,7 @@ NS_ASSUME_NONNULL_BEGIN * Create an SDL file using raw data. It is strongly preferred to pass a file URL instead of data, as it is currently held in memory until the file is sent. * * @param data The raw data to be used for the file - * @param name The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote filesystem limitations. + * @param name The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations. * @param extension The file extension. For example "png". Currently supported file extensions are: "bmp", "jpg", "jpeg", "png", "wav", "mp3", "aac", "json". All others will be sent as binary files. * @param persistent Whether or not the remote file with this data should be persistent * @@ -109,7 +109,7 @@ NS_ASSUME_NONNULL_BEGIN * This is a persistent file, it will be persisted through sessions / ignition cycles. You will only have a limited space for all files, so be sure to only persist files that are required for all or most sessions. For example, menu artwork should be persistent. * * @param data The raw data to be used for the file - * @param name The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote filesystem limitations. + * @param name The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations. * @param extension The file extension. For example "png". Currently supported file extensions are: "bmp", "jpg", "jpeg", "png", "wav", "mp3", "aac", "json". All others will be sent as binary files. * * @return An instance of this class @@ -122,7 +122,7 @@ NS_ASSUME_NONNULL_BEGIN * This is an ephemeral file, it will not be persisted through sessions / ignition cycles. Any files that you do not *know* you will use in future sessions should be created through this method. For example, album / artist artwork should be ephemeral. * * @param data The raw data to be used for the file - * @param name The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote filesystem limitations. + * @param name The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations. * @param extension The file extension. For example "png". Currently supported file extensions are: "bmp", "jpg", "jpeg", "png", "wav", "mp3", "aac", "json". All others will be sent as binary files. * * @return An instance of this class |