Class FilePayload

Definition

Namespace:
Tizen.Applications.Cion
Assembly:
Tizen.Applications.Cion.dll

A class to represent file type payload.

public class FilePayload : Payload
Inheritance
object
Payload
FilePayload

Constructors

View Source

FilePayload(string)

The constructor of FilePayload class.

Declaration
public FilePayload(string path)
Parameters
Type Name Description
string path

The path of file for the FilePayload.
Remarks

http://tizen.org/privilege/mediastorage is needed if the file path is relevant to media storage. http://tizen.org/privilege/externalstorage is needed if the file path is relevant to external storage.

Exceptions
Type Condition
System.ArgumentException

Thrown when the input file path is invalid.
System.UnauthorizedAccessException

Thrown when an application does not have the privilege to access this method.

Properties

View Source

PayloadType

Gets type of the payload.

Declaration
public override PayloadType PayloadType { get; }
Property Value
Type Description
PayloadType
Overrides
View Source

ReceivedBytes

Gets size of received file.

Declaration
public ulong ReceivedBytes { get; }
Property Value
Type Description
ulong
View Source

ReceivedFileName

Gets the name of received file.

Declaration
public string ReceivedFileName { get; }
Property Value
Type Description
string
View Source

TotalBytes

Gets total size of the file.

Declaration
public ulong TotalBytes { get; }
Property Value
Type Description
ulong

Methods

View Source

SaveAsFile(string)

Saves file of payload to speicific path.

Declaration
public void SaveAsFile(string path)
Parameters
Type Name Description
string path

The path of file to save.
Remarks

http://tizen.org/privilege/mediastorage is needed if the file path is relevant to media storage. http://tizen.org/privilege/externalstorage is needed if the file path is relevant to external storage.

Exceptions
Type Condition
System.ArgumentException

Thrown when the input file path is invalid.
System.UnauthorizedAccessException

Thrown when an application does not have the privilege to access this method.