程序包 ohos.miscservices.download

类 DownloadConfig.Builder

java.lang.Object

ohos.miscservices.download.DownloadConfig.Builder

封闭类:

DownloadConfig

public static class DownloadConfig.Builder
extends Object

Provides Builder objects of download configuration, including methods to set parameters used to create a download session.

从以下版本开始:

1

构造器概要

构造器

构造器	说明
Builder(Context context, Uri uri)	A constructor used to create a Builder instance for download session configuration.

方法概要

限定符和类型	方法	说明
DownloadConfig.Builder	addHttpheader(String header, String content)	Adds an HTTP or HTTPS header to be included with the download request.
DownloadConfig	build()	Creates a DownloadConfig object.
DownloadConfig.Builder	enableMetered(boolean flag)	Allows download under a metered connection.
DownloadConfig.Builder	enableRoaming(boolean flag)	Allows download in a roaming network.
DownloadConfig.Builder	setDescription(String description)	Sets the description of a download session.
DownloadConfig.Builder	setDownloadRange(int offset, int size)	Sets the start offset and size for the fragment download request.
DownloadConfig.Builder	setNetworkRestriction(int flag)	Sets the network type allowed for download.
DownloadConfig.Builder	setPath(String dir, String subPath)	Sets the path for downloads.
DownloadConfig.Builder	setTitle(String title)	Sets a download session title.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Builder

public Builder(Context context,
               Uri uri)

A constructor used to create a Builder instance for download session configuration.

参数:

context - Indicates the application context.

uri - Indicates an HTTP URI referenced to the file to be download.

抛出:

IllegalArgumentException - context is null, uri scheme is not http or https.

方法详细资料

setPath

public DownloadConfig.Builder setPath(String dir,
                                      String subPath)

Sets the path for downloads.

Downloaded files can be stored in an application directory or a public system directory.

参数:

dir - Indicates a path.

To download files to a system directory, use one defined in ohos.utils.Environment, for example, ohos.utils.Environment#DIRECTORY_DOWNLOAD, ohos.utils.Environment#DIRECTORY_MUSIC, and ohos.utils.Environment#DIRECTORY_PODCASTS.

To download files to an internal path of the application, set this parameter to null.

subPath - Indicates a subpath containing the name of the downloads.

返回:

Returns a Builder object.

抛出:

IllegalStateException - Throws this exception if the path is invalid.

NullPointerException - Throws this exception if subPath is null.

addHttpheader

public DownloadConfig.Builder addHttpheader(String header,
                                            String content)

Adds an HTTP or HTTPS header to be included with the download request.

The header will be added to the end of the list.

参数:

header - Indicates the HTTP header name.

content - Indicates the HTTP header value.

返回:

Returns a Builder object.

抛出:

NullPointerException - header is null.

IllegalArgumentException - http header may not contain ':'.

setTitle

public DownloadConfig.Builder setTitle(String title)

Sets a download session title.

If system download notifications are enabled for the application, the title will be displayed in the download session notification.

参数:

title - Indicates the download session title.

返回:

Returns a Builder object.

setDescription

public DownloadConfig.Builder setDescription(String description)

Sets the description of a download session.

If system download notifications are enabled for the application, the description will be displayed in the download session notification.

参数:

description - Indicates the description of the download session.

返回:

Returns a Builder object.

setNetworkRestriction

public DownloadConfig.Builder setNetworkRestriction(int flag)

Sets the network type allowed for download.

By default, both of the two network types are allowed.

参数:

flag - Indicates the network type, which can be a combination of bit flags for the cellular network and WLAN.

返回:

Returns a Builder object.

另请参阅:

DownloadConfig.NETWORK_MOBILE, DownloadConfig.NETWORK_WIFI

setDownloadRange

public DownloadConfig.Builder setDownloadRange(int offset,
                                               int size)

Sets the start offset and size for the fragment download request.

参数:

offset - Indicates the offset (bytes) from which the download starts. The default value is -1. A negative value means that the download starts from the file header.

size - Indicates the size of each fragment, in bytes. The default value is 0. Only a value greater than 0 takes effect, which indicates that the download ends at offset + size. If the sum exceeds the target file size or size is set to a negative value, the download ends where the file ends.

返回:

Returns a Builder object.

enableRoaming

public DownloadConfig.Builder enableRoaming(boolean flag)

Allows download in a roaming network. Download in a roaming network is allowed by default.

参数:

flag - Indicates whether download is allowed in a roaming network. Value true means it is allowed, and false means the opposite.

返回:

Returns a Builder object.

enableMetered

public DownloadConfig.Builder enableMetered(boolean flag)

Allows download under a metered connection. Download under a metered connection is allowed by default.

参数:

flag - Indicates whether to allow download when using a metered connection. Value true means this is allowed, and false means the opposite.

返回:

Returns a Builder object.

build

public DownloadConfig build()

Creates a DownloadConfig object.

返回:

Returns the created object.