Skip to content

Commit 3d14835

Browse files
lipkaulipkau
authored
Merge pull request #107 from lipkau/enhance/DocsForClasses
Add documentation of ConfluencePS classes
2 parents 722f961 + cef310a commit 3d14835

7 files changed

+604
-0
lines changed

‎docs/classes/ConfluencePS.ContentLabelSet.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: documentation
3+
permalink: /docs/ConfluencePS/classes/ConfluencePS.ContentLabelSet/
4+
---
5+
6+
# ConfluencePS.ContentLabelSet
7+
8+
## SYNOPSIS
9+
Defines an object for ContentLabelSets in Confluence.
10+
11+
## SYNTAX
12+
13+
```powershell
14+
New-Object -TypeName ConfluencePS.ContentLabelSet [-Property @{}]
15+
16+
[ConfluencePS.ContentLabelSet]@{}
17+
```
18+
19+
## DESCRIPTION
20+
The `ContentLabelSet` is an object that describes the `Label`s that are assigned to a `Page`.
21+
22+
## REFERENCES
23+
_This class is not used by any other class._
24+
25+
## CONSTRUCTORS
26+
_This class does not have a constructor._
27+
28+
## PROPERTIES
29+
30+
### Page
31+
Contains the `Page` that is being described.
32+
33+
```yaml
34+
Type: ConfluencePS.Page
35+
Required: True
36+
Default value: None
37+
```
38+
39+
### Labels
40+
Contains a list of `Label`s that are assigned to the `Page`.
41+
42+
```yaml
43+
Type: ConfluencePS.Label
44+
Required: False
45+
Default value: None
46+
```
47+
48+
## METHODS
49+
50+
### ToString()
51+
_No behavior of casting to string is defined._

‎docs/classes/ConfluencePS.Icon.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
layout: documentation
3+
permalink: /docs/ConfluencePS/classes/ConfluencePS.Icon/
4+
---
5+
6+
# ConfluencePS.Icon
7+
8+
## SYNOPSIS
9+
Defines an object for Icons in Confluence.
10+
11+
## SYNTAX
12+
13+
```powershell
14+
New-Object -TypeName ConfluencePS.Icon [-Property @{}]
15+
16+
[ConfluencePS.Icon]@{}
17+
```
18+
19+
## DESCRIPTION
20+
The `Icon` is an object that describes images in Confluence.
21+
It is important to note, that the path to the resource is not absolute; but relative to the BaseUri of the Confluence server.
22+
23+
## REFERENCES
24+
The following classes use `Icon` for their properties:
25+
- [`ConfluencePS.User`](/docs/ConfluencePS/classes/ConfluencePS.User/)
26+
- [`ConfluencePS.Space`](/docs/ConfluencePS/classes/ConfluencePS.Space/)
27+
28+
## CONSTRUCTORS
29+
_This class does not have a constructor._
30+
31+
## PROPERTIES
32+
33+
### Path
34+
The Path describes the path to the `Icon` resource relative to the BaseUri.
35+
36+
```yaml
37+
Type: String
38+
Required: True
39+
Default value: None
40+
```
41+
42+
### Width
43+
The Width describes the width of the `Icon` resource in pixels.
44+
45+
```yaml
46+
Type: Int32
47+
Required: False
48+
Default value: None
49+
```
50+
51+
### Height
52+
The Height describes the height of the `Icon` resource in pixels.
53+
54+
```yaml
55+
Type: Int32
56+
Required: False
57+
Default value: None
58+
```
59+
60+
### IsDefault
61+
The IsDefault describes if the used `Icon` resource is the default icon from the server.
62+
63+
```yaml
64+
Type: Boolean
65+
Required: False
66+
Default value: False
67+
```
68+
69+
## METHODS
70+
71+
### ToString()
72+
The method for casting an object of this class to string is overwritten.
73+
74+
When cast to string, this will return the `Path` property's value.

‎docs/classes/ConfluencePS.Label.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
layout: documentation
3+
permalink: /docs/ConfluencePS/classes/ConfluencePS.Label/
4+
---
5+
6+
# ConfluencePS.Label
7+
8+
## SYNOPSIS
9+
Defines an object for Labels in Confluence.
10+
11+
## SYNTAX
12+
13+
```powershell
14+
New-Object -TypeName ConfluencePS.Label [-Property @{}]
15+
16+
[ConfluencePS.Label]@{}
17+
```
18+
19+
## DESCRIPTION
20+
**fix**The `Label` is an object that describes labels in Confluence.
21+
22+
## REFERENCES
23+
The following classes use `User` for their properties:
24+
- [`ConfluencePS.ContentLabelSet`](/docs/ConfluencePS/classes/ConfluencePS.ContentLabelSet/)
25+
26+
## CONSTRUCTORS
27+
_This class does not have a constructor._
28+
29+
## PROPERTIES
30+
31+
### Id
32+
The Id is the identifier of a `Label` used by the Confluence server internally.
33+
34+
_This value can't be changed and is assigned by the server._
35+
36+
```yaml
37+
Type: Int32
38+
Required: True
39+
Default value: None
40+
```
41+
42+
### Prefix
43+
_description missing_
44+
45+
```yaml
46+
Type: String
47+
Required: True
48+
Default value: global
49+
```
50+
51+
### Name
52+
The name of the `Label`.
53+
54+
```yaml
55+
Type: String
56+
Required: True
57+
Default value: None
58+
```
59+
60+
## METHODS
61+
62+
### ToString()
63+
The method for casting an object of this class to string is overwritten.
64+
65+
When cast to string, this will return the `Name` property's value.

‎docs/classes/ConfluencePS.Page.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
---
2+
layout: documentation
3+
permalink: /docs/ConfluencePS/classes/ConfluencePS.Page/
4+
---
5+
6+
# ConfluencePS.Page
7+
8+
## SYNOPSIS
9+
Defines an object for Pages in Confluence.
10+
11+
## SYNTAX
12+
13+
```powershell
14+
New-Object -TypeName ConfluencePS.Page [-Property @{}]
15+
16+
[ConfluencePS.Page]@{}
17+
```
18+
19+
## DESCRIPTION
20+
**fix**The `Page` is an object that describes pages in Confluence.
21+
22+
## REFERENCES
23+
The following classes use `Page` for their properties:
24+
- [`ConfluencePS.ContentLabelSet`](/docs/ConfluencePS/classes/ConfluencePS.ContentLabelSet/)
25+
- [`ConfluencePS.Page`](/docs/ConfluencePS/classes/ConfluencePS.Page/)
26+
- [`ConfluencePS.Space`](/docs/ConfluencePS/classes/ConfluencePS.Space/)
27+
28+
## CONSTRUCTORS
29+
_This class does not have a constructor._
30+
31+
## PROPERTIES
32+
33+
### Id
34+
The Id is the unique identifier of the `Page`.
35+
36+
_This value can't be changed and is assigned by the server._
37+
38+
```yaml
39+
Type: Int32
40+
Required: True
41+
Default value: None
42+
```
43+
44+
### Status
45+
The Status describes the current status of the `Page`.
46+
47+
Possible values are: `current`, `trashed` and `draft`.
48+
49+
```yaml
50+
Type: String
51+
Required: True
52+
Default value: current
53+
```
54+
55+
### Title
56+
The Name / Title of the `Page`.
57+
58+
```yaml
59+
Type: String
60+
Required: True
61+
Default value: None
62+
```
63+
64+
### Space
65+
The Space in which the `Page` is in.
66+
67+
```yaml
68+
Type: ConfluencePS.Space
69+
Required: True
70+
Default value: None
71+
```
72+
73+
### Version
74+
Contains the information about the latest version of the `Page`.
75+
76+
Values can be `global` or `personal`.
77+
78+
```yaml
79+
Type: ConfluencePS.Version
80+
Required: True
81+
Default value: None
82+
```
83+
84+
### Body
85+
The Content / Body of the `Page`.
86+
87+
_The content is in Confluence's stroage format, which must be a valid XHTML string._
88+
89+
```yaml
90+
Type: String
91+
Required: True
92+
Default value: null
93+
```
94+
95+
### Ancestors
96+
Contains the hierarchy of the `Page` in the navigation by describing it's ancestors / parent pages.
97+
98+
```yaml
99+
Type: ConfluencePS.Page
100+
Required: False
101+
Default value: None
102+
```
103+
104+
### URL
105+
Contains the URL under which the `Page` is accessible.
106+
107+
```yaml
108+
Type: String
109+
Required: True
110+
Default value: None
111+
```
112+
113+
### ShortURL
114+
Contains a shortened URL under which the `Page` is accessible.
115+
116+
```yaml
117+
Type: String
118+
Required: True
119+
Default value: None
120+
```
121+
122+
## METHODS
123+
124+
### ToString()
125+
The method for casting an object of this class to string is overwritten.
126+
127+
When cast to string, this will return `[$Id] $Title`.

0 commit comments

Comments
 (0)