Skip to content

Commit 63b3e4e

Browse files
committed
fix the new translations
1 parent c99f469 commit 63b3e4e

File tree

154 files changed

+14868
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+14868
-0
lines changed

i18n/de/docusaurus-plugin-content-docs/current/reference/cpp/api.md

+428
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Class ChecksumFailedException
3+
sidebar_label: ChecksumFailedException
4+
description: "Represents an error that occurs when a package does not match it's expected SHA checksum"
5+
---
6+
# Class ChecksumFailedException
7+
Represents an error that occurs when a package does not match it's expected SHA checksum
8+
9+
###### **Assembly**: Velopack.dll
10+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Compression/ChecksumFailedException.cs#L9)
11+
```csharp title="Declaration"
12+
public class ChecksumFailedException : Exception, ISerializable, _Exception
13+
```
14+
**Inheritance:** `System.Object` -> `System.Exception`
15+
16+
**Implements:**
17+
`System.Runtime.Serialization.ISerializable`, `System.Runtime.InteropServices._Exception`
18+
19+
## Properties
20+
### FilePath
21+
The filename of the package which failed validation
22+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Compression/ChecksumFailedException.cs#L15)
23+
```csharp title="Declaration"
24+
public string FilePath { get; }
25+
```
26+
27+
## Implements
28+
29+
* `System.Runtime.Serialization.ISerializable`
30+
* `System.Runtime.InteropServices._Exception`
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Namespace Velopack.Compression
3+
sidebar_label: Velopack.Compression
4+
---
5+
# Namespace Velopack.Compression
6+
## Classes
7+
### [ChecksumFailedException](../Velopack.Compression/ChecksumFailedException)
8+
Represents an error that occurs when a package does not match it's expected SHA checksum
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: Interface IVelopackLocator
3+
sidebar_label: IVelopackLocator
4+
description: "An interface describing where Velopack can find key folders and files."
5+
---
6+
# Interface IVelopackLocator
7+
An interface describing where Velopack can find key folders and files.
8+
9+
###### **Assembly**: Velopack.dll
10+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L10)
11+
```csharp title="Declaration"
12+
public interface IVelopackLocator
13+
```
14+
## Properties
15+
### AppId
16+
The unique application Id. This is used in various app paths.
17+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L13)
18+
```csharp title="Declaration"
19+
string? AppId { get; }
20+
```
21+
### RootAppDir
22+
The root directory of the application. On Windows, this folder contains all
23+
the application files, but that may not be the case on other operating systems.
24+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L19)
25+
```csharp title="Declaration"
26+
string? RootAppDir { get; }
27+
```
28+
### PackagesDir
29+
The directory in which nupkg files are stored for this application.
30+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L22)
31+
```csharp title="Declaration"
32+
string? PackagesDir { get; }
33+
```
34+
### AppContentDir
35+
The directory in which versioned application files are stored.
36+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L25)
37+
```csharp title="Declaration"
38+
string? AppContentDir { get; }
39+
```
40+
### AppTempDir
41+
The temporary directory for this application.
42+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L28)
43+
```csharp title="Declaration"
44+
string? AppTempDir { get; }
45+
```
46+
### UpdateExePath
47+
The path to the current Update.exe or similar on other operating systems.
48+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L31)
49+
```csharp title="Declaration"
50+
string? UpdateExePath { get; }
51+
```
52+
### CurrentlyInstalledVersion
53+
The currently installed version of the application, or null if the app is not installed.
54+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L34)
55+
```csharp title="Declaration"
56+
SemanticVersion? CurrentlyInstalledVersion { get; }
57+
```
58+
### ThisExeRelativePath
59+
The path from [Velopack.Locators.IVelopackLocator.AppContentDir](../Velopack.Locators/IVelopackLocator#appcontentdir) to this executable.
60+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L37)
61+
```csharp title="Declaration"
62+
string? ThisExeRelativePath { get; }
63+
```
64+
### Channel
65+
The release channel this package was built for.
66+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L40)
67+
```csharp title="Declaration"
68+
string? Channel { get; }
69+
```
70+
## Methods
71+
### GetLocalPackages()
72+
Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects.
73+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L45)
74+
```csharp title="Declaration"
75+
List<VelopackAsset> GetLocalPackages()
76+
```
77+
78+
##### Returns
79+
80+
`System.Collections.Generic.List<Velopack.VelopackAsset>`
81+
### GetLatestLocalFullPackage()
82+
Finds latest .nupkg file in the PackagesDir or null if not found.
83+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L50)
84+
```csharp title="Declaration"
85+
VelopackAsset? GetLatestLocalFullPackage()
86+
```
87+
88+
##### Returns
89+
90+
[Velopack.VelopackAsset](../Velopack/VelopackAsset)
91+
### GetOrCreateStagedUserId()
92+
Unique identifier for this user which is used to calculate whether this user is eligible for
93+
staged roll outs.
94+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L56)
95+
```csharp title="Declaration"
96+
Guid? GetOrCreateStagedUserId()
97+
```
98+
99+
##### Returns
100+
101+
`System.Nullable<System.Guid>`
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: Class LinuxVelopackLocator
3+
sidebar_label: LinuxVelopackLocator
4+
description: "The default for OSX. All application files will remain in the '.app'.
5+
All additional files (log, etc) will be placed in a temporary directory."
6+
---
7+
# Class LinuxVelopackLocator
8+
The default for OSX. All application files will remain in the '.app'.
9+
All additional files (log, etc) will be placed in a temporary directory.
10+
11+
###### **Assembly**: Velopack.dll
12+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L14)
13+
```csharp title="Declaration"
14+
public class LinuxVelopackLocator : VelopackLocator, IVelopackLocator
15+
```
16+
**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator)
17+
18+
**Implements:**
19+
[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator)
20+
21+
## Properties
22+
### AppId
23+
The unique application Id. This is used in various app paths.
24+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L18)
25+
```csharp title="Declaration"
26+
public override string? AppId { get; }
27+
```
28+
### RootAppDir
29+
The root directory of the application. On Windows, this folder contains all
30+
the application files, but that may not be the case on other operating systems.
31+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L21)
32+
```csharp title="Declaration"
33+
public override string? RootAppDir { get; }
34+
```
35+
### UpdateExePath
36+
The path to the current Update.exe or similar on other operating systems.
37+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L24)
38+
```csharp title="Declaration"
39+
public override string? UpdateExePath { get; }
40+
```
41+
### CurrentlyInstalledVersion
42+
The currently installed version of the application, or null if the app is not installed.
43+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L27)
44+
```csharp title="Declaration"
45+
public override SemanticVersion? CurrentlyInstalledVersion { get; }
46+
```
47+
### AppContentDir
48+
The directory in which versioned application files are stored.
49+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L30)
50+
```csharp title="Declaration"
51+
public override string? AppContentDir { get; }
52+
```
53+
### Channel
54+
The release channel this package was built for.
55+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L33)
56+
```csharp title="Declaration"
57+
public override string? Channel { get; }
58+
```
59+
### AppTempDir
60+
The temporary directory for this application.
61+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L36)
62+
```csharp title="Declaration"
63+
public override string? AppTempDir { get; }
64+
```
65+
### PackagesDir
66+
The directory in which nupkg files are stored for this application.
67+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L39)
68+
```csharp title="Declaration"
69+
public override string? PackagesDir { get; }
70+
```
71+
### PersistentTempDir
72+
/var/tmp/{velopack}/{appid}, for storing app specific files which need to be preserved.
73+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L42)
74+
```csharp title="Declaration"
75+
public string? PersistentTempDir { get; }
76+
```
77+
### PersistentVelopackDir
78+
A pointer to /var/tmp/{velopack}, a location on linux which is semi-persistent.
79+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L45)
80+
```csharp title="Declaration"
81+
public string? PersistentVelopackDir { get; }
82+
```
83+
### AppImagePath
84+
File path of the .AppImage which mounted and ran this application.
85+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L48)
86+
```csharp title="Declaration"
87+
public string? AppImagePath { get; }
88+
```
89+
90+
## Implements
91+
92+
* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Class OsxVelopackLocator
3+
sidebar_label: OsxVelopackLocator
4+
description: "The default for OSX. All application files will remain in the '.app'.
5+
All additional files (log, etc) will be placed in a temporary directory."
6+
---
7+
# Class OsxVelopackLocator
8+
The default for OSX. All application files will remain in the '.app'.
9+
All additional files (log, etc) will be placed in a temporary directory.
10+
11+
###### **Assembly**: Velopack.dll
12+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L14)
13+
```csharp title="Declaration"
14+
public class OsxVelopackLocator : VelopackLocator, IVelopackLocator
15+
```
16+
**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator)
17+
18+
**Implements:**
19+
[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator)
20+
21+
## Properties
22+
### AppId
23+
The unique application Id. This is used in various app paths.
24+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L18)
25+
```csharp title="Declaration"
26+
public override string? AppId { get; }
27+
```
28+
### RootAppDir
29+
The root directory of the application. On Windows, this folder contains all
30+
the application files, but that may not be the case on other operating systems.
31+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L21)
32+
```csharp title="Declaration"
33+
public override string? RootAppDir { get; }
34+
```
35+
### UpdateExePath
36+
The path to the current Update.exe or similar on other operating systems.
37+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L24)
38+
```csharp title="Declaration"
39+
public override string? UpdateExePath { get; }
40+
```
41+
### CurrentlyInstalledVersion
42+
The currently installed version of the application, or null if the app is not installed.
43+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L27)
44+
```csharp title="Declaration"
45+
public override SemanticVersion? CurrentlyInstalledVersion { get; }
46+
```
47+
### AppContentDir
48+
The directory in which versioned application files are stored.
49+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L30)
50+
```csharp title="Declaration"
51+
public override string? AppContentDir { get; }
52+
```
53+
### AppTempDir
54+
The temporary directory for this application.
55+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L33)
56+
```csharp title="Declaration"
57+
public override string? AppTempDir { get; }
58+
```
59+
### PackagesDir
60+
The directory in which nupkg files are stored for this application.
61+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L36)
62+
```csharp title="Declaration"
63+
public override string? PackagesDir { get; }
64+
```
65+
### Channel
66+
The release channel this package was built for.
67+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L39)
68+
```csharp title="Declaration"
69+
public override string? Channel { get; }
70+
```
71+
72+
## Implements
73+
74+
* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: Class TestVelopackLocator
3+
sidebar_label: TestVelopackLocator
4+
description: "Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that
5+
your application is able to find and prepare updates from your chosen update source without actually
6+
having an installed application. This could be used in a CI/CD pipeline, or unit tests etc."
7+
---
8+
# Class TestVelopackLocator
9+
Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that
10+
your application is able to find and prepare updates from your chosen update source without actually
11+
having an installed application. This could be used in a CI/CD pipeline, or unit tests etc.
12+
13+
###### **Assembly**: Velopack.dll
14+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L13)
15+
```csharp title="Declaration"
16+
public class TestVelopackLocator : VelopackLocator, IVelopackLocator
17+
```
18+
**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator)
19+
20+
**Implements:**
21+
[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator)
22+
23+
## Properties
24+
### AppId
25+
The unique application Id. This is used in various app paths.
26+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L17)
27+
```csharp title="Declaration"
28+
public override string? AppId { get; }
29+
```
30+
### RootAppDir
31+
The root directory of the application. On Windows, this folder contains all
32+
the application files, but that may not be the case on other operating systems.
33+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L27)
34+
```csharp title="Declaration"
35+
public override string? RootAppDir { get; }
36+
```
37+
### PackagesDir
38+
The directory in which nupkg files are stored for this application.
39+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L37)
40+
```csharp title="Declaration"
41+
public override string? PackagesDir { get; }
42+
```
43+
### UpdateExePath
44+
The path to the current Update.exe or similar on other operating systems.
45+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L47)
46+
```csharp title="Declaration"
47+
public override string? UpdateExePath { get; }
48+
```
49+
### CurrentlyInstalledVersion
50+
The currently installed version of the application, or null if the app is not installed.
51+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L57)
52+
```csharp title="Declaration"
53+
public override SemanticVersion? CurrentlyInstalledVersion { get; }
54+
```
55+
### AppContentDir
56+
The directory in which versioned application files are stored.
57+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L67)
58+
```csharp title="Declaration"
59+
public override string? AppContentDir { get; }
60+
```
61+
### Channel
62+
The release channel this package was built for.
63+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L77)
64+
```csharp title="Declaration"
65+
public override string? Channel { get; }
66+
```
67+
## Methods
68+
### GetLatestLocalFullPackage()
69+
Finds latest .nupkg file in the PackagesDir or null if not found.
70+
###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L84)
71+
```csharp title="Declaration"
72+
public override VelopackAsset? GetLatestLocalFullPackage()
73+
```
74+
75+
##### Returns
76+
77+
[Velopack.VelopackAsset](../Velopack/VelopackAsset)
78+
79+
## Implements
80+
81+
* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator)

0 commit comments

Comments
 (0)