@neuralinnovations/dataisland-sdk 0.0.1-dev6 → 0.0.1-dev8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/docs.yml +32 -0
- package/.github/workflows/format.yml +42 -0
- package/.github/workflows/publish-npm.yml +10 -5
- package/.github/workflows/tests.yml +34 -0
- package/.github/workflows/version.yml +40 -0
- package/LICENSE +201 -0
- package/README.md +33 -0
- package/docs/.nojekyll +1 -0
- package/docs/classes/BasicCredential.md +80 -0
- package/docs/classes/BearerCredential.md +72 -0
- package/docs/classes/Chat.md +69 -0
- package/docs/classes/Chats.md +90 -0
- package/docs/classes/CredentialBase.md +54 -0
- package/docs/classes/DataIslandApp.md +168 -0
- package/docs/classes/DebugCredential.md +72 -0
- package/docs/classes/DefaultCredential.md +56 -0
- package/docs/classes/DisposableContainer.md +177 -0
- package/docs/classes/EventDispatcher.md +109 -0
- package/docs/classes/File.md +79 -0
- package/docs/classes/Files.md +136 -0
- package/docs/classes/FilesPage.md +76 -0
- package/docs/classes/Group.md +191 -0
- package/docs/classes/Groups.md +130 -0
- package/docs/classes/Lifetime.md +108 -0
- package/docs/classes/Organization.md +89 -0
- package/docs/classes/Organizations.md +195 -0
- package/docs/classes/UserProfile.md +156 -0
- package/docs/classes/Workspace.md +165 -0
- package/docs/classes/Workspaces.md +189 -0
- package/docs/enums/ChatAnswer.md +22 -0
- package/docs/enums/ChatsEvent.md +22 -0
- package/docs/enums/FilesEvent.md +24 -0
- package/docs/enums/GroupEvent.md +29 -0
- package/docs/enums/OrganizationsEvent.md +31 -0
- package/docs/enums/UserEvent.md +15 -0
- package/docs/enums/WorkspaceEvent.md +17 -0
- package/docs/enums/WorkspacesEvent.md +24 -0
- package/docs/interfaces/Disposable.md +25 -0
- package/docs/interfaces/Event.md +58 -0
- package/docs/interfaces/EventSubscriber.md +41 -0
- package/docs/interfaces/Input.md +35 -0
- package/docs/modules.md +205 -0
- package/package.json +4 -2
- package/scripts/docs/index.js +15 -0
@@ -0,0 +1,109 @@
|
|
1
|
+
[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / EventDispatcher
|
2
|
+
|
3
|
+
# Class: EventDispatcher\<EventType, DataType\>
|
4
|
+
|
5
|
+
## Type parameters
|
6
|
+
|
7
|
+
| Name |
|
8
|
+
| :------ |
|
9
|
+
| `EventType` |
|
10
|
+
| `DataType` |
|
11
|
+
|
12
|
+
## Hierarchy
|
13
|
+
|
14
|
+
- **`EventDispatcher`**
|
15
|
+
|
16
|
+
↳ [`Organizations`](Organizations.md)
|
17
|
+
|
18
|
+
↳ [`Workspaces`](Workspaces.md)
|
19
|
+
|
20
|
+
↳ [`Workspace`](Workspace.md)
|
21
|
+
|
22
|
+
↳ [`Group`](Group.md)
|
23
|
+
|
24
|
+
↳ [`Groups`](Groups.md)
|
25
|
+
|
26
|
+
↳ [`UserProfile`](UserProfile.md)
|
27
|
+
|
28
|
+
↳ [`Files`](Files.md)
|
29
|
+
|
30
|
+
↳ [`Chats`](Chats.md)
|
31
|
+
|
32
|
+
## Implements
|
33
|
+
|
34
|
+
- [`EventSubscriber`](../interfaces/EventSubscriber.md)\<`EventType`, `DataType`\>
|
35
|
+
|
36
|
+
## Table of contents
|
37
|
+
|
38
|
+
### Constructors
|
39
|
+
|
40
|
+
- [constructor](EventDispatcher.md#constructor)
|
41
|
+
|
42
|
+
### Properties
|
43
|
+
|
44
|
+
- [\_listeners](EventDispatcher.md#_listeners)
|
45
|
+
|
46
|
+
### Methods
|
47
|
+
|
48
|
+
- [dispatch](EventDispatcher.md#dispatch)
|
49
|
+
- [subscribe](EventDispatcher.md#subscribe)
|
50
|
+
|
51
|
+
## Constructors
|
52
|
+
|
53
|
+
### constructor
|
54
|
+
|
55
|
+
• **new EventDispatcher**\<`EventType`, `DataType`\>(): [`EventDispatcher`](EventDispatcher.md)\<`EventType`, `DataType`\>
|
56
|
+
|
57
|
+
#### Type parameters
|
58
|
+
|
59
|
+
| Name |
|
60
|
+
| :------ |
|
61
|
+
| `EventType` |
|
62
|
+
| `DataType` |
|
63
|
+
|
64
|
+
#### Returns
|
65
|
+
|
66
|
+
[`EventDispatcher`](EventDispatcher.md)\<`EventType`, `DataType`\>
|
67
|
+
|
68
|
+
## Properties
|
69
|
+
|
70
|
+
### \_listeners
|
71
|
+
|
72
|
+
• `Private` **\_listeners**: \{ `callback`: (`value`: [`Event`](../interfaces/Event.md)\<`EventType`, `DataType`\>) => `void` ; `disposable`: [`Disposable`](../interfaces/Disposable.md) }[] = `[]`
|
73
|
+
|
74
|
+
## Methods
|
75
|
+
|
76
|
+
### dispatch
|
77
|
+
|
78
|
+
▸ **dispatch**(`input`): `void`
|
79
|
+
|
80
|
+
#### Parameters
|
81
|
+
|
82
|
+
| Name | Type |
|
83
|
+
| :------ | :------ |
|
84
|
+
| `input` | [`Input`](../interfaces/Input.md)\<`EventType`, `DataType`\> |
|
85
|
+
|
86
|
+
#### Returns
|
87
|
+
|
88
|
+
`void`
|
89
|
+
|
90
|
+
___
|
91
|
+
|
92
|
+
### subscribe
|
93
|
+
|
94
|
+
▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
|
95
|
+
|
96
|
+
#### Parameters
|
97
|
+
|
98
|
+
| Name | Type |
|
99
|
+
| :------ | :------ |
|
100
|
+
| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<`EventType`, `DataType`\>) => `void` |
|
101
|
+
| `type?` | `EventType` |
|
102
|
+
|
103
|
+
#### Returns
|
104
|
+
|
105
|
+
[`Disposable`](../interfaces/Disposable.md)
|
106
|
+
|
107
|
+
#### Implementation of
|
108
|
+
|
109
|
+
[EventSubscriber](../interfaces/EventSubscriber.md).[subscribe](../interfaces/EventSubscriber.md#subscribe)
|
@@ -0,0 +1,79 @@
|
|
1
|
+
[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / File
|
2
|
+
|
3
|
+
# Class: File
|
4
|
+
|
5
|
+
File.
|
6
|
+
|
7
|
+
## Table of contents
|
8
|
+
|
9
|
+
### Constructors
|
10
|
+
|
11
|
+
- [constructor](File.md#constructor)
|
12
|
+
|
13
|
+
### Accessors
|
14
|
+
|
15
|
+
- [id](File.md#id)
|
16
|
+
- [name](File.md#name)
|
17
|
+
|
18
|
+
### Methods
|
19
|
+
|
20
|
+
- [status](File.md#status)
|
21
|
+
- [url](File.md#url)
|
22
|
+
|
23
|
+
## Constructors
|
24
|
+
|
25
|
+
### constructor
|
26
|
+
|
27
|
+
• **new File**(): [`File`](File.md)
|
28
|
+
|
29
|
+
#### Returns
|
30
|
+
|
31
|
+
[`File`](File.md)
|
32
|
+
|
33
|
+
## Accessors
|
34
|
+
|
35
|
+
### id
|
36
|
+
|
37
|
+
• `get` **id**(): `string`
|
38
|
+
|
39
|
+
File id.
|
40
|
+
|
41
|
+
#### Returns
|
42
|
+
|
43
|
+
`string`
|
44
|
+
|
45
|
+
___
|
46
|
+
|
47
|
+
### name
|
48
|
+
|
49
|
+
• `get` **name**(): `string`
|
50
|
+
|
51
|
+
File name.
|
52
|
+
|
53
|
+
#### Returns
|
54
|
+
|
55
|
+
`string`
|
56
|
+
|
57
|
+
## Methods
|
58
|
+
|
59
|
+
### status
|
60
|
+
|
61
|
+
▸ **status**(): `Promise`\<`FileProgressDto`\>
|
62
|
+
|
63
|
+
Get file status.
|
64
|
+
|
65
|
+
#### Returns
|
66
|
+
|
67
|
+
`Promise`\<`FileProgressDto`\>
|
68
|
+
|
69
|
+
___
|
70
|
+
|
71
|
+
### url
|
72
|
+
|
73
|
+
▸ **url**(): `Promise`\<`string`\>
|
74
|
+
|
75
|
+
Get temporary url.
|
76
|
+
|
77
|
+
#### Returns
|
78
|
+
|
79
|
+
`Promise`\<`string`\>
|
@@ -0,0 +1,136 @@
|
|
1
|
+
[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Files
|
2
|
+
|
3
|
+
# Class: Files
|
4
|
+
|
5
|
+
Files storage.
|
6
|
+
|
7
|
+
## Hierarchy
|
8
|
+
|
9
|
+
- [`EventDispatcher`](EventDispatcher.md)\<[`FilesEvent`](../enums/FilesEvent.md), [`File`](File.md)\>
|
10
|
+
|
11
|
+
↳ **`Files`**
|
12
|
+
|
13
|
+
## Table of contents
|
14
|
+
|
15
|
+
### Constructors
|
16
|
+
|
17
|
+
- [constructor](Files.md#constructor)
|
18
|
+
|
19
|
+
### Methods
|
20
|
+
|
21
|
+
- [delete](Files.md#delete)
|
22
|
+
- [dispatch](Files.md#dispatch)
|
23
|
+
- [query](Files.md#query)
|
24
|
+
- [subscribe](Files.md#subscribe)
|
25
|
+
- [upload](Files.md#upload)
|
26
|
+
|
27
|
+
## Constructors
|
28
|
+
|
29
|
+
### constructor
|
30
|
+
|
31
|
+
• **new Files**(): [`Files`](Files.md)
|
32
|
+
|
33
|
+
#### Returns
|
34
|
+
|
35
|
+
[`Files`](Files.md)
|
36
|
+
|
37
|
+
#### Inherited from
|
38
|
+
|
39
|
+
[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
|
40
|
+
|
41
|
+
## Methods
|
42
|
+
|
43
|
+
### delete
|
44
|
+
|
45
|
+
▸ **delete**(`id`): `Promise`\<`void`\>
|
46
|
+
|
47
|
+
Delete file.
|
48
|
+
|
49
|
+
#### Parameters
|
50
|
+
|
51
|
+
| Name | Type |
|
52
|
+
| :------ | :------ |
|
53
|
+
| `id` | `string` |
|
54
|
+
|
55
|
+
#### Returns
|
56
|
+
|
57
|
+
`Promise`\<`void`\>
|
58
|
+
|
59
|
+
___
|
60
|
+
|
61
|
+
### dispatch
|
62
|
+
|
63
|
+
▸ **dispatch**(`input`): `void`
|
64
|
+
|
65
|
+
#### Parameters
|
66
|
+
|
67
|
+
| Name | Type |
|
68
|
+
| :------ | :------ |
|
69
|
+
| `input` | [`Input`](../interfaces/Input.md)\<[`FilesEvent`](../enums/FilesEvent.md), [`File`](File.md)\> |
|
70
|
+
|
71
|
+
#### Returns
|
72
|
+
|
73
|
+
`void`
|
74
|
+
|
75
|
+
#### Inherited from
|
76
|
+
|
77
|
+
[EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
|
78
|
+
|
79
|
+
___
|
80
|
+
|
81
|
+
### query
|
82
|
+
|
83
|
+
▸ **query**(`query`, `page`, `limit`): `Promise`\<[`FilesPage`](FilesPage.md)\>
|
84
|
+
|
85
|
+
Query files.
|
86
|
+
|
87
|
+
#### Parameters
|
88
|
+
|
89
|
+
| Name | Type |
|
90
|
+
| :------ | :------ |
|
91
|
+
| `query` | `string` |
|
92
|
+
| `page` | `number` |
|
93
|
+
| `limit` | `number` |
|
94
|
+
|
95
|
+
#### Returns
|
96
|
+
|
97
|
+
`Promise`\<[`FilesPage`](FilesPage.md)\>
|
98
|
+
|
99
|
+
___
|
100
|
+
|
101
|
+
### subscribe
|
102
|
+
|
103
|
+
▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
|
104
|
+
|
105
|
+
#### Parameters
|
106
|
+
|
107
|
+
| Name | Type |
|
108
|
+
| :------ | :------ |
|
109
|
+
| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`FilesEvent`](../enums/FilesEvent.md), [`File`](File.md)\>) => `void` |
|
110
|
+
| `type?` | [`FilesEvent`](../enums/FilesEvent.md) |
|
111
|
+
|
112
|
+
#### Returns
|
113
|
+
|
114
|
+
[`Disposable`](../interfaces/Disposable.md)
|
115
|
+
|
116
|
+
#### Inherited from
|
117
|
+
|
118
|
+
[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
|
119
|
+
|
120
|
+
___
|
121
|
+
|
122
|
+
### upload
|
123
|
+
|
124
|
+
▸ **upload**(`file`): `Promise`\<[`File`](File.md)\>
|
125
|
+
|
126
|
+
Get file by id.
|
127
|
+
|
128
|
+
#### Parameters
|
129
|
+
|
130
|
+
| Name | Type |
|
131
|
+
| :------ | :------ |
|
132
|
+
| `file` | `File` |
|
133
|
+
|
134
|
+
#### Returns
|
135
|
+
|
136
|
+
`Promise`\<[`File`](File.md)\>
|
@@ -0,0 +1,76 @@
|
|
1
|
+
[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / FilesPage
|
2
|
+
|
3
|
+
# Class: FilesPage
|
4
|
+
|
5
|
+
Files page.
|
6
|
+
|
7
|
+
## Table of contents
|
8
|
+
|
9
|
+
### Constructors
|
10
|
+
|
11
|
+
- [constructor](FilesPage.md#constructor)
|
12
|
+
|
13
|
+
### Accessors
|
14
|
+
|
15
|
+
- [files](FilesPage.md#files)
|
16
|
+
- [page](FilesPage.md#page)
|
17
|
+
- [pages](FilesPage.md#pages)
|
18
|
+
- [total](FilesPage.md#total)
|
19
|
+
|
20
|
+
## Constructors
|
21
|
+
|
22
|
+
### constructor
|
23
|
+
|
24
|
+
• **new FilesPage**(): [`FilesPage`](FilesPage.md)
|
25
|
+
|
26
|
+
#### Returns
|
27
|
+
|
28
|
+
[`FilesPage`](FilesPage.md)
|
29
|
+
|
30
|
+
## Accessors
|
31
|
+
|
32
|
+
### files
|
33
|
+
|
34
|
+
• `get` **files**(): [`File`](File.md)[]
|
35
|
+
|
36
|
+
Get files.
|
37
|
+
|
38
|
+
#### Returns
|
39
|
+
|
40
|
+
[`File`](File.md)[]
|
41
|
+
|
42
|
+
___
|
43
|
+
|
44
|
+
### page
|
45
|
+
|
46
|
+
• `get` **page**(): `number`
|
47
|
+
|
48
|
+
Get current page.
|
49
|
+
|
50
|
+
#### Returns
|
51
|
+
|
52
|
+
`number`
|
53
|
+
|
54
|
+
___
|
55
|
+
|
56
|
+
### pages
|
57
|
+
|
58
|
+
• `get` **pages**(): `number`
|
59
|
+
|
60
|
+
Get pages count.
|
61
|
+
|
62
|
+
#### Returns
|
63
|
+
|
64
|
+
`number`
|
65
|
+
|
66
|
+
___
|
67
|
+
|
68
|
+
### total
|
69
|
+
|
70
|
+
• `get` **total**(): `number`
|
71
|
+
|
72
|
+
Get total count.
|
73
|
+
|
74
|
+
#### Returns
|
75
|
+
|
76
|
+
`number`
|
@@ -0,0 +1,191 @@
|
|
1
|
+
[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Group
|
2
|
+
|
3
|
+
# Class: Group
|
4
|
+
|
5
|
+
## Hierarchy
|
6
|
+
|
7
|
+
- [`EventDispatcher`](EventDispatcher.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>
|
8
|
+
|
9
|
+
↳ **`Group`**
|
10
|
+
|
11
|
+
## Table of contents
|
12
|
+
|
13
|
+
### Constructors
|
14
|
+
|
15
|
+
- [constructor](Group.md#constructor)
|
16
|
+
|
17
|
+
### Accessors
|
18
|
+
|
19
|
+
- [group](Group.md#group)
|
20
|
+
- [id](Group.md#id)
|
21
|
+
- [members](Group.md#members)
|
22
|
+
|
23
|
+
### Methods
|
24
|
+
|
25
|
+
- [dispatch](Group.md#dispatch)
|
26
|
+
- [getWorkspaces](Group.md#getworkspaces)
|
27
|
+
- [setMembersIds](Group.md#setmembersids)
|
28
|
+
- [setName](Group.md#setname)
|
29
|
+
- [setPermits](Group.md#setpermits)
|
30
|
+
- [setWorkspaces](Group.md#setworkspaces)
|
31
|
+
- [subscribe](Group.md#subscribe)
|
32
|
+
|
33
|
+
## Constructors
|
34
|
+
|
35
|
+
### constructor
|
36
|
+
|
37
|
+
• **new Group**(): [`Group`](Group.md)
|
38
|
+
|
39
|
+
#### Returns
|
40
|
+
|
41
|
+
[`Group`](Group.md)
|
42
|
+
|
43
|
+
#### Inherited from
|
44
|
+
|
45
|
+
[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
|
46
|
+
|
47
|
+
## Accessors
|
48
|
+
|
49
|
+
### group
|
50
|
+
|
51
|
+
• `get` **group**(): `AccessGroupDto`
|
52
|
+
|
53
|
+
#### Returns
|
54
|
+
|
55
|
+
`AccessGroupDto`
|
56
|
+
|
57
|
+
___
|
58
|
+
|
59
|
+
### id
|
60
|
+
|
61
|
+
• `get` **id**(): `string`
|
62
|
+
|
63
|
+
#### Returns
|
64
|
+
|
65
|
+
`string`
|
66
|
+
|
67
|
+
___
|
68
|
+
|
69
|
+
### members
|
70
|
+
|
71
|
+
• `get` **members**(): `UserDto`[]
|
72
|
+
|
73
|
+
#### Returns
|
74
|
+
|
75
|
+
`UserDto`[]
|
76
|
+
|
77
|
+
## Methods
|
78
|
+
|
79
|
+
### dispatch
|
80
|
+
|
81
|
+
▸ **dispatch**(`input`): `void`
|
82
|
+
|
83
|
+
#### Parameters
|
84
|
+
|
85
|
+
| Name | Type |
|
86
|
+
| :------ | :------ |
|
87
|
+
| `input` | [`Input`](../interfaces/Input.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\> |
|
88
|
+
|
89
|
+
#### Returns
|
90
|
+
|
91
|
+
`void`
|
92
|
+
|
93
|
+
#### Inherited from
|
94
|
+
|
95
|
+
[EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
|
96
|
+
|
97
|
+
___
|
98
|
+
|
99
|
+
### getWorkspaces
|
100
|
+
|
101
|
+
▸ **getWorkspaces**(): `Promise`\<`WorkspaceDto`[]\>
|
102
|
+
|
103
|
+
#### Returns
|
104
|
+
|
105
|
+
`Promise`\<`WorkspaceDto`[]\>
|
106
|
+
|
107
|
+
___
|
108
|
+
|
109
|
+
### setMembersIds
|
110
|
+
|
111
|
+
▸ **setMembersIds**(`members`): `Promise`\<`void`\>
|
112
|
+
|
113
|
+
#### Parameters
|
114
|
+
|
115
|
+
| Name | Type |
|
116
|
+
| :------ | :------ |
|
117
|
+
| `members` | `string`[] |
|
118
|
+
|
119
|
+
#### Returns
|
120
|
+
|
121
|
+
`Promise`\<`void`\>
|
122
|
+
|
123
|
+
___
|
124
|
+
|
125
|
+
### setName
|
126
|
+
|
127
|
+
▸ **setName**(`name`): `Promise`\<`void`\>
|
128
|
+
|
129
|
+
#### Parameters
|
130
|
+
|
131
|
+
| Name | Type |
|
132
|
+
| :------ | :------ |
|
133
|
+
| `name` | `string` |
|
134
|
+
|
135
|
+
#### Returns
|
136
|
+
|
137
|
+
`Promise`\<`void`\>
|
138
|
+
|
139
|
+
___
|
140
|
+
|
141
|
+
### setPermits
|
142
|
+
|
143
|
+
▸ **setPermits**(`permits`): `Promise`\<`void`\>
|
144
|
+
|
145
|
+
#### Parameters
|
146
|
+
|
147
|
+
| Name | Type |
|
148
|
+
| :------ | :------ |
|
149
|
+
| `permits` | `Object` |
|
150
|
+
| `permits.isAdmin` | `boolean` |
|
151
|
+
|
152
|
+
#### Returns
|
153
|
+
|
154
|
+
`Promise`\<`void`\>
|
155
|
+
|
156
|
+
___
|
157
|
+
|
158
|
+
### setWorkspaces
|
159
|
+
|
160
|
+
▸ **setWorkspaces**(`workspaces`): `Promise`\<`void`\>
|
161
|
+
|
162
|
+
#### Parameters
|
163
|
+
|
164
|
+
| Name | Type |
|
165
|
+
| :------ | :------ |
|
166
|
+
| `workspaces` | `string`[] |
|
167
|
+
|
168
|
+
#### Returns
|
169
|
+
|
170
|
+
`Promise`\<`void`\>
|
171
|
+
|
172
|
+
___
|
173
|
+
|
174
|
+
### subscribe
|
175
|
+
|
176
|
+
▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
|
177
|
+
|
178
|
+
#### Parameters
|
179
|
+
|
180
|
+
| Name | Type |
|
181
|
+
| :------ | :------ |
|
182
|
+
| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>) => `void` |
|
183
|
+
| `type?` | [`GroupEvent`](../enums/GroupEvent.md) |
|
184
|
+
|
185
|
+
#### Returns
|
186
|
+
|
187
|
+
[`Disposable`](../interfaces/Disposable.md)
|
188
|
+
|
189
|
+
#### Inherited from
|
190
|
+
|
191
|
+
[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
|
@@ -0,0 +1,130 @@
|
|
1
|
+
[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Groups
|
2
|
+
|
3
|
+
# Class: Groups
|
4
|
+
|
5
|
+
## Hierarchy
|
6
|
+
|
7
|
+
- [`EventDispatcher`](EventDispatcher.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>
|
8
|
+
|
9
|
+
↳ **`Groups`**
|
10
|
+
|
11
|
+
## Table of contents
|
12
|
+
|
13
|
+
### Constructors
|
14
|
+
|
15
|
+
- [constructor](Groups.md#constructor)
|
16
|
+
|
17
|
+
### Methods
|
18
|
+
|
19
|
+
- [create](Groups.md#create)
|
20
|
+
- [delete](Groups.md#delete)
|
21
|
+
- [dispatch](Groups.md#dispatch)
|
22
|
+
- [get](Groups.md#get)
|
23
|
+
- [subscribe](Groups.md#subscribe)
|
24
|
+
|
25
|
+
## Constructors
|
26
|
+
|
27
|
+
### constructor
|
28
|
+
|
29
|
+
• **new Groups**(): [`Groups`](Groups.md)
|
30
|
+
|
31
|
+
#### Returns
|
32
|
+
|
33
|
+
[`Groups`](Groups.md)
|
34
|
+
|
35
|
+
#### Inherited from
|
36
|
+
|
37
|
+
[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
|
38
|
+
|
39
|
+
## Methods
|
40
|
+
|
41
|
+
### create
|
42
|
+
|
43
|
+
▸ **create**(`name`, `organizationId`, `permits`, `memberIds`): `Promise`\<[`Group`](Group.md)\>
|
44
|
+
|
45
|
+
#### Parameters
|
46
|
+
|
47
|
+
| Name | Type |
|
48
|
+
| :------ | :------ |
|
49
|
+
| `name` | `string` |
|
50
|
+
| `organizationId` | `string` |
|
51
|
+
| `permits` | `Object` |
|
52
|
+
| `permits.isAdmin` | `boolean` |
|
53
|
+
| `memberIds` | `string`[] |
|
54
|
+
|
55
|
+
#### Returns
|
56
|
+
|
57
|
+
`Promise`\<[`Group`](Group.md)\>
|
58
|
+
|
59
|
+
___
|
60
|
+
|
61
|
+
### delete
|
62
|
+
|
63
|
+
▸ **delete**(`id`): `Promise`\<`void`\>
|
64
|
+
|
65
|
+
#### Parameters
|
66
|
+
|
67
|
+
| Name | Type |
|
68
|
+
| :------ | :------ |
|
69
|
+
| `id` | `string` |
|
70
|
+
|
71
|
+
#### Returns
|
72
|
+
|
73
|
+
`Promise`\<`void`\>
|
74
|
+
|
75
|
+
___
|
76
|
+
|
77
|
+
### dispatch
|
78
|
+
|
79
|
+
▸ **dispatch**(`input`): `void`
|
80
|
+
|
81
|
+
#### Parameters
|
82
|
+
|
83
|
+
| Name | Type |
|
84
|
+
| :------ | :------ |
|
85
|
+
| `input` | [`Input`](../interfaces/Input.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\> |
|
86
|
+
|
87
|
+
#### Returns
|
88
|
+
|
89
|
+
`void`
|
90
|
+
|
91
|
+
#### Inherited from
|
92
|
+
|
93
|
+
[EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
|
94
|
+
|
95
|
+
___
|
96
|
+
|
97
|
+
### get
|
98
|
+
|
99
|
+
▸ **get**(`id`): `Promise`\<`undefined` \| [`Group`](Group.md)\>
|
100
|
+
|
101
|
+
#### Parameters
|
102
|
+
|
103
|
+
| Name | Type |
|
104
|
+
| :------ | :------ |
|
105
|
+
| `id` | `string` |
|
106
|
+
|
107
|
+
#### Returns
|
108
|
+
|
109
|
+
`Promise`\<`undefined` \| [`Group`](Group.md)\>
|
110
|
+
|
111
|
+
___
|
112
|
+
|
113
|
+
### subscribe
|
114
|
+
|
115
|
+
▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
|
116
|
+
|
117
|
+
#### Parameters
|
118
|
+
|
119
|
+
| Name | Type |
|
120
|
+
| :------ | :------ |
|
121
|
+
| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>) => `void` |
|
122
|
+
| `type?` | [`GroupEvent`](../enums/GroupEvent.md) |
|
123
|
+
|
124
|
+
#### Returns
|
125
|
+
|
126
|
+
[`Disposable`](../interfaces/Disposable.md)
|
127
|
+
|
128
|
+
#### Inherited from
|
129
|
+
|
130
|
+
[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
|