jellyfin-sdk-swift/docs/EnvironmentAPI.md

EnvironmentAPI

All URIs are relative to http://localhost:8096

Method	HTTP request	Description
getDefaultDirectoryBrowser	GET /Environment/DefaultDirectoryBrowser	Get Default directory browser.
getDirectoryContents	GET /Environment/DirectoryContents	Gets the contents of a given directory in the file system.
getDrives	GET /Environment/Drives	Gets available drives from the server's file system.
getNetworkShares	GET /Environment/NetworkShares	Gets network paths.
getParentPath	GET /Environment/ParentPath	Gets the parent path of a given path.
validatePath	POST /Environment/ValidatePath	Validates path.

getDefaultDirectoryBrowser

    open class func getDefaultDirectoryBrowser(completion: @escaping (_ data: DefaultDirectoryBrowserInfoDto?, _ error: Error?) -> Void)

Get Default directory browser.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI


// Get Default directory browser.
EnvironmentAPI.getDefaultDirectoryBrowser() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

DefaultDirectoryBrowserInfoDto

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDirectoryContents

    open class func getDirectoryContents(path: String, includeFiles: Bool? = nil, includeDirectories: Bool? = nil, completion: @escaping (_ data: [FileSystemEntryInfo]?, _ error: Error?) -> Void)

Gets the contents of a given directory in the file system.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let path = "path_example" // String | The path.
let includeFiles = true // Bool | An optional filter to include or exclude files from the results. true/false. (optional) (default to false)
let includeDirectories = true // Bool | An optional filter to include or exclude folders from the results. true/false. (optional) (default to false)

// Gets the contents of a given directory in the file system.
EnvironmentAPI.getDirectoryContents(path: path, includeFiles: includeFiles, includeDirectories: includeDirectories) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
path	String	The path.
includeFiles	Bool	An optional filter to include or exclude files from the results. true/false.	[optional] [default to false]
includeDirectories	Bool	An optional filter to include or exclude folders from the results. true/false.	[optional] [default to false]

Return type

**[FileSystemEntryInfo]**

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDrives

    open class func getDrives(completion: @escaping (_ data: [FileSystemEntryInfo]?, _ error: Error?) -> Void)

Gets available drives from the server's file system.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI


// Gets available drives from the server's file system.
EnvironmentAPI.getDrives() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

**[FileSystemEntryInfo]**

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNetworkShares

    open class func getNetworkShares(completion: @escaping (_ data: [FileSystemEntryInfo]?, _ error: Error?) -> Void)

Gets network paths.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI


// Gets network paths.
EnvironmentAPI.getNetworkShares() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

**[FileSystemEntryInfo]**

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getParentPath

    open class func getParentPath(path: String, completion: @escaping (_ data: String?, _ error: Error?) -> Void)

Gets the parent path of a given path.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let path = "path_example" // String | The path.

// Gets the parent path of a given path.
EnvironmentAPI.getParentPath(path: path) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
path	String	The path.

Return type

String

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validatePath

    open class func validatePath(validatePathDto: ValidatePathDto, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Validates path.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let validatePathDto = ValidatePathDto(validateWritable: false, path: "path_example", isFile: false) // ValidatePathDto | Validate request object.

// Validates path.
EnvironmentAPI.validatePath(validatePathDto: validatePathDto) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
validatePathDto	ValidatePathDto	Validate request object.

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: application/json, text/json, application/_*+json
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]