File tree Expand file tree Collapse file tree 3 files changed +457
-1
lines changed Expand file tree Collapse file tree 3 files changed +457
-1
lines changed Original file line number Diff line number Diff line change @@ -50,6 +50,12 @@ The SDK for the Findings service.
50
50
51
51
The SDK for metadata information about the plugin.
52
52
53
+ ##### projects
54
+
55
+ > ** projects** : [ ` ProjectsSDK ` ] ( index.md#projectssdk )
56
+
57
+ The SDK for the Projects service.
58
+
53
59
##### replay
54
60
55
61
> ** replay** : [ ` ReplaySDK ` ] ( index.md#replaysdk )
@@ -1757,6 +1763,81 @@ The name of the replay session.
1757
1763
1758
1764
` string `
1759
1765
1766
+ ## Projects
1767
+
1768
+ ### Project
1769
+
1770
+ > ** Project** : ` object `
1771
+
1772
+ A saved immutable Project.
1773
+
1774
+ #### Type declaration
1775
+
1776
+ ##### getId()
1777
+
1778
+ The unique Caido [ ID] ( index.md#id ) of the project.
1779
+
1780
+ ###### Returns
1781
+
1782
+ [ ` ID ` ] ( index.md#id )
1783
+
1784
+ ##### getName()
1785
+
1786
+ The name of the project.
1787
+
1788
+ ###### Returns
1789
+
1790
+ ` string `
1791
+
1792
+ ##### getStatus()
1793
+
1794
+ The status of the project.
1795
+
1796
+ ###### Returns
1797
+
1798
+ [ ` ProjectStatus ` ] ( index.md#projectstatus )
1799
+
1800
+ ##### getVersion()
1801
+
1802
+ The version of the project.
1803
+ The format is ` MAJOR.MINOR.PATCH ` .
1804
+
1805
+ ###### Returns
1806
+
1807
+ ` string `
1808
+
1809
+ ***
1810
+
1811
+ ### ProjectsSDK
1812
+
1813
+ > ** ProjectsSDK** : ` object `
1814
+
1815
+ The SDK for the Projects service.
1816
+
1817
+ #### Type declaration
1818
+
1819
+ ##### getCurrent()
1820
+
1821
+ Get the currently selected [ Project] ( index.md#project ) if any.
1822
+
1823
+ ###### Returns
1824
+
1825
+ ` Promise ` \< ` undefined ` \| [ ` Project ` ] ( index.md#project ) \>
1826
+
1827
+ ###### Example
1828
+
1829
+ ``` js
1830
+ await sdk .projects .getCurrent ();
1831
+ ```
1832
+
1833
+ ***
1834
+
1835
+ ### ProjectStatus
1836
+
1837
+ > ** ProjectStatus** : ` "ready" ` \| ` "restoring" ` \| ` "error" `
1838
+
1839
+ A [ Project] ( index.md#project ) status.
1840
+
1760
1841
## Shared
1761
1842
1762
1843
### Bytes
You can’t perform that action at this time.
0 commit comments