# class KProtocolManager

###

Module | kio
Namespace |
Class | KProtocolManager
Inherits |

### enums

- ProxyAuthMode { Prompt, Automatic }
- ProxyType { NoProxy, ManualProxy, PACProxy, WPADProxy, EnvVarProxy }

enum details

### methods

- acceptLanguagesHeader ( )

  returns QString
  static

  Return Accept-Languages header built up according to user's desktop language settings. Returns Accept-Languages header string

- autoResume ( )

  returns bool
  static

  Returns true if partial downloads should be automatically resumed. Returns true to resume partial downloads

- badProxy (proxy)

  returns Nothing
  static

  Argument | Type | Default
  --- | --- | ---
  proxy | QString |

  Marks this proxy as bad (down). It will not be used for the next 30 minutes. (The script may supply an alternate proxy)

  proxy - the proxy to mark as bad (as URL)

- cacheControl ( )

  returns KIO.CacheControl
  static

  Returns the Cache control directive to be used. Returns the cache control value

- cacheDir ( )

  returns QString
  static

  The directory which contains the cache files. Returns the directory that contains the cache files

- canCopyFromFile (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can copy files/objects directly from the filesystem itself. If not, the application will read files from the filesystem using the file-protocol and pass the data on to the destination protocol.

  This corresponds to the "copyFromFile=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol can copy files from the local file system

- canCopyToFile (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can copy files/objects directly to the filesystem itself. If not, the application will receive the data from the source protocol and store it in the filesystem using the file-protocol.

  This corresponds to the "copyToFile=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol can copy files to the local file system

- canDeleteRecursive (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can recursively delete directories by itself. If not (the usual case) then KIO will list the directory and delete files and empty directories one by one.

  This corresponds to the "deleteRecursive=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol can delete non-empty directories by itself.

- canRenameFromFile (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can rename (i.e. move fast) files/objects directly from the filesystem itself. If not, the application will read files from the filesystem using the file-protocol and pass the data on to the destination protocol.

  This corresponds to the "renameFromFile=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol can rename/move files from the local file system

- canRenameToFile (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can rename (i.e. move fast) files/objects directly to the filesystem itself. If not, the application will receive the data from the source protocol and store it in the filesystem using the file-protocol.

  This corresponds to the "renameToFile=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol can rename files to the local file system

- connectTimeout ( )

  returns int
  static

  Returns the preferred timeout value for remote connections in seconds.

  Returns timeout value for remote connection in secs.

- defaultMimetype (url)

  returns QString
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns default mimetype for this URL based on the protocol.

  This corresponds to the "defaultMimetype=" field in the protocol description file.

  url - the url to check Returns the default mime type of the protocol, or null if unknown

- defaultUserAgent ( )

  returns QString
  static

  Returns the default user-agent string used for web browsing.

  Returns the default user-agent string

- defaultUserAgent (keys)

  returns QString
  static

  Argument | Type | Default
  --- | --- | ---
  keys | QString |

  Returns the default user-agent value used for web browsing, for example "Mozilla/5.0 (compatible; Konqueror/4.0; Linux; X11; i686; en_US) KHTML/4.0.1 (like Gecko)"

  keys - can be any of the following:

- 'o' Show OS
- 'v' Show OS Version
- 'p' Show platform (only for X11)
- 'm' Show machine architecture
- 'l' Show language
Returns the default user-agent value with the given keys

- fileNameUsedForCopying (url)

  returns KProtocolInfo.FileNameUsedForCopying
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  This setting defines the strategy to use for generating a filename, when copying a file or directory to another directory. By default the destination filename is made out of the filename in the source URL. However if the ioslave displays names that are different from the filename of the URL (e.g. kio_fonts shows Arial for arial.ttf, or kio_trash shows foo.txt and uses some internal URL), using Name means that the display name (UDS_NAME) will be used to as the filename in the destination directory.

  This corresponds to the "fileNameUsedForCopying=" field in the protocol description file. Valid values for this field are "Name" or "FromURL" (default).

  url - the url to check Returns how to generate the filename in the destination directory when copying/moving

- getSystemNameVersionAndMachine (systemName, systemVersion, machine)

  returns bool
  static
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  systemName | QString |
  systemVersion | QString |
  machine | QString |

- inputType (url)

  returns KProtocolInfo.Type
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol should be treated as a filesystem or as a stream when reading from it.

  This corresponds to the "input=" field in the protocol description file. Valid values for this field are "filesystem", "stream" or "none" (default).

  url - the url to check Returns the input type of the given url

- isSourceProtocol (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can act as a source protocol.

  A source protocol retrieves data from or stores data to the location specified by a URL. A source protocol is the opposite of a filter protocol.

  The "source=" field in the protocol description file determines whether a protocol is a source protocol or a filter protocol.

  url - the url to check Returns true if the protocol is a source of data (e.g. http), false if the protocol is a filter (e.g. gzip)

- listing (url)

  returns QStringList
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns the list of fields this protocol returns when listing The current possibilities are Name, Type, Size, Date, AccessDate, Access, Owner, Group, Link, URL, MimeType as well as Extra1, Extra2 etc. for extra fields (see extraFields).

  This corresponds to the "listing=" field in the protocol description file. The supported fields should be separated with ',' in the protocol description file.

  url - the url to check Returns a list of field names

- markPartial ( )

  returns bool
  static

  Returns true if partial downloads should be marked with a ".part" extension. Returns true if partial downloads should get an ".part" extension

- maxCacheAge ( )

  returns int
  static

  Returns the maximum age in seconds cached files should be kept before they are deleted as necessary.

  Returns the maximum cache age in seconds

- maxCacheSize ( )

  returns int
  static

  Returns the maximum size that can be used for caching.

  By default this function returns the DEFAULT_MAX_CACHE_SIZE value as defined in http_slave_defaults.h. Not that the value returned is in bytes, hence a value of 5120 would mean 5 Kb.

  Returns the maximum cache size in bytes

- minimumKeepSize ( )

  returns int
  static

  Returns the minimum file size for keeping aborted downloads.

  Any data downloaded that does not meet this minimum requirement will simply be discarded. The default size is 5 KB.

  Returns the minimum keep size for aborted downloads in bytes

- noProxyFor ( )

  returns QString
  static

  Returns the strings for hosts that should contacted DIRECTLY, bypassing any proxy settings. Returns a list of (comma-separated) hostnames or partial host names

- outputType (url)

  returns KProtocolInfo.Type
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol should be treated as a filesystem or as a stream when writing to it.

  This corresponds to the "output=" field in the protocol description file. Valid values for this field are "filesystem", "stream" or "none" (default).

  url - the url to check Returns the output type of the given url

- persistentConnections ( )

  returns bool
  static

  Returns true if connections should be persistent Returns true if the connections should be persistent

- persistentProxyConnection ( )

  returns bool
  static

  Returns true if proxy connections should be persistent. Returns true if proxy connections should be persistent

- protocolForArchiveMimetype (mimeType)

  returns QString
  static
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  mimeType | QString |

  Returns which protocol handles this mimetype, if it's an archive mimetype. For instance zip:/ handles application/x-zip.

  This is defined in the protocol description file using an entry like "archiveMimetype=application/x-zip"

  mimetype - the mimetype to check Returns the protocol that can handle this archive mimetype, for instance "zip". @since 4.1

- proxyAuthMode ( )

  returns KProtocolManager.ProxyAuthMode
  static

  Returns the way proxy authorization should be handled.

  Returns the proxy authorization mode

  See also ProxyAuthMode

- proxyConfigScript ( )

  returns QString
  static

  Returns the URL of the script for automatic proxy configuration. Returns the proxy configuration script

- proxyConnectTimeout ( )

  returns int
  static

  Returns the preferred timeout value for proxy connections in seconds.

  Returns timeout value for proxy connection in secs.

- proxyFor (protocol)

  returns QString
  static

  Argument | Type | Default
  --- | --- | ---
  protocol | QString |

  Returns the proxy server address for a given protocol.

  protocol - the protocol whose proxy info is needed Returns the proxy server address if one is available, or QString() if not available

- proxyForUrl (url)

  returns QString
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns the Proxy server address for a given URL If automatic proxy configuration is configured, KPAC is used to determine the proxy server, otherwise the return value of proxyFor for the URL's protocol is used. If an empty string is returned, the request is to be aborted, a return value of "DIRECT" requests a direct connection.

  url - the URL whose proxy info is needed Returns the proxy server address if one is available or QString() otherwise

- proxyType ( )

  returns KProtocolManager.ProxyType
  static

  Returns the type of proxy configuration that is used. Returns the proxy type

- readTimeout ( )

  returns int
  static

  Returns the preferred timeout value for reading from remote connections in seconds.

  Returns timeout value for remote connection in secs.

- reparseConfiguration ( )

  returns Nothing
  static

  Force a reload of the general config file of io-slaves ( kioslaverc).

- responseTimeout ( )

  returns int
  static

  Returns the preferred response timeout value for remote connecting in seconds.

  Returns timeout value for remote connection in seconds.

- slaveProtocol (url, proxy)

  returns QString
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |
  proxy | QString |

  Return the protocol to use in order to handle the given url It's usually the same, except that FTP, when handled by a proxy, needs an HTTP ioslave.

  When a proxy is to be used, proxy contains the URL for the proxy.

  url - the url to check

  proxy - the URL of the proxy to use Returns the slave protocol (e.g. 'http'), can be null if unknown

- supportsDeleting (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can delete files/objects.

  This corresponds to the "deleting=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol supports deleting

- supportsLinking (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can create links between files/objects.

  This corresponds to the "linking=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol supports linking

- supportsListing (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can list files/objects. If a protocol supports listing it can be browsed in e.g. file-dialogs and konqueror.

  Whether a protocol supports listing is determined by the "listing=" field in the protocol description file. If the protocol support listing it should list the fields it provides in this field. If the protocol does not support listing this field should remain empty (default.)

  url - the url to check Returns true if the protocol support listing

  See also listing()

- supportsMakeDir (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can create directories/folders.

  This corresponds to the "makedir=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol can create directories

- supportsMoving (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can move files/objects between different locations.

  This corresponds to the "moving=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol supports moving

- supportsOpening (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can be opened using KIO.open(const KUrl&).

  This corresponds to the "opening=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol supports opening

- supportsReading (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can retrieve data from URLs.

  This corresponds to the "reading=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if it is possible to read from the URL

- supportsWriting (url)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Returns whether the protocol can store data to URLs.

  This corresponds to the "writing=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

  url - the url to check Returns true if the protocol supports writing

- useCache ( )

  returns bool
  static

  Returns true/false to indicate whether a cache should be used

  Returns true to use the cache, false otherwisea

- useProxy ( )

  returns bool
  static

  Returns whether or not the user specified the use of proxy server to make connections. Returns true to use a proxy

- useReverseProxy ( )

  returns bool
  static

  Returns whether or not the the proxy server lookup should be reversed or not. Returns true to use a reversed proxy

- userAgentForApplication (appName, appVersion, extraInfo)

  returns QString
  static
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  appName | QString |
  appVersion | QString |
  extraInfo | QStringList | QStringList()

  Returns the application's user-agent string. Example string is "KMail/1.9.50 (Windows/6.0; KDE/3.97.1; i686; svn-762186; 2008-01-15)", where "KMail" is the appName parameter, "1.9.50" is the appVersion parameter, "Windows/6.0; KDE/3.97.1; i686" part is added automatically and "svn-762186; 2008-01-15" is provided by extraInfo list.

  appName - name of the application

  appVersion - name of the application

  extraInfo - a list of elements that will be appended to the string as extra information Returns the application's user-agent string

  @since 4.1

- userAgentForHost (hostname)

  returns QString
  static

  Argument | Type | Default
  --- | --- | ---
  hostname | QString |

  Returns the user-agent string configured for the specified host.

  If hostname is not found or is empty (i.e. "" or QString()) this function will return the default user agent.

  hostname - name of the host Returns specified user-agent string

### enums - detail

- ProxyAuthMode { Prompt, Automatic }

  Proxy authorization modes.

- Prompt - Ask for authorization as needed
- Automatic - Use auto login as defined in kionetrc files.

| Prompt | - | - |
| Automatic | - | - |

- ProxyType { NoProxy, ManualProxy, PACProxy, WPADProxy, EnvVarProxy }

  Types of proxy configuration

- NoProxy - No proxy is used
- ManualProxy - Proxies are manually configured
- PACProxy - A Proxy configuration URL has been given
- WPADProxy - A proxy should be automatically discovered
- EnvVarProxy - Use the proxy values set through environment variables.

| NoProxy | - | - |
| ManualProxy | - | - |
| PACProxy | - | - |
| WPADProxy | - | - |
| EnvVarProxy | - | - |