BlackBerry Dynamics for .NET Maui  12.0.0.9
Runtime library for .NET Maui applications
BBDXamarinForms.Common.Interfaces.SecureStorage.IBBDLocalFileSystem Interface Reference

An interface representing a BBD secure local file system. More...

Public Member Functions

string Combine (string path1, string path2)
 Combines two strings into a path. More...
 
Task< IBBDFileSystemBBDRequestFileSystemAsync (ulong requestedSize=0)
 Request a BBD secure file system in which to store application data. IBBDFileSystem class. More...
 
Task< IBBDFileEntryBBDResolveLocalFileSystemFileFromPathAsync (string path)
 Gets a BBD secure file entry for given path. IBBDFileEntry class. More...
 
Task< IBBDFileEntryBBDResolveLocalFileSystemFileFromFullPathAsync (string fullPath)
 Gets a BBD secure file entry for given full path. Example of full path to exemplary file test.txt:

  • iOS: /var/mobile/Containers/Data/Application/251EACF8-49CF-401F-8D93-CB78A2A44B58/test.txt
  • Android: /test.txt

IBBDFileEntry class. More...

 
Task< IBBDDirectoryEntryBBDResolveLocalFileSystemDirectoryFromPathAsync (string path)
 Gets a BBD secure directory entry for given path. IBBDDirectoryEntry class. More...
 
Task< IBBDDirectoryEntryBBDResolveLocalFileSystemDirectoryFromFullPathAsync (string fullPath)
 Gets a BBD secure directory entry for given full path. Example of full path to exemplary directory test:

  • iOS: /var/mobile/Containers/Data/Application/251EACF8-49CF-401F-8D93-CB78A2A44B58/test
  • Android: /test

IBBDDirectoryEntry class. More...

 

Properties

char DirectorySeparatorChar [get]
 Gets the directory separator char. More...
 

Detailed Description

An interface representing a BBD secure local file system.

Member Function Documentation

◆ BBDRequestFileSystemAsync()

Task<IBBDFileSystem> BBDXamarinForms.Common.Interfaces.SecureStorage.IBBDLocalFileSystem.BBDRequestFileSystemAsync ( ulong  requestedSize = 0)

Request a BBD secure file system in which to store application data. IBBDFileSystem class.

Returns
Requested BBD secure file system.
Exceptions
Exceptions.BBDFileSystemExceptionThrown when can not perform request file system operation.
Parameters
requestedSizeRequested size indicates how much storage space, in bytes, the application expects.

◆ BBDResolveLocalFileSystemDirectoryFromFullPathAsync()

Task<IBBDDirectoryEntry> BBDXamarinForms.Common.Interfaces.SecureStorage.IBBDLocalFileSystem.BBDResolveLocalFileSystemDirectoryFromFullPathAsync ( string  fullPath)

Gets a BBD secure directory entry for given full path. Example of full path to exemplary directory test:

  • iOS: /var/mobile/Containers/Data/Application/251EACF8-49CF-401F-8D93-CB78A2A44B58/test
  • Android: /test

IBBDDirectoryEntry class.

Returns
A BBD secure directory entry for the given path.
Exceptions
Exceptions.BBDFileSystemExceptionThrown when can not resolve directory from local file system.
Parameters
fullPathThe full path to a BBD secure directory entry.

◆ BBDResolveLocalFileSystemDirectoryFromPathAsync()

Task<IBBDDirectoryEntry> BBDXamarinForms.Common.Interfaces.SecureStorage.IBBDLocalFileSystem.BBDResolveLocalFileSystemDirectoryFromPathAsync ( string  path)

Gets a BBD secure directory entry for given path. IBBDDirectoryEntry class.

Returns
A BBD secure directory entry for the given path.
Exceptions
Exceptions.BBDFileSystemExceptionThrown when can not resolve directory from local file system.
Parameters
pathThe path to a BBD secure directory entry.

◆ BBDResolveLocalFileSystemFileFromFullPathAsync()

Task<IBBDFileEntry> BBDXamarinForms.Common.Interfaces.SecureStorage.IBBDLocalFileSystem.BBDResolveLocalFileSystemFileFromFullPathAsync ( string  fullPath)

Gets a BBD secure file entry for given full path. Example of full path to exemplary file test.txt:

  • iOS: /var/mobile/Containers/Data/Application/251EACF8-49CF-401F-8D93-CB78A2A44B58/test.txt
  • Android: /test.txt

IBBDFileEntry class.

Returns
A BBD secure file entry for the given path.
Exceptions
Exceptions.BBDFileSystemExceptionThrown when can not resolve file from local file system.
Parameters
fullPathThe full path to a BBD secure file entry.

◆ BBDResolveLocalFileSystemFileFromPathAsync()

Task<IBBDFileEntry> BBDXamarinForms.Common.Interfaces.SecureStorage.IBBDLocalFileSystem.BBDResolveLocalFileSystemFileFromPathAsync ( string  path)

Gets a BBD secure file entry for given path. IBBDFileEntry class.

Returns
A BBD secure file entry for the given path.
Exceptions
Exceptions.BBDFileSystemExceptionThrown when can not resolve file from local file system.
Parameters
pathThe path to a BBD secure file entry.

◆ Combine()

string BBDXamarinForms.Common.Interfaces.SecureStorage.IBBDLocalFileSystem.Combine ( string  path1,
string  path2 
)

Combines two strings into a path.

Returns
The combined paths.
Parameters
path1Path1.
path2Path2.

Property Documentation

◆ DirectorySeparatorChar

char BBDXamarinForms.Common.Interfaces.SecureStorage.IBBDLocalFileSystem.DirectorySeparatorChar
get

Gets the directory separator char.

Provides a platform-specific character used to separate directory levels in a path string that reflects a hierarchical file system organization.