Client Utility API Reference
Utilities provided by PGOS, we would be happy if they could save you time. These APIs are not the only specified functions that must be used, as you can also implement them yourself. These APIs do not require nor support authentication, so you can use them before calling 'LoginPGOS'.
API List
| API | Description |
|---|---|
| HttpDownloadFile | Download the specified URL to local file using the http protocol. |
API Details
HttpDownloadFile
Download the specified URL to local file using the http protocol.
/// <summary>Download the specified URL to local file using the http protocol.</summary>
/// <param name="url">The url to download.</param>
/// <param name="save_path">File path to write the data to. Pass in an ANSI-encoded path if the parameter type is not FString.</param>
/// <param name="progress_callback">Data transfer progress callback, which will be called in an ASYNCHRONOUS CHILD THREAD.</param>
public void HttpDownloadFile(string url, string save_path, OnHttpDownloadFilePro progress_callback, OnHttpDownloadFile callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| url | string | The url to download. |
| save_path | string | File path to write the data to. Pass in an ANSI-encoded path if the parameter type is not FString. |
| progress_callback | OnHttpDownloadFilePro | Data transfer progress callback, which will be called in an ASYNCHRONOUS CHILD THREAD. |
| callback | OnHttpDownloadFile |
Return: void
The id for the requested download task, zero if failed to create.
All Delegates
public delegate void OnHttpDownloadFile(PgosResult a0);
public delegate void OnHttpDownloadFilePro(HttpDownloadProgressInfo a0);
Type Reference: